SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MSNet.h
Go to the documentation of this file.
1 /****************************************************************************/
13 // The simulated network and simulation perfomer
14 /****************************************************************************/
15 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
16 // Copyright (C) 2001-2014 DLR (http://www.dlr.de/) and contributors
17 /****************************************************************************/
18 //
19 // This file is part of SUMO.
20 // SUMO is free software: you can redistribute it and/or modify
21 // it under the terms of the GNU General Public License as published by
22 // the Free Software Foundation, either version 3 of the License, or
23 // (at your option) any later version.
24 //
25 /****************************************************************************/
26 #ifndef MSNet_h
27 #define MSNet_h
28 
29 
30 // ===========================================================================
31 // included modules
32 // ===========================================================================
33 #ifdef _MSC_VER
34 #include <windows_config.h>
35 #else
36 #include <config.h>
37 #endif
38 
39 #include <typeinfo>
40 #include <vector>
41 #include <map>
42 #include <string>
43 #include <fstream>
44 #include <iostream>
45 #include <cmath>
46 #include <iomanip>
47 #include "MSVehicleControl.h"
48 #include "MSEventControl.h"
49 #include <utils/geom/Boundary.h>
50 #include <utils/geom/Position.h>
51 #include <utils/common/SUMOTime.h>
60 
61 
62 // ===========================================================================
63 // class declarations
64 // ===========================================================================
65 class MSEdge;
66 class MSEdgeControl;
67 class MSJunctionControl;
68 class MSInsertionControl;
70 class MSPersonControl;
71 class MSVehicle;
72 class MSRoute;
73 class MSLane;
74 class MSTLLogicControl;
75 class MSDetectorControl;
76 class ShapeContainer;
77 class BinaryInputDevice;
79 class SUMOVehicle;
80 
81 
82 // ===========================================================================
83 // class definitions
84 // ===========================================================================
89 class MSNet {
90 public:
107  };
108 
109 
110 public:
115  static MSNet* getInstance();
116 
117 
132  MSNet(MSVehicleControl* vc, MSEventControl* beginOfTimestepEvents,
133  MSEventControl* endOfTimestepEvents, MSEventControl* insertionEvents,
134  ShapeContainer* shapeCont = 0);
135 
136 
138  virtual ~MSNet();
139 
140 
152  void closeBuilding(MSEdgeControl* edges, MSJunctionControl* junctions,
153  SUMORouteLoaderControl* routeLoaders, MSTLLogicControl* tlc,
154  std::vector<SUMOTime> stateDumpTimes, std::vector<std::string> stateDumpFiles);
155 
156 
160  static void clearAll();
161 
162 
170  int simulate(SUMOTime start, SUMOTime stop);
171 
172 
176  void simulationStep();
177 
178 
180  void loadRoutes();
181 
182 
190  void closeSimulation(SUMOTime start);
191 
192 
198  SimulationState simulationState(SUMOTime stopTime) const;
199 
200 
204  static std::string getStateMessage(SimulationState state);
205 
206 
210  inline SUMOTime getCurrentTimeStep() const {
211  return myStep;
212  }
213 
214 
218  inline void setCurrentTimeStep(const SUMOTime step) {
219  myStep = step;
220  }
221 
222 
226  void writeOutput();
227 
228 
232  bool logSimulationDuration() const;
233 
234 
235 
237 
238 
243  void preSimStepOutput() const;
244 
245 
250  void postSimStepOutput() const;
251  //}
252 
253 
254 
257 
264  return *myVehicleControl;
265  }
266 
267 
277 
278 
285  return *myEdges;
286  }
287 
288 
295  return *myInserter;
296  }
297 
298 
305  return *myDetectorControl;
306  }
307 
308 
315  return *myLogics;
316  }
317 
318 
325  return *myJunctions;
326  }
327 
328 
335  return *myBeginOfTimestepEvents;
336  }
337 
338 
345  return *myEndOfTimestepEvents;
346  }
347 
348 
355  return *myInsertionEvents;
356  }
357 
358 
365  return *myShapeContainer;
366  }
367 
368 
376 
377 
378 
381 
393  bool addBusStop(MSBusStop* busStop);
394 
395 
400  MSBusStop* getBusStop(const std::string& id) const;
401 
402 
408  std::string getBusStopID(const MSLane* lane, const SUMOReal pos) const;
410 
411 
412 
415 
438  };
439 
440 
445  public:
448 
450  virtual ~VehicleStateListener() { }
451 
456  virtual void vehicleStateChanged(const SUMOVehicle* const vehicle, VehicleState to) = 0;
457 
458  };
459 
460 
464  void addVehicleStateListener(VehicleStateListener* listener);
465 
466 
470  void removeVehicleStateListener(VehicleStateListener* listener);
471 
472 
478  void informVehicleStateListener(const SUMOVehicle* const vehicle, VehicleState to);
480 
481 
482 
490  static SUMOReal getTravelTime(const MSEdge* const e, const SUMOVehicle* const v, SUMOReal t);
491 
492 
500  static SUMOReal getEffort(const MSEdge* const e, const SUMOVehicle* const v, SUMOReal t);
501 
502 
503  /* @brief get the router, initialize on first use
504  * @param[in] prohibited The vector of forbidden edges (optional)
505  */
507  const std::vector<MSEdge*>& prohibited = std::vector<MSEdge*>()) const;
509  const std::vector<MSEdge*>& prohibited = std::vector<MSEdge*>()) const;
510 
511 
515  const NamedRTree& getLanesRTree() const;
516 
517 
518 protected:
520  static MSNet* myInstance;
521 
524 
527 
528 
529 
532 
558 
559 
560 
563 
566 
569 
572 
575 
578  //}
579 
580 
581 
584 
586  std::vector<SUMOTime> myStateDumpTimes;
588  std::vector<std::string> myStateDumpFiles;
590 
591 
592 
595 
598 
600  std::vector<VehicleStateListener*> myVehicleStateListeners;
601 
602 
603  /* @brief The router instance for routing by trigger and by traci
604  * @note MSDevice_Routing has its own instance since it uses a different weight function
605  * @note we provide one member for every switchable router type
606  * because the class structure makes it inconvenient to use a superclass*/
607  mutable bool myRouterTTInitialized;
611 
612 
614  mutable std::pair<bool, NamedRTree> myLanesRTree;
615 
616 
618  static const std::string STAGE_EVENTS;
619  static const std::string STAGE_MOVEMENTS;
620  static const std::string STAGE_LANECHANGE;
621  static const std::string STAGE_INSERTIONS;
622 
623 private:
625  MSNet(const MSNet&);
626 
628  MSNet& operator=(const MSNet&);
629 
630 
631 };
632 
633 
634 #endif
635 
636 /****************************************************************************/
637 
The vehicle has departed (was inserted into the network)
Definition: MSNet.h:421
void postSimStepOutput() const
Prints the statistics of the step at its end.
Definition: MSNet.cpp:635
Representation of a vehicle in the micro simulation.
Definition: MSVehicle.h:77
Interface for objects listening to vehicle state changes.
Definition: MSNet.h:444
long mySimStepEnd
Definition: MSNet.h:571
void removeVehicleStateListener(VehicleStateListener *listener)
Removes a vehicle states listener.
Definition: MSNet.cpp:668
MSEventControl * myEndOfTimestepEvents
Controls events executed at the end of a time step;.
Definition: MSNet.h:550
static SUMOReal getEffort(const MSEdge *const e, const SUMOVehicle *const v, SUMOReal t)
Returns the effort to pass an edge.
Definition: MSNet.cpp:122
The simulation contains too many vehicles (.
Definition: MSNet.h:106
MSEventControl & getEndOfTimestepEvents()
Returns the event control for events executed at the end of a time step.
Definition: MSNet.h:344
MSVehicleControl * myVehicleControl
Controls vehicle building and deletion;.
Definition: MSNet.h:534
std::vector< SUMOTime > myStateDumpTimes
Times at which a state shall be written.
Definition: MSNet.h:586
int simulate(SUMOTime start, SUMOTime stop)
Simulates from timestep start to stop.
Definition: MSNet.cpp:263
virtual void vehicleStateChanged(const SUMOVehicle *const vehicle, VehicleState to)=0
Called if a vehicle changes its state.
A RT-tree for efficient storing of SUMO's Named objects.
Definition: NamedRTree.h:70
MSPersonControl * myPersonControl
Controls person building and deletion;.
Definition: MSNet.h:536
static MSNet * getInstance()
Returns the pointer to the unique instance of MSNet (singleton).
Definition: MSNet.cpp:154
MSEdgeControl * myEdges
Controls edges, performs vehicle movement;.
Definition: MSNet.h:538
void setCurrentTimeStep(const SUMOTime step)
Sets the current simulation step (used by state loading)
Definition: MSNet.h:218
The final simulation step has been performed.
Definition: MSNet.h:98
std::vector< std::string > myStateDumpFiles
The names for the state files.
Definition: MSNet.h:588
bool myLogExecutionTime
Information whether the simulation duration shall be logged.
Definition: MSNet.h:565
Storage for geometrical objects.
static const std::string STAGE_LANECHANGE
Definition: MSNet.h:620
Detectors container; responsible for string and output generation.
A storage for edge travel times and efforts.
SUMOTime getCurrentTimeStep() const
Returns the current simulation step.
Definition: MSNet.h:210
SUMOAbstractRouter< MSEdge, SUMOVehicle > & getRouterEffort(const std::vector< MSEdge * > &prohibited=std::vector< MSEdge * >()) const
Definition: MSNet.cpp:739
std::string getBusStopID(const MSLane *lane, const SUMOReal pos) const
Returns the bus stop close to the given position.
Definition: MSNet.cpp:699
void addVehicleStateListener(VehicleStateListener *listener)
Adds a vehicle states listener.
Definition: MSNet.cpp:660
SimulationState
Possible states of a simulation - running or stopped with different reasons.
Definition: MSNet.h:94
The simulated network and simulation perfomer.
Definition: MSNet.h:89
SUMOLong myVehiclesMoved
The overall number of vehicle movements.
Definition: MSNet.h:577
ShapeContainer * myShapeContainer
A container for geometrical shapes;.
Definition: MSNet.h:554
std::pair< bool, NamedRTree > myLanesRTree
An RTree structure holding lane IDs.
Definition: MSNet.h:614
Container for junctions; performs operations on all stored junctions.
bool addBusStop(MSBusStop *busStop)
Adds a bus stop.
Definition: MSNet.cpp:687
The vehicles starts to stop.
Definition: MSNet.h:435
A class that stores and controls tls and switching of their programs.
A road/street connecting two junctions.
Definition: MSEdge.h:73
long mySimStepBegin
The last simulation step begin, end and duration.
Definition: MSNet.h:571
The simulation does not contain further vehicles.
Definition: MSNet.h:100
An error occured during the simulation step.
Definition: MSNet.h:104
void writeOutput()
Write netstate, summary and detector output.
Definition: MSNet.cpp:517
The vehicle got a new route.
Definition: MSNet.h:429
The vehicle arrived at his destination (is deleted)
Definition: MSNet.h:427
The vehicles starts to park.
Definition: MSNet.h:431
MSInsertionControl * myInserter
Controls vehicle insertion;.
Definition: MSNet.h:544
Representation of a vehicle.
Definition: SUMOVehicle.h:63
SUMORouteLoaderControl * myRouteLoaders
Route loader for dynamic loading of routes.
Definition: MSNet.h:523
ShapeContainer & getShapeContainer()
Returns the shapes container.
Definition: MSNet.h:364
void closeSimulation(SUMOTime start)
Closes the simulation (all files, connections, etc.)
Definition: MSNet.cpp:314
bool myLogStepNumber
Information whether the number of the simulation step shall be logged.
Definition: MSNet.h:568
MSTLLogicControl & getTLSControl()
Returns the tls logics control.
Definition: MSNet.h:314
A lane area vehicles can halt at.
Definition: MSBusStop.h:63
MSVehicleControl & getVehicleControl()
Returns the vehicle control.
Definition: MSNet.h:263
static SUMOReal getTravelTime(const MSEdge *const e, const SUMOVehicle *const v, SUMOReal t)
Returns the travel time to pass an edge.
Definition: MSNet.cpp:136
MSDetectorControl * myDetectorControl
Controls detectors;.
Definition: MSNet.h:546
Stores edges and lanes, performs moving of vehicle.
Definition: MSEdgeControl.h:73
MSTLLogicControl * myLogics
Controls tls logics, realizes waiting on tls rules;.
Definition: MSNet.h:542
The connection to a client was closed by the client.
Definition: MSNet.h:102
DijkstraRouterTT_ByProxi< MSEdge, SUMOVehicle, prohibited_withRestrictions< MSEdge, SUMOVehicle > > * myRouterTTDijkstra
Definition: MSNet.h:608
The simulation is running.
Definition: MSNet.h:96
MSNet & operator=(const MSNet &)
Invalidated assignment operator.
The vehicle started to teleport.
Definition: MSNet.h:423
#define SUMOLong
Definition: config.h:212
void preSimStepOutput() const
Prints the current step number.
Definition: MSNet.cpp:629
MSBusStop * getBusStop(const std::string &id) const
Returns the named bus stop.
Definition: MSNet.cpp:693
The vehicle ends to park.
Definition: MSNet.h:433
AStarRouterTT_ByProxi< MSEdge, SUMOVehicle, prohibited_withRestrictions< MSEdge, SUMOVehicle > > * myRouterTTAStar
Definition: MSNet.h:609
MSDetectorControl & getDetectorControl()
Returns the detector control.
Definition: MSNet.h:304
Inserts vehicles into the network when their departure time is reached.
VehicleState
Definition of a vehicle state.
Definition: MSNet.h:417
static const std::string STAGE_MOVEMENTS
Definition: MSNet.h:619
VehicleStateListener()
Constructor.
Definition: MSNet.h:447
The vehicle was built, but has not yet departed.
Definition: MSNet.h:419
std::vector< VehicleStateListener * > myVehicleStateListeners
Container for vehicle state listener.
Definition: MSNet.h:600
static MSNet * myInstance
Unique instance of MSNet.
Definition: MSNet.h:520
MSEventControl & getInsertionEvents()
Returns the event control for insertion events.
Definition: MSNet.h:354
static void clearAll()
Clears all dictionaries.
Definition: MSNet.cpp:504
bool myRouterTTInitialized
Definition: MSNet.h:607
SimulationState simulationState(SUMOTime stopTime) const
Called after a simulation step, this method returns the current simulation state. ...
Definition: MSNet.cpp:452
MSJunctionControl * myJunctions
Controls junctions, realizes right-of-way rules;.
Definition: MSNet.h:540
virtual MSPersonControl & getPersonControl()
Returns the person control.
Definition: MSNet.cpp:611
MSInsertionControl & getInsertionControl()
Returns the insertion control.
Definition: MSNet.h:294
MSEventControl * myBeginOfTimestepEvents
Controls events executed at the begin of a time step;.
Definition: MSNet.h:548
virtual ~VehicleStateListener()
Destructor.
Definition: MSNet.h:450
MSEdgeWeightsStorage * myEdgeWeights
The net's knowledge about edge efforts/travel times;.
Definition: MSNet.h:556
MSNet(MSVehicleControl *vc, MSEventControl *beginOfTimestepEvents, MSEventControl *endOfTimestepEvents, MSEventControl *insertionEvents, ShapeContainer *shapeCont=0)
Constructor.
Definition: MSNet.cpp:162
The vehicle ends to stop.
Definition: MSNet.h:437
SUMOAbstractRouter< MSEdge, SUMOVehicle > & getRouterTT(const std::vector< MSEdge * > &prohibited=std::vector< MSEdge * >()) const
Definition: MSNet.cpp:712
int SUMOTime
Definition: SUMOTime.h:43
void informVehicleStateListener(const SUMOVehicle *const vehicle, VehicleState to)
Informs all added listeners about a vehicle's state change.
Definition: MSNet.cpp:677
const NamedRTree & getLanesRTree() const
Returns an RTree that contains lane IDs.
Definition: MSNet.cpp:750
long mySimBeginMillis
The overall simulation duration.
Definition: MSNet.h:574
virtual ~MSNet()
Destructor.
Definition: MSNet.cpp:229
#define SUMOReal
Definition: config.h:215
static std::string getStateMessage(SimulationState state)
Returns the message to show if a certain state occurs.
Definition: MSNet.cpp:483
MSEdgeControl & getEdgeControl()
Returns the edge control.
Definition: MSNet.h:284
bool logSimulationDuration() const
Returns whether duration shall be logged.
Definition: MSNet.cpp:605
MSJunctionControl & getJunctionControl()
Returns the junctions control.
Definition: MSNet.h:324
SUMOTime myStep
Current time step.
Definition: MSNet.h:526
The class responsible for building and deletion of vehicles.
void closeBuilding(MSEdgeControl *edges, MSJunctionControl *junctions, SUMORouteLoaderControl *routeLoaders, MSTLLogicControl *tlc, std::vector< SUMOTime > stateDumpTimes, std::vector< std::string > stateDumpFiles)
Closes the network's building process.
Definition: MSNet.cpp:206
NamedObjectCont< MSBusStop * > myBusStopDict
Dictionary of bus stops.
Definition: MSNet.h:597
void simulationStep()
Performs a single simulation step.
Definition: MSNet.cpp:364
MSEventControl & getBeginOfTimestepEvents()
Returns the event control for events executed at the begin of a time step.
Definition: MSNet.h:334
void loadRoutes()
loads routes for the next few steps
Definition: MSNet.cpp:308
static const std::string STAGE_INSERTIONS
Definition: MSNet.h:621
MSEventControl * myInsertionEvents
Controls insertion events;.
Definition: MSNet.h:552
int myTooManyVehicles
Storage for maximum vehicle number.
Definition: MSNet.h:594
Representation of a lane in the micro simulation.
Definition: MSLane.h:77
long mySimStepDuration
Definition: MSNet.h:571
Encapsulates binary reading operations on a file.
Stores time-dependant events and executes them at the proper time.
The vehicle ended being teleported.
Definition: MSNet.h:425
MSEdgeWeightsStorage & getWeightsStorage()
Returns the net's internal edge travel times/efforts container.
Definition: MSNet.cpp:620
DijkstraRouterEffort_ByProxi< MSEdge, SUMOVehicle, prohibited_withRestrictions< MSEdge, SUMOVehicle > > * myRouterEffort
Definition: MSNet.h:610
static const std::string STAGE_EVENTS
string constants for simstep stages
Definition: MSNet.h:618