Eclipse SUMO - Simulation of Urban MObility
MSLaneSpeedTrigger.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
18 // Changes the speed allowed on a set of lanes
19 /****************************************************************************/
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 #include <string>
32 #include <utils/xml/XMLSubSys.h>
35 #include <microsim/MSLane.h>
36 #include <microsim/MSNet.h>
37 #include <microsim/MSEdge.h>
38 #include "MSLaneSpeedTrigger.h"
39 
40 #include <microsim/MSGlobals.h>
41 #include <mesosim/MELoop.h>
42 #include <mesosim/MESegment.h>
43 
44 
45 // ===========================================================================
46 // method definitions
47 // ===========================================================================
49  const std::vector<MSLane*>& destLanes,
50  const std::string& file) :
51  MSTrigger(id),
52  SUMOSAXHandler(file),
53  myDestLanes(destLanes),
54  myCurrentSpeed(destLanes[0]->getSpeedLimit()),
55  myDefaultSpeed(destLanes[0]->getSpeedLimit()),
56  myAmOverriding(false),
57  mySpeedOverrideValue(destLanes[0]->getSpeedLimit()),
58  myDidInit(false) {
59  if (file != "") {
60  if (!XMLSubSys::runParser(*this, file)) {
61  throw ProcessError();
62  }
63  if (!myDidInit) {
64  init();
65  }
66  }
67 }
68 
69 void
71  // set it to the right value
72  // assert there is at least one
73  if (myLoadedSpeeds.size() == 0) {
74  myLoadedSpeeds.push_back(std::make_pair(100000, myCurrentSpeed));
75  }
76  // set the process to the begin
78  // pass previous time steps
80  while ((*myCurrentEntry).first < now && myCurrentEntry != myLoadedSpeeds.end()) {
81  processCommand(true, now);
82  }
83 
84  // add the processing to the event handler
87  (*myCurrentEntry).first);
88  myDidInit = true;
89 }
90 
91 
93 
94 
97  return processCommand(true, currentTime);
98 }
99 
100 
101 SUMOTime
102 MSLaneSpeedTrigger::processCommand(bool move2next, SUMOTime currentTime) {
103  UNUSED_PARAMETER(currentTime);
104  std::vector<MSLane*>::iterator i;
105  const double speed = getCurrentSpeed();
107  if (myDestLanes.size() > 0 && myDestLanes.front()->getSpeedLimit() != speed) {
108  myDestLanes.front()->getEdge().setMaxSpeed(speed);
109  MESegment* first = MSGlobals::gMesoNet->getSegmentForEdge(myDestLanes.front()->getEdge());
110  while (first != nullptr) {
111  first->setSpeed(speed, currentTime, -1);
112  first = first->getNextSegment();
113  }
114  }
115  } else {
116  for (i = myDestLanes.begin(); i != myDestLanes.end(); ++i) {
117  (*i)->setMaxSpeed(speed);
118  }
119  }
120  if (!move2next) {
121  // changed from the gui
122  return 0;
123  }
124  if (myCurrentEntry != myLoadedSpeeds.end()) {
125  ++myCurrentEntry;
126  }
127  if (myCurrentEntry != myLoadedSpeeds.end()) {
128  return ((*myCurrentEntry).first) - ((*(myCurrentEntry - 1)).first);
129  } else {
130  return 0;
131  }
132 }
133 
134 
135 void
137  const SUMOSAXAttributes& attrs) {
138  // check whether the correct tag is read
139  if (element != SUMO_TAG_STEP) {
140  return;
141  }
142  // extract the values
143  bool ok = true;
144  SUMOTime next = attrs.getSUMOTimeReporting(SUMO_ATTR_TIME, getID().c_str(), ok);
145  double speed = attrs.getOpt<double>(SUMO_ATTR_SPEED, getID().c_str(), ok, -1);
146  // check the values
147  if (next < 0) {
148  WRITE_ERROR("Wrong time in vss '" + getID() + "'.");
149  return;
150  }
151  if (speed < 0) {
152  speed = myDefaultSpeed;
153  }
154  // set the values for the next step if they are valid
155  if (myLoadedSpeeds.size() != 0 && myLoadedSpeeds.back().first == next) {
156  WRITE_WARNING("Time " + time2string(next) + " was set twice for vss '" + getID() + "'; replacing first entry.");
157  myLoadedSpeeds.back().second = speed;
158  } else {
159  myLoadedSpeeds.push_back(std::make_pair(next, speed));
160  }
161 }
162 
163 
164 void
166  if (element == SUMO_TAG_VSS && !myDidInit) {
167  init();
168  }
169 }
170 
171 
172 double
174  return myDefaultSpeed;
175 }
176 
177 
178 void
180  myAmOverriding = val;
181  processCommand(false, MSNet::getInstance()->getCurrentTimeStep());
182 }
183 
184 
185 void
187  mySpeedOverrideValue = val;
188  processCommand(false, MSNet::getInstance()->getCurrentTimeStep());
189 }
190 
191 
192 double
194  if (myCurrentEntry != myLoadedSpeeds.begin()) {
195  return (*(myCurrentEntry - 1)).second;
196  } else {
197  return (*myCurrentEntry).second;
198  }
199 }
200 
201 
202 double
204  if (myAmOverriding) {
205  return mySpeedOverrideValue;
206  } else {
208  // ok, maybe the first shall not yet be the valid one
209  if (myCurrentEntry == myLoadedSpeeds.begin() && (*myCurrentEntry).first > now) {
210  return myDefaultSpeed;
211  }
212  // try the loaded
213  if (myCurrentEntry != myLoadedSpeeds.end() && (*myCurrentEntry).first <= now) {
214  return (*myCurrentEntry).second;
215  } else {
216  // we have run past the end of the loaded steps or the current step is not yet active:
217  // -> use the value of the previous step
218  return (*(myCurrentEntry - 1)).second;
219  }
220  }
221 }
222 
223 
224 /****************************************************************************/
225 
UNUSED_PARAMETER
#define UNUSED_PARAMETER(x)
Definition: StdDefs.h:31
XMLSubSys::runParser
static bool runParser(GenericSAXHandler &handler, const std::string &file, const bool isNet=false)
Runs the given handler on the given file; returns if everything's ok.
Definition: XMLSubSys.cpp:112
MSLaneSpeedTrigger::setOverridingValue
void setOverridingValue(double val)
Definition: MSLaneSpeedTrigger.cpp:186
MSLaneSpeedTrigger::mySpeedOverrideValue
double mySpeedOverrideValue
The speed to use if overriding the read speed.
Definition: MSLaneSpeedTrigger.h:132
MSLaneSpeedTrigger::myCurrentEntry
std::vector< std::pair< SUMOTime, double > >::iterator myCurrentEntry
Definition: MSLaneSpeedTrigger.h:135
MSEventControl::addEvent
virtual void addEvent(Command *operation, SUMOTime execTimeStep=-1)
Adds an Event.
Definition: MSEventControl.cpp:52
MSLaneSpeedTrigger::myCurrentSpeed
double myCurrentSpeed
Definition: MSLaneSpeedTrigger.h:123
WRITE_WARNING
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:275
MSLaneSpeedTrigger.h
MSNet.h
SUMOSAXHandler
SAX-handler base for SUMO-files.
Definition: SUMOSAXHandler.h:41
MESegment
A single mesoscopic segment (cell)
Definition: MESegment.h:49
MSNet::getBeginOfTimestepEvents
MSEventControl * getBeginOfTimestepEvents()
Returns the event control for events executed at the begin of a time step.
Definition: MSNet.h:429
MsgHandler.h
MSLaneSpeedTrigger::myDefaultSpeed
double myDefaultSpeed
The original speed allowed on the lanes.
Definition: MSLaneSpeedTrigger.h:126
WrappingCommand.h
MSLaneSpeedTrigger::execute
SUMOTime execute(SUMOTime currentTime)
Executes a switch command.
Definition: MSLaneSpeedTrigger.cpp:96
SUMOTime
long long int SUMOTime
Definition: SUMOTime.h:34
WrappingCommand
A wrapper for a Command function.
Definition: WrappingCommand.h:51
MSGlobals::gUseMesoSim
static bool gUseMesoSim
Definition: MSGlobals.h:90
SUMO_ATTR_SPEED
Definition: SUMOXMLDefinitions.h:384
MSEdge.h
SUMOSAXAttributes::getSUMOTimeReporting
SUMOTime getSUMOTimeReporting(int attr, const char *objectid, bool &ok, bool report=true) const
Tries to read given attribute assuming it is a SUMOTime.
Definition: SUMOSAXAttributes.cpp:63
MSLaneSpeedTrigger::getLoadedSpeed
double getLoadedSpeed()
Definition: MSLaneSpeedTrigger.cpp:193
MSLaneSpeedTrigger::init
void init()
Definition: MSLaneSpeedTrigger.cpp:70
MESegment.h
MSLaneSpeedTrigger::myStartElement
virtual void myStartElement(int element, const SUMOSAXAttributes &attrs)
Called on the opening of a tag;.
Definition: MSLaneSpeedTrigger.cpp:136
MSLaneSpeedTrigger::myLoadedSpeeds
std::vector< std::pair< SUMOTime, double > > myLoadedSpeeds
Definition: MSLaneSpeedTrigger.h:134
SUMO_TAG_VSS
A variable speed sign.
Definition: SUMOXMLDefinitions.h:89
MSNet::getCurrentTimeStep
SUMOTime getCurrentTimeStep() const
Returns the current simulation step.
Definition: MSNet.h:283
MELoop::getSegmentForEdge
MESegment * getSegmentForEdge(const MSEdge &e, double pos=0)
Get the segment for a given edge at a given position.
Definition: MELoop.cpp:292
ProcessError
Definition: UtilExceptions.h:39
SUMO_TAG_STEP
trigger: a step description
Definition: SUMOXMLDefinitions.h:157
time2string
std::string time2string(SUMOTime t)
Definition: SUMOTime.cpp:67
MSGlobals.h
UtilExceptions.h
MESegment::getNextSegment
MESegment * getNextSegment() const
Returns the following segment on the same edge (0 if it is the last).
Definition: MESegment.h:151
SUMOSAXAttributes::getOpt
T getOpt(int attr, const char *objectid, bool &ok, T defaultValue, bool report=true) const
Tries to read given attribute assuming it is an int.
Definition: SUMOSAXAttributes.h:518
SUMO_ATTR_TIME
trigger: the time of the step
Definition: SUMOXMLDefinitions.h:676
MSLaneSpeedTrigger::processCommand
SUMOTime processCommand(bool move2next, SUMOTime currentTime)
Definition: MSLaneSpeedTrigger.cpp:102
MSTrigger
An abstract device that changes the state of the micro simulation.
Definition: MSTrigger.h:40
MSLaneSpeedTrigger::~MSLaneSpeedTrigger
virtual ~MSLaneSpeedTrigger()
Destructor.
Definition: MSLaneSpeedTrigger.cpp:92
StringUtils.h
MSNet::getInstance
static MSNet * getInstance()
Returns the pointer to the unique instance of MSNet (singleton).
Definition: MSNet.cpp:167
MSGlobals::gMesoNet
static MELoop * gMesoNet
mesoscopic simulation infrastructure
Definition: MSGlobals.h:105
MSLaneSpeedTrigger::myAmOverriding
bool myAmOverriding
The information whether the read speed shall be overridden.
Definition: MSLaneSpeedTrigger.h:129
MSLaneSpeedTrigger::setOverriding
void setOverriding(bool val)
Definition: MSLaneSpeedTrigger.cpp:179
MSLaneSpeedTrigger::myDidInit
bool myDidInit
The information whether init was called.
Definition: MSLaneSpeedTrigger.h:149
config.h
MSLaneSpeedTrigger::MSLaneSpeedTrigger
MSLaneSpeedTrigger(const std::string &id, const std::vector< MSLane * > &destLanes, const std::string &file)
Constructor.
Definition: MSLaneSpeedTrigger.cpp:48
MELoop.h
MSLaneSpeedTrigger::getDefaultSpeed
double getDefaultSpeed() const
Definition: MSLaneSpeedTrigger.cpp:173
MSEventControl.h
MSLane.h
MESegment::setSpeed
void setSpeed(double newSpeed, SUMOTime currentTime, double jamThresh=DO_NOT_PATCH_JAM_THRESHOLD)
reset mySpeed and patch the speed of all vehicles in it. Also set/recompute myJamThreshold
Definition: MESegment.cpp:621
MSLaneSpeedTrigger::myEndElement
virtual void myEndElement(int element)
Called on the closing of a tag;.
Definition: MSLaneSpeedTrigger.cpp:165
SUMOSAXAttributes
Encapsulated SAX-Attributes.
Definition: SUMOSAXAttributes.h:56
Named::getID
const std::string & getID() const
Returns the id.
Definition: Named.h:76
WRITE_ERROR
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:283
SUMOXMLDefinitions.h
MSLaneSpeedTrigger::getCurrentSpeed
double getCurrentSpeed() const
Returns the current speed.
Definition: MSLaneSpeedTrigger.cpp:203
MSLaneSpeedTrigger::myDestLanes
std::vector< MSLane * > myDestLanes
Definition: MSLaneSpeedTrigger.h:120
XMLSubSys.h