SUMO - Simulation of Urban MObility
MSTransportableControl.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2018 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 /****************************************************************************/
18 // Stores all persons or containers in the net and handles their waiting for cars.
19 /****************************************************************************/
20 #ifndef MSTransportableControl_h
21 #define MSTransportableControl_h
22 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 #include <config.h>
28 
29 #include <vector>
30 #include <map>
31 #include "MSTransportable.h"
32 #include "MSVehicle.h"
33 
34 
35 // ===========================================================================
36 // class declarations
37 // ===========================================================================
38 class MSNet;
39 
40 
41 // ===========================================================================
42 // class definitions
43 // ===========================================================================
53 public:
55  typedef std::vector<MSTransportable*> TransportableVector;
56 
58  typedef std::map<std::string, MSTransportable*>::const_iterator constVehIt;
59 
60 
61 public:
64 
65 
67  virtual ~MSTransportableControl();
68 
69 
74  bool add(MSTransportable* transportable);
75 
76 
81  MSTransportable* get(const std::string& id) const;
82 
83 
85  virtual void erase(MSTransportable* transportable);
86 
88  void setWaitEnd(SUMOTime time, MSTransportable* transportable);
89 
91  void checkWaiting(MSNet* net, const SUMOTime time);
92 
94  void addWaiting(const MSEdge* edge, MSTransportable* person);
95 
103  bool boardAnyWaiting(MSEdge* edge, SUMOVehicle* vehicle, const SUMOVehicleParameter::Stop& stop, SUMOTime& timeToBoardNextPerson, SUMOTime& stopDuration);
104 
111  bool loadAnyWaiting(MSEdge* edge, SUMOVehicle* vehicle, const SUMOVehicleParameter::Stop& stop, SUMOTime& timeToLoadNextContainer, SUMOTime& stopDuration);
112 
114  bool hasTransportables() const;
115 
117  bool hasNonWaiting() const;
118 
120  int getActiveCount();
121 
123  void abortWaitingForVehicle();
124 
126  void abortWaiting(MSTransportable* t);
127 
135  std::mt19937* rng) const;
136 
143 
147  constVehIt loadedBegin() const {
148  return myTransportables.begin();
149  }
150 
151 
155  constVehIt loadedEnd() const {
156  return myTransportables.end();
157  }
158 
159 
163  int size() const {
164  return (int)myTransportables.size();
165  }
166 
168  void registerJammed() {
169  myJammedNumber++;
170  }
171 
174 
178  int getLoadedNumber() const {
179  return myLoadedNumber;
180  }
181 
182 
186  int getRunningNumber() const {
187  return myRunningNumber;
188  }
189 
193  int getJammedNumber() const {
194  return myJammedNumber;
195  }
196 
198 
199 protected:
201  std::map<std::string, MSTransportable*> myTransportables;
202 
204  std::map<SUMOTime, TransportableVector> myWaiting4Departure;
205 
207  std::map<SUMOTime, TransportableVector> myWaitingUntil;
208 
210  std::map<const MSEdge*, TransportableVector> myWaiting4Vehicle;
211 
214 
217 
220 
223 
226 
227 };
228 
229 
230 #endif
231 
232 /****************************************************************************/
void abortWaiting(MSTransportable *t)
aborts waiting stage of transportable
void addWaiting(const MSEdge *edge, MSTransportable *person)
adds a transportable to the list of transportables waiting for a vehicle on the specified edge ...
bool hasNonWaiting() const
checks whether any transportable is still engaged in walking / stopping
long long int SUMOTime
Definition: SUMOTime.h:36
std::map< std::string, MSTransportable * >::const_iterator constVehIt
Definition of the internal transportables map iterator.
int getActiveCount()
return the number of active transportable objects
int getLoadedNumber() const
Returns the number of build transportables.
std::map< SUMOTime, TransportableVector > myWaiting4Departure
Transportables waiting for departure.
void setWaitEnd(SUMOTime time, MSTransportable *transportable)
sets the arrival time for a waiting transportable
void registerJammed()
register a jammed transportable
virtual ~MSTransportableControl()
Destructor.
int size() const
Returns the number of known transportables.
std::map< std::string, MSTransportable * > myTransportables
all currently created transportables by id
std::map< const MSEdge *, TransportableVector > myWaiting4Vehicle
the lists of waiting transportables
virtual MSTransportable * buildContainer(const SUMOVehicleParameter *pars, MSVehicleType *vtype, MSTransportable::MSTransportablePlan *plan) const
Builds a new container.
int myLoadedNumber
The number of build transportables.
The simulated network and simulation perfomer.
Definition: MSNet.h:84
The car-following model and parameter.
Definition: MSVehicleType.h:66
virtual void erase(MSTransportable *transportable)
removes a single transportable
void abortWaitingForVehicle()
aborts the plan for any transportable that is still waiting for a ride
A road/street connecting two junctions.
Definition: MSEdge.h:75
std::vector< MSTransportable::Stage * > MSTransportablePlan
the structure holding the plan of a transportable
Representation of a vehicle.
Definition: SUMOVehicle.h:60
bool myHaveNewWaiting
whether a new transportable waiting for a vehicle has been added in the last step ...
constVehIt loadedBegin() const
Returns the begin of the internal transportables map.
bool hasTransportables() const
checks whether any transportable waits to finish her plan
int myJammedNumber
The number of jammed transportables.
bool loadAnyWaiting(MSEdge *edge, SUMOVehicle *vehicle, const SUMOVehicleParameter::Stop &stop, SUMOTime &timeToLoadNextContainer, SUMOTime &stopDuration)
load any applicable containers Loads any container that is waiting on that edge for the given vehicle...
int myWaitingForVehicleNumber
The number of transportables waiting for vehicles.
Structure representing possible vehicle parameter.
bool boardAnyWaiting(MSEdge *edge, SUMOVehicle *vehicle, const SUMOVehicleParameter::Stop &stop, SUMOTime &timeToBoardNextPerson, SUMOTime &stopDuration)
board any applicable persons Boards any people who wait on that edge for the given vehicle and remove...
Definition of vehicle stop (position and duration)
bool add(MSTransportable *transportable)
Adds a single transportable, returns false if an id clash occurred.
constVehIt loadedEnd() const
Returns the end of the internal transportables map.
void checkWaiting(MSNet *net, const SUMOTime time)
checks whether any transportables waiting time is over
std::vector< MSTransportable * > TransportableVector
Definition of a list of transportables.
virtual MSTransportable * buildPerson(const SUMOVehicleParameter *pars, MSVehicleType *vtype, MSTransportable::MSTransportablePlan *plan, std::mt19937 *rng) const
Builds a new person.
int myRunningNumber
The number of transportables within the network (build and inserted but not removed) ...
int getRunningNumber() const
Returns the number of build and inserted, but not yet deleted transportables.
std::map< SUMOTime, TransportableVector > myWaitingUntil
the lists of walking / stopping transportables
int getJammedNumber() const
Returns the number of times a transportables was jammed.