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 /****************************************************************************/
19 // Changes the speed allowed on a set of lanes
20 /****************************************************************************/
21 
22 
23 // ===========================================================================
24 // included modules
25 // ===========================================================================
26 #include <config.h>
27 
28 #include <string>
33 #include <utils/xml/XMLSubSys.h>
36 #include <microsim/MSLane.h>
37 #include <microsim/MSNet.h>
38 #include <microsim/MSEdge.h>
39 #include "MSLaneSpeedTrigger.h"
40 
41 #include <microsim/MSGlobals.h>
42 #include <mesosim/MELoop.h>
43 #include <mesosim/MESegment.h>
44 
45 
46 // ===========================================================================
47 // method definitions
48 // ===========================================================================
50  const std::vector<MSLane*>& destLanes,
51  const std::string& file) :
52  MSTrigger(id),
53  SUMOSAXHandler(file),
54  myDestLanes(destLanes),
55  myCurrentSpeed(destLanes[0]->getSpeedLimit()),
56  myDefaultSpeed(destLanes[0]->getSpeedLimit()),
57  myAmOverriding(false),
58  mySpeedOverrideValue(destLanes[0]->getSpeedLimit()),
59  myDidInit(false) {
60  if (file != "") {
61  if (!XMLSubSys::runParser(*this, file)) {
62  throw ProcessError();
63  }
64  if (!myDidInit) {
65  init();
66  }
67  }
68 }
69 
70 void
72  // set it to the right value
73  // assert there is at least one
74  if (myLoadedSpeeds.size() == 0) {
75  myLoadedSpeeds.push_back(std::make_pair(100000, myCurrentSpeed));
76  }
77  // set the process to the begin
79  // pass previous time steps
81  while ((*myCurrentEntry).first < now && myCurrentEntry != myLoadedSpeeds.end()) {
82  processCommand(true, now);
83  }
84 
85  // add the processing to the event handler
88  (*myCurrentEntry).first);
89  myDidInit = true;
90 }
91 
92 
94 
95 
98  return processCommand(true, currentTime);
99 }
100 
101 
102 SUMOTime
103 MSLaneSpeedTrigger::processCommand(bool move2next, SUMOTime currentTime) {
104  UNUSED_PARAMETER(currentTime);
105  std::vector<MSLane*>::iterator i;
106  const double speed = getCurrentSpeed();
108  if (myDestLanes.size() > 0 && myDestLanes.front()->getSpeedLimit() != speed) {
109  myDestLanes.front()->getEdge().setMaxSpeed(speed);
110  MESegment* first = MSGlobals::gMesoNet->getSegmentForEdge(myDestLanes.front()->getEdge());
111  while (first != nullptr) {
112  first->setSpeed(speed, currentTime, -1);
113  first = first->getNextSegment();
114  }
115  }
116  } else {
117  for (i = myDestLanes.begin(); i != myDestLanes.end(); ++i) {
118  (*i)->setMaxSpeed(speed);
119  }
120  }
121  if (!move2next) {
122  // changed from the gui
123  return 0;
124  }
125  if (myCurrentEntry != myLoadedSpeeds.end()) {
126  ++myCurrentEntry;
127  }
128  if (myCurrentEntry != myLoadedSpeeds.end()) {
129  return ((*myCurrentEntry).first) - ((*(myCurrentEntry - 1)).first);
130  } else {
131  return 0;
132  }
133 }
134 
135 
136 void
138  const SUMOSAXAttributes& attrs) {
139  // check whether the correct tag is read
140  if (element != SUMO_TAG_STEP) {
141  return;
142  }
143  // extract the values
144  bool ok = true;
145  SUMOTime next = attrs.getSUMOTimeReporting(SUMO_ATTR_TIME, getID().c_str(), ok);
146  double speed = attrs.getOpt<double>(SUMO_ATTR_SPEED, getID().c_str(), ok, -1);
147  // check the values
148  if (next < 0) {
149  WRITE_ERROR("Wrong time in vss '" + getID() + "'.");
150  return;
151  }
152  if (speed < 0) {
153  speed = myDefaultSpeed;
154  }
155  // set the values for the next step if they are valid
156  if (myLoadedSpeeds.size() != 0 && myLoadedSpeeds.back().first == next) {
157  WRITE_WARNING("Time " + time2string(next) + " was set twice for vss '" + getID() + "'; replacing first entry.");
158  myLoadedSpeeds.back().second = speed;
159  } else {
160  myLoadedSpeeds.push_back(std::make_pair(next, speed));
161  }
162 }
163 
164 
165 void
167  if (element == SUMO_TAG_VSS && !myDidInit) {
168  init();
169  }
170 }
171 
172 
173 double
175  return myDefaultSpeed;
176 }
177 
178 
179 void
181  myAmOverriding = val;
182  processCommand(false, MSNet::getInstance()->getCurrentTimeStep());
183 }
184 
185 
186 void
188  mySpeedOverrideValue = val;
189  processCommand(false, MSNet::getInstance()->getCurrentTimeStep());
190 }
191 
192 
193 double
195  if (myCurrentEntry != myLoadedSpeeds.begin()) {
196  return (*(myCurrentEntry - 1)).second;
197  } else {
198  return (*myCurrentEntry).second;
199  }
200 }
201 
202 
203 double
205  if (myAmOverriding) {
206  return mySpeedOverrideValue;
207  } else {
209  // ok, maybe the first shall not yet be the valid one
210  if (myCurrentEntry == myLoadedSpeeds.begin() && (*myCurrentEntry).first > now) {
211  return myDefaultSpeed;
212  }
213  // try the loaded
214  if (myCurrentEntry != myLoadedSpeeds.end() && (*myCurrentEntry).first <= now) {
215  return (*myCurrentEntry).second;
216  } else {
217  // we have run past the end of the loaded steps or the current step is not yet active:
218  // -> use the value of the previous step
219  return (*(myCurrentEntry - 1)).second;
220  }
221  }
222 }
223 
224 
225 /****************************************************************************/
226 
UNUSED_PARAMETER
#define UNUSED_PARAMETER(x)
Definition: StdDefs.h:32
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:113
MSLaneSpeedTrigger::setOverridingValue
void setOverridingValue(double val)
Definition: MSLaneSpeedTrigger.cpp:187
MSLaneSpeedTrigger::mySpeedOverrideValue
double mySpeedOverrideValue
The speed to use if overriding the read speed.
Definition: MSLaneSpeedTrigger.h:133
MSLaneSpeedTrigger::myCurrentEntry
std::vector< std::pair< SUMOTime, double > >::iterator myCurrentEntry
Definition: MSLaneSpeedTrigger.h:136
MSEventControl::addEvent
virtual void addEvent(Command *operation, SUMOTime execTimeStep=-1)
Adds an Event.
Definition: MSEventControl.cpp:53
MSLaneSpeedTrigger::myCurrentSpeed
double myCurrentSpeed
Definition: MSLaneSpeedTrigger.h:124
WRITE_WARNING
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:239
MSLaneSpeedTrigger.h
MSNet.h
SUMOSAXHandler
SAX-handler base for SUMO-files.
Definition: SUMOSAXHandler.h:42
MESegment
A single mesoscopic segment (cell)
Definition: MESegment.h:50
MSNet::getBeginOfTimestepEvents
MSEventControl * getBeginOfTimestepEvents()
Returns the event control for events executed at the begin of a time step.
Definition: MSNet.h:430
MsgHandler.h
MSLaneSpeedTrigger::myDefaultSpeed
double myDefaultSpeed
The original speed allowed on the lanes.
Definition: MSLaneSpeedTrigger.h:127
WrappingCommand.h
MSLaneSpeedTrigger::execute
SUMOTime execute(SUMOTime currentTime)
Executes a switch command.
Definition: MSLaneSpeedTrigger.cpp:97
SUMOTime
long long int SUMOTime
Definition: SUMOTime.h:35
WrappingCommand
A wrapper for a Command function.
Definition: WrappingCommand.h:52
MSGlobals::gUseMesoSim
static bool gUseMesoSim
Definition: MSGlobals.h:91
SUMO_ATTR_SPEED
Definition: SUMOXMLDefinitions.h:385
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:64
MSLaneSpeedTrigger::getLoadedSpeed
double getLoadedSpeed()
Definition: MSLaneSpeedTrigger.cpp:194
MSLaneSpeedTrigger::init
void init()
Definition: MSLaneSpeedTrigger.cpp:71
MESegment.h
MSLaneSpeedTrigger::myStartElement
virtual void myStartElement(int element, const SUMOSAXAttributes &attrs)
Called on the opening of a tag;.
Definition: MSLaneSpeedTrigger.cpp:137
MSLaneSpeedTrigger::myLoadedSpeeds
std::vector< std::pair< SUMOTime, double > > myLoadedSpeeds
Definition: MSLaneSpeedTrigger.h:135
SUMO_TAG_VSS
A variable speed sign.
Definition: SUMOXMLDefinitions.h:90
MSNet::getCurrentTimeStep
SUMOTime getCurrentTimeStep() const
Returns the current simulation step.
Definition: MSNet.h:284
MELoop::getSegmentForEdge
MESegment * getSegmentForEdge(const MSEdge &e, double pos=0)
Get the segment for a given edge at a given position.
Definition: MELoop.cpp:293
ProcessError
Definition: UtilExceptions.h:40
SUMO_TAG_STEP
trigger: a step description
Definition: SUMOXMLDefinitions.h:158
time2string
std::string time2string(SUMOTime t)
Definition: SUMOTime.cpp:65
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:152
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:519
SUMO_ATTR_TIME
trigger: the time of the step
Definition: SUMOXMLDefinitions.h:673
MSLaneSpeedTrigger::processCommand
SUMOTime processCommand(bool move2next, SUMOTime currentTime)
Definition: MSLaneSpeedTrigger.cpp:103
MSTrigger
An abstract device that changes the state of the micro simulation.
Definition: MSTrigger.h:41
MSLaneSpeedTrigger::~MSLaneSpeedTrigger
virtual ~MSLaneSpeedTrigger()
Destructor.
Definition: MSLaneSpeedTrigger.cpp:93
StringUtils.h
MSNet::getInstance
static MSNet * getInstance()
Returns the pointer to the unique instance of MSNet (singleton).
Definition: MSNet.cpp:168
MSGlobals::gMesoNet
static MELoop * gMesoNet
mesoscopic simulation infrastructure
Definition: MSGlobals.h:106
MSLaneSpeedTrigger::myAmOverriding
bool myAmOverriding
The information whether the read speed shall be overridden.
Definition: MSLaneSpeedTrigger.h:130
MSLaneSpeedTrigger::setOverriding
void setOverriding(bool val)
Definition: MSLaneSpeedTrigger.cpp:180
MSLaneSpeedTrigger::myDidInit
bool myDidInit
The information whether init was called.
Definition: MSLaneSpeedTrigger.h:150
config.h
MSLaneSpeedTrigger::MSLaneSpeedTrigger
MSLaneSpeedTrigger(const std::string &id, const std::vector< MSLane * > &destLanes, const std::string &file)
Constructor.
Definition: MSLaneSpeedTrigger.cpp:49
MELoop.h
MSLaneSpeedTrigger::getDefaultSpeed
double getDefaultSpeed() const
Definition: MSLaneSpeedTrigger.cpp:174
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:624
MSLaneSpeedTrigger::myEndElement
virtual void myEndElement(int element)
Called on the closing of a tag;.
Definition: MSLaneSpeedTrigger.cpp:166
SUMOSAXAttributes
Encapsulated SAX-Attributes.
Definition: SUMOSAXAttributes.h:57
Named::getID
const std::string & getID() const
Returns the id.
Definition: Named.h:77
WRITE_ERROR
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:245
SUMOXMLDefinitions.h
MSLaneSpeedTrigger::getCurrentSpeed
double getCurrentSpeed() const
Returns the current speed.
Definition: MSLaneSpeedTrigger.cpp:204
MSLaneSpeedTrigger::myDestLanes
std::vector< MSLane * > myDestLanes
Definition: MSLaneSpeedTrigger.h:121
XMLSubSys.h