SUMO - Simulation of Urban MObility
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.dlr.de/
16 // Copyright (C) 2001-2016 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>
62 
63 
64 // ===========================================================================
65 // class declarations
66 // ===========================================================================
67 class MSEdge;
68 class MSJunction;
69 class MSEdgeControl;
70 class MSJunctionControl;
71 class MSInsertionControl;
73 class MSPersonControl;
74 class MSContainerControl;
75 class MSVehicle;
76 class MSRoute;
77 class MSLane;
78 class MSTLLogicControl;
79 class MSDetectorControl;
80 class ShapeContainer;
81 class BinaryInputDevice;
84 
85 typedef std::vector<MSEdge*> MSEdgeVector;
86 
87 // ===========================================================================
88 // class definitions
89 // ===========================================================================
94 class MSNet {
95 public:
112  };
113 
114  //typedef PedestrianRouterDijkstra<MSEdge, MSLane> MSPedestrianRouterDijkstra;
116 
117 
118 
119 public:
124  static MSNet* getInstance();
125 
126 
141  MSNet(MSVehicleControl* vc, MSEventControl* beginOfTimestepEvents,
142  MSEventControl* endOfTimestepEvents, MSEventControl* insertionEvents,
143  ShapeContainer* shapeCont = 0);
144 
145 
147  virtual ~MSNet();
148 
149 
164  void closeBuilding(MSEdgeControl* edges, MSJunctionControl* junctions,
165  SUMORouteLoaderControl* routeLoaders, MSTLLogicControl* tlc,
166  std::vector<SUMOTime> stateDumpTimes, std::vector<std::string> stateDumpFiles,
167  bool hasInternalLinks,
168  bool lefthand,
169  SUMOReal version);
170 
171 
175  bool hasPermissions() const {
176  return myHavePermissions;
177  }
178 
179 
182  myHavePermissions = true;
183  }
184 
185 
191  void addRestriction(const std::string& id, const SUMOVehicleClass svc, const SUMOReal speed);
192 
193 
199  const std::map<SUMOVehicleClass, SUMOReal>* getRestrictions(const std::string& id) const;
200 
201 
205  static void clearAll();
206 
207 
215  int simulate(SUMOTime start, SUMOTime stop);
216 
217 
221  void simulationStep();
222 
223 
225  void loadRoutes();
226 
227 
235  void closeSimulation(SUMOTime start);
236 
237 
243  SimulationState simulationState(SUMOTime stopTime) const;
244 
245 
249  static std::string getStateMessage(SimulationState state);
250 
251 
255  inline SUMOTime getCurrentTimeStep() const {
256  return myStep;
257  }
258 
259 
263  inline void setCurrentTimeStep(const SUMOTime step) {
264  myStep = step;
265  }
266 
267 
271  void writeOutput();
272 
273 
277  bool logSimulationDuration() const;
278 
279 
280 
282 
283 
288  void preSimStepOutput() const;
289 
290 
295  void postSimStepOutput() const;
296  //}
297 
298 
299 
302 
309  return *myVehicleControl;
310  }
311 
312 
322 
332 
333 
340  return *myEdges;
341  }
342 
343 
350  return *myInserter;
351  }
352 
353 
360  return *myDetectorControl;
361  }
362 
363 
370  return *myLogics;
371  }
372 
373 
380  return *myJunctions;
381  }
382 
383 
391  }
392 
393 
400  return myEndOfTimestepEvents;
401  }
402 
403 
410  return myInsertionEvents;
411  }
412 
413 
420  return *myShapeContainer;
421  }
422 
430 
433 
445  bool addBusStop(MSStoppingPlace* busStop);
446 
447 
452  MSStoppingPlace* getBusStop(const std::string& id) const;
453 
454 
460  std::string getBusStopID(const MSLane* lane, const SUMOReal pos) const;
462 
463 
466 
478  bool addContainerStop(MSStoppingPlace* containerStop);
479 
484  MSStoppingPlace* getContainerStop(const std::string& id) const;
485 
491  std::string getContainerStopID(const MSLane* lane, const SUMOReal pos) const;
493 
505  bool addChargingStation(MSChargingStation* chargingStation);
506 
511  MSChargingStation* getChargingStation(const std::string& id) const;
512 
518  std::string getChargingStationID(const MSLane* lane, const SUMOReal pos) const;
520 
521 
524 
547  };
548 
549 
554  public:
557 
559  virtual ~VehicleStateListener() { }
560 
565  virtual void vehicleStateChanged(const SUMOVehicle* const vehicle, VehicleState to) = 0;
566 
567  };
568 
569 
574 
575 
580 
581 
587  void informVehicleStateListener(const SUMOVehicle* const vehicle, VehicleState to);
589 
590 
591 
599  static SUMOReal getTravelTime(const MSEdge* const e, const SUMOVehicle* const v, SUMOReal t);
600 
601 
609  static SUMOReal getEffort(const MSEdge* const e, const SUMOVehicle* const v, SUMOReal t);
610 
611 
612  /* @brief get the router, initialize on first use
613  * @param[in] prohibited The vector of forbidden edges (optional)
614  */
616  const MSEdgeVector& prohibited = MSEdgeVector()) const;
618  const MSEdgeVector& prohibited = MSEdgeVector()) const;
619  MSPedestrianRouterDijkstra& getPedestrianRouter(const MSEdgeVector& prohibited = MSEdgeVector()) const;
620 
621 
625  const NamedRTree& getLanesRTree() const;
626 
628  bool hasInternalLinks() const {
629  return myHasInternalLinks;
630  }
631 
633  bool hasElevation() const {
634  return myHasElevation;
635  }
636 
638  bool lefthand() const {
639  return myLefthand;
640  }
641 
643  SUMOReal version() const {
644  return myVersion;
645  }
646 
647 protected:
649  bool checkElevation();
650 
651 protected:
653  static MSNet* myInstance;
654 
657 
660 
661 
662 
665 
693 
694 
695 
698 
701 
704 
707 
710 
712  long long int myVehiclesMoved;
713  //}
714 
715 
716 
719 
721  std::vector<SUMOTime> myStateDumpTimes;
723  std::vector<std::string> myStateDumpFiles;
725 
726 
727 
730 
732  std::map<std::string, std::map<SUMOVehicleClass, SUMOReal> > myRestrictions;
733 
736 
739 
742 
745 
748 
751 
754 
756  std::vector<VehicleStateListener*> myVehicleStateListeners;
757 
758 
759  /* @brief The router instance for routing by trigger and by traci
760  * @note MSDevice_Routing has its own instance since it uses a different weight function
761  * @note we provide one member for every switchable router type
762  * because the class structure makes it inconvenient to use a superclass*/
763  mutable bool myRouterTTInitialized;
767  mutable MSPedestrianRouterDijkstra* myPedestrianRouter;
768 
769 
771  mutable std::pair<bool, NamedRTree> myLanesRTree;
772 
773 
775  static const std::string STAGE_EVENTS;
776  static const std::string STAGE_MOVEMENTS;
777  static const std::string STAGE_LANECHANGE;
778  static const std::string STAGE_INSERTIONS;
779 
780 private:
782  MSNet(const MSNet&);
783 
785  MSNet& operator=(const MSNet&);
786 
787 
788 };
789 
790 
791 #endif
792 
793 /****************************************************************************/
794 
The vehicle has departed (was inserted into the network)
Definition: MSNet.h:530
AStarRouter< MSEdge, SUMOVehicle, prohibited_withPermissions< MSEdge, SUMOVehicle > > * myRouterTTAStar
Definition: MSNet.h:765
Computes the shortest path through a network using the Dijkstra algorithm.
bool lefthand() const
return whether the network was built for lefthand traffic
Definition: MSNet.h:638
void postSimStepOutput() const
Prints the statistics of the step at its end.
Definition: MSNet.cpp:722
Representation of a vehicle in the micro simulation.
Definition: MSVehicle.h:80
long long int SUMOTime
Definition: SUMOTime.h:43
Interface for objects listening to vehicle state changes.
Definition: MSNet.h:553
long mySimStepEnd
Definition: MSNet.h:706
void removeVehicleStateListener(VehicleStateListener *listener)
Removes a vehicle states listener.
Definition: MSNet.cpp:755
MSEventControl * myEndOfTimestepEvents
Controls events executed at the end of a time step;.
Definition: MSNet.h:685
static SUMOReal getEffort(const MSEdge *const e, const SUMOVehicle *const v, SUMOReal t)
Returns the effort to pass an edge.
Definition: MSNet.cpp:128
SUMOVehicleClass
Definition of vehicle classes to differ between different lane usage and authority types...
A lane area vehicles can halt at.
The simulation contains too many vehicles (.
Definition: MSNet.h:111
const std::map< SUMOVehicleClass, SUMOReal > * getRestrictions(const std::string &id) const
Returns the restrictions for an edge type If no restrictions are present, 0 is returned.
Definition: MSNet.cpp:292
MSVehicleControl * myVehicleControl
Controls vehicle building and deletion;.
Definition: MSNet.h:667
std::vector< MSEdge * > MSEdgeVector
Definition: MSNet.h:83
std::vector< SUMOTime > myStateDumpTimes
Times at which a state shall be written.
Definition: MSNet.h:721
The base class for an intersection.
Definition: MSJunction.h:64
DijkstraRouterEffort< MSEdge, SUMOVehicle, prohibited_withPermissions< MSEdge, SUMOVehicle > > * myRouterEffort
Definition: MSNet.h:766
bool hasInternalLinks() const
return whether the network contains internal links
Definition: MSNet.h:628
std::string getContainerStopID(const MSLane *lane, const SUMOReal pos) const
Returns the container stop close to the given position.
Definition: MSNet.cpp:809
int simulate(SUMOTime start, SUMOTime stop)
Simulates from timestep start to stop.
Definition: MSNet.cpp:302
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&#39;s Named objects.
Definition: NamedRTree.h:72
Computes the shortest path through a network using the A* algorithm.
Definition: AStarRouter.h:71
MSPedestrianRouterDijkstra & getPedestrianRouter(const MSEdgeVector &prohibited=MSEdgeVector()) const
Definition: MSNet.cpp:885
MSChargingStation * getChargingStation(const std::string &id) const
Returns the named charging station.
Definition: MSNet.cpp:828
bool addBusStop(MSStoppingPlace *busStop)
Adds a bus stop.
Definition: MSNet.cpp:774
MSPersonControl * myPersonControl
Controls person building and deletion;.
Definition: MSNet.h:669
void closeBuilding(MSEdgeControl *edges, MSJunctionControl *junctions, SUMORouteLoaderControl *routeLoaders, MSTLLogicControl *tlc, std::vector< SUMOTime > stateDumpTimes, std::vector< std::string > stateDumpFiles, bool hasInternalLinks, bool lefthand, SUMOReal version)
Closes the network&#39;s building process.
Definition: MSNet.cpp:214
static MSNet * getInstance()
Returns the pointer to the unique instance of MSNet (singleton).
Definition: MSNet.cpp:160
bool myHavePermissions
Whether the network contains edges which not all vehicles may pass.
Definition: MSNet.h:729
MSEdgeControl * myEdges
Controls edges, performs vehicle movement;.
Definition: MSNet.h:673
void setCurrentTimeStep(const SUMOTime step)
Sets the current simulation step (used by state loading)
Definition: MSNet.h:263
The final simulation step has been performed.
Definition: MSNet.h:103
std::vector< std::string > myStateDumpFiles
The names for the state files.
Definition: MSNet.h:723
bool myLogExecutionTime
Information whether the simulation duration shall be logged.
Definition: MSNet.h:700
Storage for geometrical objects.
static const std::string STAGE_LANECHANGE
Definition: MSNet.h:777
NamedObjectCont< MSStoppingPlace * > myContainerStopDict
Dictionary of container stops.
Definition: MSNet.h:750
Detectors container; responsible for string and output generation.
bool myLefthand
Whether the network was built for left-hand traffic.
Definition: MSNet.h:741
A storage for edge travel times and efforts.
SUMOTime getCurrentTimeStep() const
Returns the current simulation step.
Definition: MSNet.h:255
std::string getBusStopID(const MSLane *lane, const SUMOReal pos) const
Returns the bus stop close to the given position.
Definition: MSNet.cpp:786
void addVehicleStateListener(VehicleStateListener *listener)
Adds a vehicle states listener.
Definition: MSNet.cpp:747
SimulationState
Possible states of a simulation - running or stopped with different reasons.
Definition: MSNet.h:99
MSPedestrianRouterDijkstra * myPedestrianRouter
Definition: MSNet.h:767
The simulated network and simulation perfomer.
Definition: MSNet.h:94
Computes the shortest path through a network using the Dijkstra algorithm.
ShapeContainer * myShapeContainer
A container for geometrical shapes;.
Definition: MSNet.h:689
std::pair< bool, NamedRTree > myLanesRTree
An RTree structure holding lane IDs.
Definition: MSNet.h:771
Container for junctions; performs operations on all stored junctions.
DijkstraRouterTT< MSEdge, SUMOVehicle, prohibited_withPermissions< MSEdge, SUMOVehicle > > * myRouterTTDijkstra
Definition: MSNet.h:764
The vehicles starts to stop.
Definition: MSNet.h:544
A class that stores and controls tls and switching of their programs.
A road/street connecting two junctions.
Definition: MSEdge.h:80
long long int myVehiclesMoved
The overall number of vehicle movements.
Definition: MSNet.h:712
long mySimStepBegin
The last simulation step begin, end and duration.
Definition: MSNet.h:706
The simulation does not contain further vehicles.
Definition: MSNet.h:105
An error occured during the simulation step.
Definition: MSNet.h:109
void writeOutput()
Write netstate, summary and detector output.
Definition: MSNet.cpp:582
The vehicle got a new route.
Definition: MSNet.h:538
The vehicle arrived at his destination (is deleted)
Definition: MSNet.h:536
MSStoppingPlace * getBusStop(const std::string &id) const
Returns the named bus stop.
Definition: MSNet.cpp:780
The vehicles starts to park.
Definition: MSNet.h:540
MSInsertionControl * myInserter
Controls vehicle insertion;.
Definition: MSNet.h:679
Representation of a vehicle.
Definition: SUMOVehicle.h:65
SUMORouteLoaderControl * myRouteLoaders
Route loader for dynamic loading of routes.
Definition: MSNet.h:656
ShapeContainer & getShapeContainer()
Returns the shapes container.
Definition: MSNet.h:419
void closeSimulation(SUMOTime start)
Closes the simulation (all files, connections, etc.)
Definition: MSNet.cpp:353
bool myLogStepNumber
Information whether the number of the simulation step shall be logged.
Definition: MSNet.h:703
MSTLLogicControl & getTLSControl()
Returns the tls logics control.
Definition: MSNet.h:369
virtual MSContainerControl & getContainerControl()
Returns the container control.
Definition: MSNet.cpp:698
MSVehicleControl & getVehicleControl()
Returns the vehicle control.
Definition: MSNet.h:308
MSEventControl * getBeginOfTimestepEvents()
Returns the event control for events executed at the begin of a time step.
Definition: MSNet.h:389
static SUMOReal getTravelTime(const MSEdge *const e, const SUMOVehicle *const v, SUMOReal t)
Returns the travel time to pass an edge.
Definition: MSNet.cpp:142
MSDetectorControl * myDetectorControl
Controls detectors;.
Definition: MSNet.h:681
void setPermissionsFound()
Labels the network to contain vehicle class permissions.
Definition: MSNet.h:181
Stores edges and lanes, performs moving of vehicle.
Definition: MSEdgeControl.h:74
MSTLLogicControl * myLogics
Controls tls logics, realizes waiting on tls rules;.
Definition: MSNet.h:677
The connection to a client was closed by the client.
Definition: MSNet.h:107
The simulation is running.
Definition: MSNet.h:101
MSNet & operator=(const MSNet &)
Invalidated assignment operator.
The vehicle started to teleport.
Definition: MSNet.h:532
void preSimStepOutput() const
Prints the current step number.
Definition: MSNet.cpp:716
std::map< std::string, std::map< SUMOVehicleClass, SUMOReal > > myRestrictions
The vehicle class specific speed restrictions.
Definition: MSNet.h:732
PedestrianRouterDijkstra< MSEdge, MSLane, MSJunction, MSVehicle > MSPedestrianRouterDijkstra
Definition: MSNet.h:115
The vehicle ends to park.
Definition: MSNet.h:542
SUMOReal myVersion
the network version
Definition: MSNet.h:744
MSDetectorControl & getDetectorControl()
Returns the detector control.
Definition: MSNet.h:359
MSContainerControl * myContainerControl
Controls container building and deletion;.
Definition: MSNet.h:671
Inserts vehicles into the network when their departure time is reached.
VehicleState
Definition of a vehicle state.
Definition: MSNet.h:526
SUMOAbstractRouter< MSEdge, SUMOVehicle > & getRouterTT(const MSEdgeVector &prohibited=MSEdgeVector()) const
Definition: MSNet.cpp:847
MSEventControl * getEndOfTimestepEvents()
Returns the event control for events executed at the end of a time step.
Definition: MSNet.h:399
static const std::string STAGE_MOVEMENTS
Definition: MSNet.h:776
VehicleStateListener()
Constructor.
Definition: MSNet.h:556
The vehicle was built, but has not yet departed.
Definition: MSNet.h:528
std::vector< VehicleStateListener * > myVehicleStateListeners
Container for vehicle state listener.
Definition: MSNet.h:756
static MSNet * myInstance
Unique instance of MSNet.
Definition: MSNet.h:653
static void clearAll()
Clears all dictionaries.
Definition: MSNet.cpp:566
bool myRouterTTInitialized
Definition: MSNet.h:763
bool addContainerStop(MSStoppingPlace *containerStop)
Adds a container stop.
Definition: MSNet.cpp:799
bool addChargingStation(MSChargingStation *chargingStation)
Adds a chargingg station.
Definition: MSNet.cpp:822
SimulationState simulationState(SUMOTime stopTime) const
Called after a simulation step, this method returns the current simulation state. ...
Definition: MSNet.cpp:513
MSJunctionControl * myJunctions
Controls junctions, realizes right-of-way rules;.
Definition: MSNet.h:675
virtual MSPersonControl & getPersonControl()
Returns the person control.
Definition: MSNet.cpp:690
MSInsertionControl & getInsertionControl()
Returns the insertion control.
Definition: MSNet.h:349
bool checkElevation()
check all lanes for elevation data
Definition: MSNet.cpp:905
MSEventControl * myBeginOfTimestepEvents
Controls events executed at the begin of a time step;.
Definition: MSNet.h:683
virtual ~VehicleStateListener()
Destructor.
Definition: MSNet.h:559
MSEdgeWeightsStorage * myEdgeWeights
The net&#39;s knowledge about edge efforts/travel times;.
Definition: MSNet.h:691
MSStoppingPlace * getContainerStop(const std::string &id) const
Returns the named container stop.
Definition: MSNet.cpp:804
MSNet(MSVehicleControl *vc, MSEventControl *beginOfTimestepEvents, MSEventControl *endOfTimestepEvents, MSEventControl *insertionEvents, ShapeContainer *shapeCont=0)
Constructor.
Definition: MSNet.cpp:168
void addRestriction(const std::string &id, const SUMOVehicleClass svc, const SUMOReal speed)
Adds a restriction for an edge type.
Definition: MSNet.cpp:286
The vehicle ends to stop.
Definition: MSNet.h:546
MSEventControl * getInsertionEvents()
Returns the event control for insertion events.
Definition: MSNet.h:409
void informVehicleStateListener(const SUMOVehicle *const vehicle, VehicleState to)
Informs all added listeners about a vehicle&#39;s state change.
Definition: MSNet.cpp:764
const NamedRTree & getLanesRTree() const
Returns an RTree that contains lane IDs.
Definition: MSNet.cpp:895
SUMOReal version() const
return the network version
Definition: MSNet.h:643
long mySimBeginMillis
The overall simulation duration.
Definition: MSNet.h:709
virtual ~MSNet()
Destructor.
Definition: MSNet.cpp:244
bool myHasElevation
Whether the network contains elevation data.
Definition: MSNet.h:738
#define SUMOReal
Definition: config.h:213
static std::string getStateMessage(SimulationState state)
Returns the message to show if a certain state occurs.
Definition: MSNet.cpp:545
MSEdgeControl & getEdgeControl()
Returns the edge control.
Definition: MSNet.h:339
NamedObjectCont< MSChargingStation * > myChargingStationDict
Dictionary of charging Stations.
Definition: MSNet.h:753
bool logSimulationDuration() const
Returns whether duration shall be logged.
Definition: MSNet.cpp:684
MSJunctionControl & getJunctionControl()
Returns the junctions control.
Definition: MSNet.h:379
SUMOTime myStep
Current time step.
Definition: MSNet.h:659
std::string getChargingStationID(const MSLane *lane, const SUMOReal pos) const
Returns the charging station close to the given position.
Definition: MSNet.cpp:834
The class responsible for building and deletion of vehicles.
std::vector< MSEdge * > MSEdgeVector
Definition: MSEdge.h:77
void simulationStep()
Performs a single simulation step.
Definition: MSNet.cpp:420
bool hasPermissions() const
Returns whether the network has specific vehicle class permissions.
Definition: MSNet.h:175
void loadRoutes()
loads routes for the next few steps
Definition: MSNet.cpp:347
SUMOAbstractRouter< MSEdge, SUMOVehicle > & getRouterEffort(const MSEdgeVector &prohibited=MSEdgeVector()) const
Definition: MSNet.cpp:874
static const std::string STAGE_INSERTIONS
Definition: MSNet.h:778
MSEventControl * myInsertionEvents
Controls insertion events;.
Definition: MSNet.h:687
Representation of a lane in the micro simulation.
Definition: MSLane.h:77
long mySimStepDuration
Definition: MSNet.h:706
NamedObjectCont< MSStoppingPlace * > myBusStopDict
Dictionary of bus stops.
Definition: MSNet.h:747
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:534
bool hasElevation() const
return whether the network contains internal links
Definition: MSNet.h:633
bool myHasInternalLinks
Whether the network contains internal links/lanes/edges.
Definition: MSNet.h:735
MSEdgeWeightsStorage & getWeightsStorage()
Returns the net&#39;s internal edge travel times/efforts container.
Definition: MSNet.cpp:707
static const std::string STAGE_EVENTS
string constants for simstep stages
Definition: MSNet.h:775