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>
61 
62 
63 // ===========================================================================
64 // class declarations
65 // ===========================================================================
66 class MSEdge;
67 class MSJunction;
68 class MSEdgeControl;
69 class MSJunctionControl;
70 class MSInsertionControl;
72 class MSPersonControl;
73 class MSVehicle;
74 class MSRoute;
75 class MSLane;
76 class MSTLLogicControl;
77 class MSDetectorControl;
78 class ShapeContainer;
79 class BinaryInputDevice;
81 class SUMOVehicle;
82 
83 
84 // ===========================================================================
85 // class definitions
86 // ===========================================================================
91 class MSNet {
92 public:
109  };
110 
111  //typedef PedestrianRouterDijkstra<MSEdge, MSLane> MSPedestrianRouterDijkstra;
113 
114 
115 
116 public:
121  static MSNet* getInstance();
122 
123 
138  MSNet(MSVehicleControl* vc, MSEventControl* beginOfTimestepEvents,
139  MSEventControl* endOfTimestepEvents, MSEventControl* insertionEvents,
140  ShapeContainer* shapeCont = 0);
141 
142 
144  virtual ~MSNet();
145 
146 
158  void closeBuilding(MSEdgeControl* edges, MSJunctionControl* junctions,
159  SUMORouteLoaderControl* routeLoaders, MSTLLogicControl* tlc,
160  std::vector<SUMOTime> stateDumpTimes, std::vector<std::string> stateDumpFiles);
161 
162 
166  static void clearAll();
167 
168 
176  int simulate(SUMOTime start, SUMOTime stop);
177 
178 
182  void simulationStep();
183 
184 
186  void loadRoutes();
187 
188 
196  void closeSimulation(SUMOTime start);
197 
198 
204  SimulationState simulationState(SUMOTime stopTime) const;
205 
206 
210  static std::string getStateMessage(SimulationState state);
211 
212 
216  inline SUMOTime getCurrentTimeStep() const {
217  return myStep;
218  }
219 
220 
224  inline void setCurrentTimeStep(const SUMOTime step) {
225  myStep = step;
226  }
227 
228 
232  void writeOutput();
233 
234 
238  bool logSimulationDuration() const;
239 
240 
241 
243 
244 
249  void preSimStepOutput() const;
250 
251 
256  void postSimStepOutput() const;
257  //}
258 
259 
260 
263 
270  return *myVehicleControl;
271  }
272 
273 
283 
284 
291  return *myEdges;
292  }
293 
294 
301  return *myInserter;
302  }
303 
304 
311  return *myDetectorControl;
312  }
313 
314 
321  return *myLogics;
322  }
323 
324 
331  return *myJunctions;
332  }
333 
334 
341  return *myBeginOfTimestepEvents;
342  }
343 
344 
351  return *myEndOfTimestepEvents;
352  }
353 
354 
361  return *myInsertionEvents;
362  }
363 
364 
371  return *myShapeContainer;
372  }
373 
374 
382 
383 
384 
387 
399  bool addBusStop(MSBusStop* busStop);
400 
401 
406  MSBusStop* getBusStop(const std::string& id) const;
407 
408 
414  std::string getBusStopID(const MSLane* lane, const SUMOReal pos) const;
416 
417 
418 
421 
444  };
445 
446 
451  public:
454 
456  virtual ~VehicleStateListener() { }
457 
462  virtual void vehicleStateChanged(const SUMOVehicle* const vehicle, VehicleState to) = 0;
463 
464  };
465 
466 
470  void addVehicleStateListener(VehicleStateListener* listener);
471 
472 
476  void removeVehicleStateListener(VehicleStateListener* listener);
477 
478 
484  void informVehicleStateListener(const SUMOVehicle* const vehicle, VehicleState to);
486 
487 
488 
496  static SUMOReal getTravelTime(const MSEdge* const e, const SUMOVehicle* const v, SUMOReal t);
497 
498 
506  static SUMOReal getEffort(const MSEdge* const e, const SUMOVehicle* const v, SUMOReal t);
507 
508 
509  /* @brief get the router, initialize on first use
510  * @param[in] prohibited The vector of forbidden edges (optional)
511  */
513  const std::vector<MSEdge*>& prohibited = std::vector<MSEdge*>()) const;
515  const std::vector<MSEdge*>& prohibited = std::vector<MSEdge*>()) const;
516  MSPedestrianRouterDijkstra& getPedestrianRouter(const std::vector<MSEdge*>& prohibited = std::vector<MSEdge*>()) const;
517 
518 
522  const NamedRTree& getLanesRTree() const;
523 
524 
525 protected:
527  static MSNet* myInstance;
528 
531 
534 
535 
536 
539 
565 
566 
567 
570 
573 
576 
579 
582 
585  //}
586 
587 
588 
591 
593  std::vector<SUMOTime> myStateDumpTimes;
595  std::vector<std::string> myStateDumpFiles;
597 
598 
599 
602 
605 
607  std::vector<VehicleStateListener*> myVehicleStateListeners;
608 
609 
610  /* @brief The router instance for routing by trigger and by traci
611  * @note MSDevice_Routing has its own instance since it uses a different weight function
612  * @note we provide one member for every switchable router type
613  * because the class structure makes it inconvenient to use a superclass*/
614  mutable bool myRouterTTInitialized;
619 
620 
622  mutable std::pair<bool, NamedRTree> myLanesRTree;
623 
624 
626  static const std::string STAGE_EVENTS;
627  static const std::string STAGE_MOVEMENTS;
628  static const std::string STAGE_LANECHANGE;
629  static const std::string STAGE_INSERTIONS;
630 
631 private:
633  MSNet(const MSNet&);
634 
636  MSNet& operator=(const MSNet&);
637 
638 
639 };
640 
641 
642 #endif
643 
644 /****************************************************************************/
645 
The vehicle has departed (was inserted into the network)
Definition: MSNet.h:427
void postSimStepOutput() const
Prints the statistics of the step at its end.
Definition: MSNet.cpp:651
Representation of a vehicle in the micro simulation.
Definition: MSVehicle.h:77
Interface for objects listening to vehicle state changes.
Definition: MSNet.h:450
long mySimStepEnd
Definition: MSNet.h:578
void removeVehicleStateListener(VehicleStateListener *listener)
Removes a vehicle states listener.
Definition: MSNet.cpp:684
MSEventControl * myEndOfTimestepEvents
Controls events executed at the end of a time step;.
Definition: MSNet.h:557
static SUMOReal getEffort(const MSEdge *const e, const SUMOVehicle *const v, SUMOReal t)
Returns the effort to pass an edge.
Definition: MSNet.cpp:127
The simulation contains too many vehicles (.
Definition: MSNet.h:108
MSEventControl & getEndOfTimestepEvents()
Returns the event control for events executed at the end of a time step.
Definition: MSNet.h:350
MSVehicleControl * myVehicleControl
Controls vehicle building and deletion;.
Definition: MSNet.h:541
std::vector< SUMOTime > myStateDumpTimes
Times at which a state shall be written.
Definition: MSNet.h:593
The base class for an intersection.
Definition: MSJunction.h:58
PedestrianRouterDijkstra< MSEdge, MSLane, MSJunction > MSPedestrianRouterDijkstra
Definition: MSNet.h:112
int simulate(SUMOTime start, SUMOTime stop)
Simulates from timestep start to stop.
Definition: MSNet.cpp:269
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:72
MSPersonControl * myPersonControl
Controls person building and deletion;.
Definition: MSNet.h:543
static MSNet * getInstance()
Returns the pointer to the unique instance of MSNet (singleton).
Definition: MSNet.cpp:159
MSEdgeControl * myEdges
Controls edges, performs vehicle movement;.
Definition: MSNet.h:545
void setCurrentTimeStep(const SUMOTime step)
Sets the current simulation step (used by state loading)
Definition: MSNet.h:224
The final simulation step has been performed.
Definition: MSNet.h:100
std::vector< std::string > myStateDumpFiles
The names for the state files.
Definition: MSNet.h:595
bool myLogExecutionTime
Information whether the simulation duration shall be logged.
Definition: MSNet.h:572
Storage for geometrical objects.
static const std::string STAGE_LANECHANGE
Definition: MSNet.h:628
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:216
SUMOAbstractRouter< MSEdge, SUMOVehicle > & getRouterEffort(const std::vector< MSEdge * > &prohibited=std::vector< MSEdge * >()) const
Definition: MSNet.cpp:755
std::string getBusStopID(const MSLane *lane, const SUMOReal pos) const
Returns the bus stop close to the given position.
Definition: MSNet.cpp:715
void addVehicleStateListener(VehicleStateListener *listener)
Adds a vehicle states listener.
Definition: MSNet.cpp:676
SimulationState
Possible states of a simulation - running or stopped with different reasons.
Definition: MSNet.h:96
MSPedestrianRouterDijkstra * myPedestrianRouter
Definition: MSNet.h:618
The simulated network and simulation perfomer.
Definition: MSNet.h:91
SUMOLong myVehiclesMoved
The overall number of vehicle movements.
Definition: MSNet.h:584
ShapeContainer * myShapeContainer
A container for geometrical shapes;.
Definition: MSNet.h:561
std::pair< bool, NamedRTree > myLanesRTree
An RTree structure holding lane IDs.
Definition: MSNet.h:622
Container for junctions; performs operations on all stored junctions.
bool addBusStop(MSBusStop *busStop)
Adds a bus stop.
Definition: MSNet.cpp:703
The vehicles starts to stop.
Definition: MSNet.h:441
A class that stores and controls tls and switching of their programs.
A road/street connecting two junctions.
Definition: MSEdge.h:74
long mySimStepBegin
The last simulation step begin, end and duration.
Definition: MSNet.h:578
The simulation does not contain further vehicles.
Definition: MSNet.h:102
An error occured during the simulation step.
Definition: MSNet.h:106
void writeOutput()
Write netstate, summary and detector output.
Definition: MSNet.cpp:528
The vehicle got a new route.
Definition: MSNet.h:435
The vehicle arrived at his destination (is deleted)
Definition: MSNet.h:433
The vehicles starts to park.
Definition: MSNet.h:437
MSInsertionControl * myInserter
Controls vehicle insertion;.
Definition: MSNet.h:551
Representation of a vehicle.
Definition: SUMOVehicle.h:64
SUMORouteLoaderControl * myRouteLoaders
Route loader for dynamic loading of routes.
Definition: MSNet.h:530
ShapeContainer & getShapeContainer()
Returns the shapes container.
Definition: MSNet.h:370
void closeSimulation(SUMOTime start)
Closes the simulation (all files, connections, etc.)
Definition: MSNet.cpp:320
bool myLogStepNumber
Information whether the number of the simulation step shall be logged.
Definition: MSNet.h:575
MSTLLogicControl & getTLSControl()
Returns the tls logics control.
Definition: MSNet.h:320
A lane area vehicles can halt at.
Definition: MSBusStop.h:64
MSVehicleControl & getVehicleControl()
Returns the vehicle control.
Definition: MSNet.h:269
static SUMOReal getTravelTime(const MSEdge *const e, const SUMOVehicle *const v, SUMOReal t)
Returns the travel time to pass an edge.
Definition: MSNet.cpp:141
MSDetectorControl * myDetectorControl
Controls detectors;.
Definition: MSNet.h:553
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:549
The connection to a client was closed by the client.
Definition: MSNet.h:104
DijkstraRouterTT_ByProxi< MSEdge, SUMOVehicle, prohibited_withRestrictions< MSEdge, SUMOVehicle > > * myRouterTTDijkstra
Definition: MSNet.h:615
The simulation is running.
Definition: MSNet.h:98
MSNet & operator=(const MSNet &)
Invalidated assignment operator.
The vehicle started to teleport.
Definition: MSNet.h:429
#define SUMOLong
Definition: config.h:212
void preSimStepOutput() const
Prints the current step number.
Definition: MSNet.cpp:645
MSBusStop * getBusStop(const std::string &id) const
Returns the named bus stop.
Definition: MSNet.cpp:709
The vehicle ends to park.
Definition: MSNet.h:439
AStarRouterTT_ByProxi< MSEdge, SUMOVehicle, prohibited_withRestrictions< MSEdge, SUMOVehicle > > * myRouterTTAStar
Definition: MSNet.h:616
MSDetectorControl & getDetectorControl()
Returns the detector control.
Definition: MSNet.h:310
Inserts vehicles into the network when their departure time is reached.
VehicleState
Definition of a vehicle state.
Definition: MSNet.h:423
static const std::string STAGE_MOVEMENTS
Definition: MSNet.h:627
VehicleStateListener()
Constructor.
Definition: MSNet.h:453
The vehicle was built, but has not yet departed.
Definition: MSNet.h:425
std::vector< VehicleStateListener * > myVehicleStateListeners
Container for vehicle state listener.
Definition: MSNet.h:607
static MSNet * myInstance
Unique instance of MSNet.
Definition: MSNet.h:527
MSEventControl & getInsertionEvents()
Returns the event control for insertion events.
Definition: MSNet.h:360
static void clearAll()
Clears all dictionaries.
Definition: MSNet.cpp:513
bool myRouterTTInitialized
Definition: MSNet.h:614
SimulationState simulationState(SUMOTime stopTime) const
Called after a simulation step, this method returns the current simulation state. ...
Definition: MSNet.cpp:461
MSJunctionControl * myJunctions
Controls junctions, realizes right-of-way rules;.
Definition: MSNet.h:547
virtual MSPersonControl & getPersonControl()
Returns the person control.
Definition: MSNet.cpp:627
MSInsertionControl & getInsertionControl()
Returns the insertion control.
Definition: MSNet.h:300
MSEventControl * myBeginOfTimestepEvents
Controls events executed at the begin of a time step;.
Definition: MSNet.h:555
virtual ~VehicleStateListener()
Destructor.
Definition: MSNet.h:456
MSEdgeWeightsStorage * myEdgeWeights
The net's knowledge about edge efforts/travel times;.
Definition: MSNet.h:563
MSNet(MSVehicleControl *vc, MSEventControl *beginOfTimestepEvents, MSEventControl *endOfTimestepEvents, MSEventControl *insertionEvents, ShapeContainer *shapeCont=0)
Constructor.
Definition: MSNet.cpp:167
The vehicle ends to stop.
Definition: MSNet.h:443
SUMOAbstractRouter< MSEdge, SUMOVehicle > & getRouterTT(const std::vector< MSEdge * > &prohibited=std::vector< MSEdge * >()) const
Definition: MSNet.cpp:728
void informVehicleStateListener(const SUMOVehicle *const vehicle, VehicleState to)
Informs all added listeners about a vehicle's state change.
Definition: MSNet.cpp:693
const NamedRTree & getLanesRTree() const
Returns an RTree that contains lane IDs.
Definition: MSNet.cpp:776
long mySimBeginMillis
The overall simulation duration.
Definition: MSNet.h:581
virtual ~MSNet()
Destructor.
Definition: MSNet.cpp:235
#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:492
MSEdgeControl & getEdgeControl()
Returns the edge control.
Definition: MSNet.h:290
bool logSimulationDuration() const
Returns whether duration shall be logged.
Definition: MSNet.cpp:621
MSJunctionControl & getJunctionControl()
Returns the junctions control.
Definition: MSNet.h:330
SUMOTime myStep
Current time step.
Definition: MSNet.h:533
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:212
NamedObjectCont< MSBusStop * > myBusStopDict
Dictionary of bus stops.
Definition: MSNet.h:604
void simulationStep()
Performs a single simulation step.
Definition: MSNet.cpp:373
MSEventControl & getBeginOfTimestepEvents()
Returns the event control for events executed at the begin of a time step.
Definition: MSNet.h:340
void loadRoutes()
loads routes for the next few steps
Definition: MSNet.cpp:314
MSPedestrianRouterDijkstra & getPedestrianRouter(const std::vector< MSEdge * > &prohibited=std::vector< MSEdge * >()) const
Definition: MSNet.cpp:766
static const std::string STAGE_INSERTIONS
Definition: MSNet.h:629
MSEventControl * myInsertionEvents
Controls insertion events;.
Definition: MSNet.h:559
int myTooManyVehicles
Storage for maximum vehicle number.
Definition: MSNet.h:601
Representation of a lane in the micro simulation.
Definition: MSLane.h:77
long mySimStepDuration
Definition: MSNet.h:578
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:431
MSEdgeWeightsStorage & getWeightsStorage()
Returns the net's internal edge travel times/efforts container.
Definition: MSNet.cpp:636
DijkstraRouterEffort_ByProxi< MSEdge, SUMOVehicle, prohibited_withRestrictions< MSEdge, SUMOVehicle > > * myRouterEffort
Definition: MSNet.h:617
static const std::string STAGE_EVENTS
string constants for simstep stages
Definition: MSNet.h:626