SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
MSInsertionControl.cpp
Go to the documentation of this file.
1 /****************************************************************************/
11 // Inserts vehicles into the network when their departure time is reached
12 /****************************************************************************/
13 // SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
14 // Copyright (C) 2001-2015 DLR (http://www.dlr.de/) and contributors
15 /****************************************************************************/
16 //
17 // This file is part of SUMO.
18 // SUMO is free software: you can redistribute it and/or modify
19 // it under the terms of the GNU General Public License as published by
20 // the Free Software Foundation, either version 3 of the License, or
21 // (at your option) any later version.
22 //
23 /****************************************************************************/
24 
25 
26 // ===========================================================================
27 // included modules
28 // ===========================================================================
29 #ifdef _MSC_VER
30 #include <windows_config.h>
31 #else
32 #include <config.h>
33 #endif
34 
35 #include <iostream>
36 #include <algorithm>
37 #include <cassert>
38 #include <iterator>
40 #include "MSGlobals.h"
41 #include "MSInsertionControl.h"
42 #include "MSVehicle.h"
43 #include "MSLane.h"
44 #include "MSEdge.h"
45 #include "MSRouteHandler.h"
46 
47 #ifdef CHECK_MEMORY_LEAKS
48 #include <foreign/nvwa/debug_new.h>
49 #endif // CHECK_MEMORY_LEAKS
50 
51 
52 // ===========================================================================
53 // member method definitions
54 // ===========================================================================
56  SUMOTime maxDepartDelay,
57  bool checkEdgesOnce)
58  : myVehicleControl(vc), myMaxDepartDelay(maxDepartDelay),
59  myCheckEdgesOnce(checkEdgesOnce) {}
60 
61 
63  for (std::vector<Flow>::iterator i = myFlows.begin(); i != myFlows.end(); ++i) {
64  delete(i->pars);
65  }
66 }
67 
68 
69 void
71  myAllVeh.add(veh);
72 }
73 
74 
75 bool
77  if (myFlowIDs.count(pars->id) > 0) {
78  return false;
79  }
80  Flow flow;
81  flow.pars = pars;
85  flow.index = 0;
86  if (!flow.isVolatile) {
88  if (dist != 0) {
89  const std::vector<const MSRoute*>& routes = dist->getVals();
90  const MSEdge* e = 0;
91  for (std::vector<const MSRoute*>::const_iterator i = routes.begin(); i != routes.end(); ++i) {
92  if (e == 0) {
93  e = (*i)->getEdges()[0];
94  } else {
95  if (e != (*i)->getEdges()[0]) {
96  flow.isVolatile = true;
97  break;
98  }
99  }
100  }
101  }
102  }
103  flow.vehicle = 0;
104  myFlows.push_back(flow);
105  myFlowIDs.insert(pars->id);
106  return true;
107 }
108 
109 
110 unsigned int
112  // check whether any vehicles shall be emitted within this time step
113  const bool havePreChecked = MSDevice_Routing::isEnabled();
114  if (myPendingEmits.empty() || (havePreChecked && myEmitCandidates.empty())) {
115  return 0;
116  }
117  unsigned int numEmitted = 0;
118  // we use buffering for the refused emits to save time
119  // for this, we have two lists; one contains previously refused emits, the second
120  // will be used to append those vehicles that will not be able to depart in this
121  // time step
123 
124  // go through the list of previously refused vehicles, first
125  MSVehicleContainer::VehicleVector::const_iterator veh;
126  for (veh = myPendingEmits.begin(); veh != myPendingEmits.end(); veh++) {
127  if (havePreChecked && (myEmitCandidates.count(*veh) == 0)) {
128  refusedEmits.push_back(*veh);
129  } else {
130  numEmitted += tryInsert(time, *veh, refusedEmits);
131  }
132  }
133  myEmitCandidates.clear();
134  myPendingEmits = refusedEmits;
135  return numEmitted;
136 }
137 
138 
139 unsigned int
141  MSVehicleContainer::VehicleVector& refusedEmits) {
142  assert(veh->getParameter().depart < time + DELTA_T);
143  const MSEdge& edge = *veh->getEdge();
144  if ((!myCheckEdgesOnce || edge.getLastFailedInsertionTime() != time) && edge.insertVehicle(*veh, time)) {
145  // Successful insertion
146  checkFlowWait(veh);
147  veh->onDepart();
148  return 1;
149  }
150  if (myMaxDepartDelay >= 0 && time - veh->getParameter().depart > myMaxDepartDelay) {
151  // remove vehicles waiting too long for departure
152  checkFlowWait(veh);
153  myVehicleControl.deleteVehicle(veh, true);
154  } else if (edge.isVaporizing()) {
155  // remove vehicles if the edge shall be empty
156  checkFlowWait(veh);
157  myVehicleControl.deleteVehicle(veh, true);
158  } else if (myAbortedEmits.count(veh) > 0) {
159  // remove vehicles which shall not be inserted for some reason
160  myAbortedEmits.erase(veh);
161  checkFlowWait(veh);
162  myVehicleControl.deleteVehicle(veh, true);
163  } else {
164  // let the vehicle wait one step, we'll retry then
165  refusedEmits.push_back(veh);
166  }
167  edge.setLastFailedInsertionTime(time);
168  return 0;
169 }
170 
171 
172 void
174  for (std::vector<Flow>::iterator i = myFlows.begin(); i != myFlows.end(); ++i) {
175  if (i->vehicle == veh) {
176  i->vehicle = 0;
177  break;
178  }
179  }
180 }
181 
182 
183 void
184 MSInsertionControl::checkCandidates(SUMOTime time, const bool preCheck) {
185  while (myAllVeh.anyWaitingBefore(time + DELTA_T)) {
187  copy(top.begin(), top.end(), back_inserter(myPendingEmits));
188  myAllVeh.pop();
189  }
190  if (preCheck) {
191  MSVehicleContainer::VehicleVector::const_iterator veh;
192  for (veh = myPendingEmits.begin(); veh != myPendingEmits.end(); veh++) {
193  SUMOVehicle* const v = *veh;
194  const MSEdge* const edge = v->getEdge();
195  if ((!myCheckEdgesOnce || edge->getLastFailedInsertionTime() != time) && edge->insertVehicle(*v, time, true)) {
196  myEmitCandidates.insert(v);
197  } else {
198  MSDevice_Routing* dev = static_cast<MSDevice_Routing*>(v->getDevice(typeid(MSDevice_Routing)));
199  if (dev != 0) {
200  dev->skipRouting(time);
201  }
202  }
203  }
204  }
205 }
206 
207 
208 void
211  for (std::vector<Flow>::iterator i = myFlows.begin(); i != myFlows.end();) {
212  SUMOVehicleParameter* pars = i->pars;
213  if (!i->isVolatile && i->vehicle != 0 && pars->repetitionProbability < 0) {
214  ++i;
215  //std::cout << SIMTIME << " volatile=" << i->isVolatile << " veh=" << i->vehicle << "\n";
216  continue;
217  }
218  bool tryEmitByProb = pars->repetitionProbability > 0;
219  while ((pars->repetitionProbability < 0
220  && pars->repetitionsDone < pars->repetitionNumber
221  && pars->depart + pars->repetitionsDone * pars->repetitionOffset < time + DELTA_T)
222  || (tryEmitByProb
223  && pars->depart < time + DELTA_T
224  && pars->repetitionEnd > time
225  // only call rand if all other conditions are met
226  && RandHelper::rand() < (pars->repetitionProbability * TS))
227  ) {
228  tryEmitByProb = false; // only emit one per step
229  SUMOVehicleParameter* newPars = new SUMOVehicleParameter(*pars);
230  newPars->id = pars->id + "." + toString(i->index);
231  newPars->depart = pars->repetitionProbability > 0 ? time : (SUMOTime)(pars->depart + pars->repetitionsDone * pars->repetitionOffset);
232  pars->repetitionsDone++;
233  // try to build the vehicle
234  if (vehControl.getVehicle(newPars->id) == 0) {
235  const MSRoute* route = MSRoute::dictionary(pars->routeid);
236  const MSVehicleType* vtype = vehControl.getVType(pars->vtypeid, MSRouteHandler::getParsingRNG());
237  i->vehicle = vehControl.buildVehicle(newPars, route, vtype, false);
238  unsigned int quota = vehControl.getQuota();
239  if (quota > 0) {
240  vehControl.addVehicle(newPars->id, i->vehicle);
241  add(i->vehicle);
242  i->index++;
243  while (--quota > 0) {
244  SUMOVehicleParameter* quotaPars = new SUMOVehicleParameter(*pars);
245  quotaPars->id = pars->id + "." + toString(i->index);
246  quotaPars->depart = pars->repetitionProbability > 0 ? time : (SUMOTime)(pars->depart + pars->repetitionsDone * pars->repetitionOffset);
247  i->vehicle = vehControl.buildVehicle(quotaPars, route, vtype, false);
248  vehControl.addVehicle(quotaPars->id, i->vehicle);
249  add(i->vehicle);
250  i->index++;
251  }
252  } else {
253  vehControl.deleteVehicle(i->vehicle, true);
254  i->vehicle = 0;
255  }
256  } else {
257  // strange: another vehicle with the same id already exists
259  break;
260  }
261  throw ProcessError("Another vehicle with the id '" + newPars->id + "' exists.");
262  }
263  }
264  if (pars->repetitionsDone == pars->repetitionNumber || (pars->repetitionProbability > 0 && pars->repetitionEnd <= time)) {
265  i = myFlows.erase(i);
267  delete pars;
268  } else {
269  ++i;
270  }
271  }
273 }
274 
275 
276 unsigned int
278  return (unsigned int)myPendingEmits.size();
279 }
280 
281 
282 int
284  return (int)myFlows.size();
285 }
286 
287 
288 void
290  myAbortedEmits.insert(veh);
291 }
292 
293 void
295  //clear out the refused vehicle list, deleting the vehicles entirely
296  MSVehicleContainer::VehicleVector::iterator veh;
297  for (veh = myPendingEmits.begin(); veh != myPendingEmits.end();) {
298  if ((*veh)->getRoute().getID() == route || route == "") {
299  myVehicleControl.deleteVehicle(*veh, true);
300  veh = myPendingEmits.erase(veh);
301  } else {
302  ++veh;
303  }
304  }
305 }
306 
307 
308 /****************************************************************************/
309 
SUMOTime repetitionEnd
The time at which the flow ends (only needed when using repetitionProbability)
SUMOReal repetitionProbability
The probability for emitting a vehicle per second.
int getPendingFlowCount() const
Returns the number of flows that are still active.
void checkFlowWait(SUMOVehicle *veh)
Checks whether any flow is blocked due to this vehicle and clears the block.
virtual void deleteVehicle(SUMOVehicle *v, bool discard=false)
Deletes the vehicle.
void descheduleDeparture(SUMOVehicle *veh)
stops trying to emit the given vehicle
bool insertVehicle(SUMOVehicle &v, SUMOTime time, const bool checkOnly=false) const
Tries to insert the given vehicle into the network.
Definition: MSEdge.cpp:367
int repetitionNumber
The number of times the vehicle shall be repeatedly inserted.
std::set< SUMOVehicle * > myAbortedEmits
Set of vehicles which shall not be inserted anymore.
std::string vtypeid
The vehicle's type id.
virtual void onDepart()=0
Called when the vehicle is inserted into the network.
void checkCandidates(SUMOTime time, const bool preCheck)
Adds all vehicles that should have been emitted earlier to the refuse container.
DepartLaneDefinition departLaneProcedure
Information how the vehicle shall choose the lane to depart from.
virtual const MSEdge * getEdge() const =0
Returns the edge the vehicle is currently at.
static MTRand * getParsingRNG()
static bool gStateLoaded
Information whether a state has been loaded.
Definition: MSGlobals.h:86
static SUMOReal rand()
Returns a random real number in [0, 1)
Definition: RandHelper.h:62
A device that performs vehicle rerouting based on current edge speeds.
int repetitionsDone
The number of times the vehicle was already inserted.
SUMOVehicle * vehicle
The last created vehicle.
unsigned int index
the running index
MSVehicleContainer myAllVeh
All loaded vehicles sorted by their departure time.
static MSNet * getInstance()
Returns the pointer to the unique instance of MSNet (singleton).
Definition: MSNet.cpp:159
virtual bool addVehicle(const std::string &id, SUMOVehicle *v)
Tries to insert the vehicle into the internal vehicle container.
The lane is chosen randomly.
static RandomDistributor< const MSRoute * > * distDictionary(const std::string &id)
Returns the named route distribution.
Definition: MSRoute.cpp:150
void skipRouting(const SUMOTime currentTime)
Labels the current time step as "unroutable".
#define TS
Definition: SUMOTime.h:52
SUMOReal repetitionOffset
The time offset between vehicle reinsertions.
The position is chosen randomly.
~MSInsertionControl()
Destructor.
The car-following model and parameter.
Definition: MSVehicleType.h:74
const std::vector< T > & getVals() const
Returns the members of the distribution.
std::vector< SUMOVehicle * > VehicleVector
definition of a list of vehicles which have the same departure time
A road/street connecting two junctions.
Definition: MSEdge.h:81
void pop()
Removes the uppermost vehicle vector.
unsigned int getWaitingVehicleNo() const
Returns the number of waiting vehicles.
std::string routeid
The vehicle's route id.
Representation of a vehicle.
Definition: SUMOVehicle.h:65
DepartPosDefinition departPosProcedure
Information how the vehicle shall choose the departure position.
bool myCheckEdgesOnce
Whether an edge on which a vehicle could not depart should be ignored in the same step...
MSVehicleContainer::VehicleVector myPendingEmits
Buffers for vehicles that could not be inserted.
unsigned int tryInsert(SUMOTime time, SUMOVehicle *veh, MSVehicleContainer::VehicleVector &refusedEmits)
Tries to emit the vehicle.
MSVehicleControl & getVehicleControl()
Returns the vehicle control.
Definition: MSNet.h:288
virtual SUMOVehicle * buildVehicle(SUMOVehicleParameter *defs, const MSRoute *route, const MSVehicleType *type, const bool ignoreStopErrors, const bool fromRouteFile=true)
Builds a vehicle, increases the number of built vehicles.
SUMOTime depart
The vehicle's departure time.
SUMOTime myMaxDepartDelay
The maximum waiting time; vehicles waiting longer are deleted (-1: no deletion)
void clearPendingVehicles(std::string &route)
clears out all pending vehicles from a route, "" for all routes
std::set< SUMOVehicle * > myEmitCandidates
Buffer for vehicles that may be inserted in the current step.
void add(SUMOVehicle *veh)
Adds a single vehicle.
std::string toString(const T &t, std::streamsize accuracy=OUTPUT_ACCURACY)
Definition: ToString.h:53
static bool isEnabled()
returns whether any routing actions take place
const VehicleVector & top()
Returns the uppermost vehicle vector.
bool isVolatile
whether it has route or vehicle type distribution
std::vector< Flow > myFlows
Container for periodical vehicle parameters.
Structure representing possible vehicle parameter.
virtual const SUMOVehicleParameter & getParameter() const =0
Returns the vehicle's parameter (including departure definition)
MSVehicleControl & myVehicleControl
The assigned vehicle control (needed for vehicle re-insertion and deletion)
MSInsertionControl(MSVehicleControl &vc, SUMOTime maxDepartDelay, bool checkEdgesOnce)
Constructor.
unsigned int emitVehicles(SUMOTime time)
Emits vehicles that want to depart at the given time.
int SUMOTime
Definition: SUMOTime.h:43
SUMOTime getLastFailedInsertionTime() const
Returns the last time a vehicle could not be inserted.
Definition: MSEdge.h:486
SUMOVehicle * getVehicle(const std::string &id) const
Returns the vehicle with the given id.
bool anyWaitingBefore(SUMOTime time) const
Returns the information whether any vehicles want to depart before the given time.
bool hasVTypeDistribution(const std::string &id) const
Asks for a vehicle type distribution.
virtual MSDevice * getDevice(const std::type_info &type) const =0
Returns a device of the given type if it exists or 0.
#define DELTA_T
Definition: SUMOTime.h:50
The class responsible for building and deletion of vehicles.
SUMOVehicleParameter * pars
The paramters.
MSVehicleType * getVType(const std::string &id=DEFAULT_VTYPE_ID, MTRand *rng=0)
Returns the named vehicle type or a sample from the named distribution.
void add(SUMOVehicle *veh)
Adds a single vehicle for departure.
std::set< std::string > myFlowIDs
Cache for periodical vehicle ids for quicker checking.
static void checkDist(const std::string &id)
Checks the distribution whether it is permanent and deletes it if not.
Definition: MSRoute.cpp:173
unsigned int getQuota(SUMOReal frac=-1) const
Returns the number of instances of the current vehicle that shall be emitted considering that "frac" ...
void determineCandidates(SUMOTime time)
Checks for all vehicles whether they can be emitted.
std::string id
The vehicle's id.
static bool dictionary(const std::string &id, const MSRoute *route)
Adds a route to the dictionary.
Definition: MSRoute.cpp:116