Eclipse SUMO - Simulation of Urban MObility
SUMOVehicle.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-2022 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials are made available under the
5 // terms of the Eclipse Public License 2.0 which is available at
6 // https://www.eclipse.org/legal/epl-2.0/
7 // This Source Code may also be made available under the following Secondary
8 // Licenses when the conditions for such availability set forth in the Eclipse
9 // Public License 2.0 are satisfied: GNU General Public License, version 2
10 // or later which is available at
11 // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13 /****************************************************************************/
20 // Abstract base class for vehicle representations
21 /****************************************************************************/
22 #pragma once
23 #include <config.h>
24 
25 #include <vector>
26 #include <typeinfo>
27 #include <utils/common/SUMOTime.h>
28 #include <utils/common/Named.h>
33 
34 
35 // ===========================================================================
36 // class declarations
37 // ===========================================================================
38 class MSRoute;
39 class MSEdge;
40 class MSLane;
41 class MSPerson;
42 class MSStop;
43 class MSTransportable;
44 class MSParkingArea;
45 class MSStoppingPlace;
46 class MSVehicleDevice;
47 class SUMOSAXAttributes;
48 class EnergyParams;
49 
50 typedef std::vector<const MSEdge*> ConstMSEdgeVector;
51 
52 
53 // ===========================================================================
54 // class definitions
55 // ===========================================================================
61 public:
62  typedef long long int NumericalID;
63 
65  SUMOVehicle(const std::string& id) : SUMOTrafficObject(id) {}
66 
68  virtual ~SUMOVehicle() {}
69 
74  virtual double getLateralPositionOnLane() const = 0;
75 
79  virtual double getAngle() const = 0;
80 
82  virtual const MSRoute& getRoute() const = 0;
83 
85  virtual int getRoutePosition() const = 0;
86 
94  virtual const MSEdge* succEdge(int nSuccs) const = 0;
95 
101  virtual const MSEdge* getRerouteOrigin() const = 0;
102 
115  virtual bool replaceRouteEdges(ConstMSEdgeVector& edges, double cost, double savings, const std::string& info, bool onInit = false, bool check = false, bool removeStops = true, std::string* msgReturn = nullptr) = 0;
116 
118  virtual bool replaceRoute(const MSRoute* route, const std::string& info, bool onInit = false, int offset = 0, bool addStops = true, bool removeStops = true, std::string* msgReturn = nullptr) = 0;
119 
129  virtual void reroute(SUMOTime t, const std::string& info, SUMOAbstractRouter<MSEdge, SUMOVehicle>& router, const bool onInit = false, const bool withTaz = false, const bool silent = false) = 0;
130 
136  virtual bool hasValidRoute(std::string& msg, const MSRoute* route = 0) const = 0;
138  virtual bool hasValidRouteStart(std::string& msg) = 0;
139 
141  virtual int getRouteValidity(bool update = true, bool silent = false, std::string* msgReturn = nullptr) = 0;
142 
146  virtual const ConstMSEdgeVector::const_iterator& getCurrentRouteEdge() const = 0;
147 
152  virtual const EnergyParams* getEmissionParameters() const = 0;
153 
156  virtual void replaceParameter(const SUMOVehicleParameter* newParameter) = 0;
157 
163  virtual void onDepart() = 0;
164 
168  virtual bool isOnRoad() const = 0;
169 
173  virtual bool isIdling() const = 0;
174 
178  virtual bool isFrontOnLane(const MSLane*) const = 0;
179 
183  virtual bool isParking() const = 0;
184 
189  virtual bool isRemoteControlled() const = 0;
190 
195  virtual bool wasRemoteControlled(SUMOTime lookBack = DELTA_T) const = 0;
196 
200  virtual SUMOTime getDeparture() const = 0;
201 
205  virtual double getDepartPos() const = 0;
206 
211  virtual double getArrivalPos() const = 0;
212 
215  virtual void setArrivalPos(double arrivalPos) = 0;
216 
219  virtual bool hasDeparted() const = 0;
220 
224  virtual double getOdometer() const = 0;
225 
229  virtual int getNumberReroutes() const = 0;
230 
232  virtual bool allowsBoarding(MSTransportable* t) const = 0;
233 
238  virtual void addTransportable(MSTransportable* transportable) = 0;
239 
243  virtual int getPersonNumber() const = 0;
244 
248  virtual std::vector<std::string> getPersonIDList() const = 0;
249 
253  virtual int getContainerNumber() const = 0;
254 
256  virtual void removeTransportable(MSTransportable* t) = 0;
257 
259  virtual const std::vector<MSTransportable*>& getPersons() const = 0;
260 
262  virtual const std::vector<MSTransportable*>& getContainers() const = 0;
263 
270  virtual bool addStop(const SUMOVehicleParameter::Stop& stopPar, std::string& errorMsg, SUMOTime untilOffset = 0, bool collision = false,
271  ConstMSEdgeVector::const_iterator* searchStart = 0) = 0;
272 
274  virtual std::vector<std::pair<int, double> > getStopIndices() const = 0;
275 
277  virtual bool isLineStop(double position) const = 0;
278 
280  virtual bool abortNextStop(int nextStopIndex = 0) = 0;
281 
282 
288 
295  virtual bool replaceParkingArea(MSParkingArea* parkingArea, std::string& errorMsg) = 0;
296 
298  virtual SUMOTime remainingStopDuration() const = 0;
299 
302  virtual bool isStoppedTriggered() const = 0;
303 
305  virtual bool isStoppedInRange(const double pos, const double tolerance) const = 0;
306 
308  virtual bool stopsAt(MSStoppingPlace* stop) const = 0;
309 
311  virtual bool stopsAtEdge(const MSEdge* edge) const = 0;
312 
316  virtual bool hasStops() const = 0;
317 
322  virtual const std::list<MSStop>& getStops() const = 0;
323 
328  virtual MSStop& getNextStop() = 0;
329 
332 
339  virtual bool addTraciStop(SUMOVehicleParameter::Stop stop, std::string& errorMsg) = 0;
340 
341  virtual void setChosenSpeedFactor(const double factor) = 0;
342 
343  virtual SUMOTime getAccumulatedWaitingTime() const = 0;
344 
345  virtual SUMOTime getDepartDelay() const = 0;
346 
347  virtual SUMOTime getTimeLoss() const = 0;
348 
350  virtual double getBrakeGap(bool delayed = false) const = 0;
351 
353  virtual double getImpatience() const = 0;
354 
358  virtual const std::vector<MSVehicleDevice*>& getDevices() const = 0;
359 
361  virtual MSVehicleDevice* getDevice(const std::type_info& type) const = 0;
362 
364  virtual int getRNGIndex() const = 0;
365 
367  // (especially fast comparison in maps which need vehicles as keys)
368  virtual NumericalID getNumericalID() const = 0;
369 
371  virtual double getLength() const = 0;
372 
374 
375  virtual void rememberBlockedParkingArea(const MSParkingArea* pa, bool local) = 0;
376  virtual SUMOTime sawBlockedParkingArea(const MSParkingArea* pa, bool local) const = 0;
377  virtual void rememberParkingAreaScore(const MSParkingArea* pa, const std::string& score) = 0;
378  virtual void resetParkingAreaScores() = 0;
379  virtual int getNumberParkingReroutes() const = 0;
380  virtual void setNumberParkingReroutes(int value) = 0;
382 
384 
385 
387  virtual void saveState(OutputDevice& out) = 0;
388 
391  virtual void loadState(const SUMOSAXAttributes& attrs, const SUMOTime offset) = 0;
393 };
std::vector< const MSEdge * > ConstMSEdgeVector
Definition: MSEdge.h:74
SUMOTime DELTA_T
Definition: SUMOTime.cpp:37
long long int SUMOTime
Definition: SUMOTime.h:32
std::vector< const MSEdge * > ConstMSEdgeVector
Definition: SUMOVehicle.h:48
An upper class for objects with additional parameters.
Definition: EnergyParams.h:41
A road/street connecting two junctions.
Definition: MSEdge.h:77
Representation of a lane in the micro simulation.
Definition: MSLane.h:82
A lane area vehicles can halt at.
Definition: MSParkingArea.h:58
Definition: MSStop.h:44
A lane area vehicles can halt at.
Abstract in-vehicle device.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
Encapsulated SAX-Attributes.
Representation of a vehicle, person, or container.
Representation of a vehicle.
Definition: SUMOVehicle.h:60
virtual bool replaceRouteEdges(ConstMSEdgeVector &edges, double cost, double savings, const std::string &info, bool onInit=false, bool check=false, bool removeStops=true, std::string *msgReturn=nullptr)=0
Replaces the current route by the given edges.
virtual bool hasValidRoute(std::string &msg, const MSRoute *route=0) const =0
Validates the current or given route.
virtual void removeTransportable(MSTransportable *t)=0
removes a person or container
virtual std::vector< std::pair< int, double > > getStopIndices() const =0
return list of route indices and stop positions for the remaining stops
virtual const MSRoute & getRoute() const =0
Returns the current route.
virtual MSParkingArea * getNextParkingArea()=0
virtual std::vector< std::string > getPersonIDList() const =0
Returns the list of persons.
virtual double getLateralPositionOnLane() const =0
Get the vehicle's lateral position on the lane.
virtual void reroute(SUMOTime t, const std::string &info, SUMOAbstractRouter< MSEdge, SUMOVehicle > &router, const bool onInit=false, const bool withTaz=false, const bool silent=false)=0
Performs a rerouting using the given router.
virtual bool stopsAtEdge(const MSEdge *edge) const =0
Returns whether the vehicle stops at the given edge.
virtual void rememberParkingAreaScore(const MSParkingArea *pa, const std::string &score)=0
virtual int getRouteValidity(bool update=true, bool silent=false, std::string *msgReturn=nullptr)=0
computes validity attributes for the current route
virtual bool replaceParkingArea(MSParkingArea *parkingArea, std::string &errorMsg)=0
Replaces a stop.
virtual const std::list< MSStop > & getStops() const =0
virtual bool wasRemoteControlled(SUMOTime lookBack=DELTA_T) const =0
Returns the information whether the vehicle is fully controlled via TraCI.
virtual bool addStop(const SUMOVehicleParameter::Stop &stopPar, std::string &errorMsg, SUMOTime untilOffset=0, bool collision=false, ConstMSEdgeVector::const_iterator *searchStart=0)=0
Adds a stop.
virtual MSVehicleDevice * getDevice(const std::type_info &type) const =0
Returns a device of the given type if it exists or 0.
virtual const std::vector< MSTransportable * > & getContainers() const =0
retrieve riding containers
virtual const EnergyParams * getEmissionParameters() const =0
Returns the vehicle's emission model parameter.
virtual bool hasStops() const =0
Returns whether the vehicle has to stop somewhere.
virtual SUMOTime remainingStopDuration() const =0
Returns the remaining stop duration for a stopped vehicle or 0.
virtual SUMOTime getTimeLoss() const =0
virtual SUMOTime getAccumulatedWaitingTime() const =0
SUMOVehicle(const std::string &id)
Constructor.
Definition: SUMOVehicle.h:65
virtual bool stopsAt(MSStoppingPlace *stop) const =0
Returns whether the vehicle stops at the given stopping place.
virtual SUMOTime getDeparture() const =0
Returns this vehicle's real departure time.
virtual void setChosenSpeedFactor(const double factor)=0
virtual void onDepart()=0
Called when the vehicle is inserted into the network.
virtual ~SUMOVehicle()
Destructor.
Definition: SUMOVehicle.h:68
virtual int getRNGIndex() const =0
virtual MSStop & getNextStop()=0
long long int NumericalID
Definition: SUMOVehicle.h:62
virtual int getPersonNumber() const =0
Returns the number of persons.
virtual bool hasDeparted() const =0
Returns whether this vehicle has departed.
virtual double getOdometer() const =0
Returns the distance that was already driven by this vehicle.
virtual bool replaceRoute(const MSRoute *route, const std::string &info, bool onInit=false, int offset=0, bool addStops=true, bool removeStops=true, std::string *msgReturn=nullptr)=0
Replaces the current route by the given one.
virtual double getLength() const =0
Returns the vehicles's length.
virtual int getNumberReroutes() const =0
Returns the number of new routes this vehicle got.
virtual bool isStoppedTriggered() const =0
Returns whether the vehicle is at a stop and waiting for a person or container to continue.
virtual const std::vector< MSTransportable * > & getPersons() const =0
retrieve riding persons
virtual int getNumberParkingReroutes() const =0
virtual void saveState(OutputDevice &out)=0
Saves the states of a vehicle.
virtual bool isOnRoad() const =0
Returns the information whether the vehicle is on a road (is simulated)
virtual const ConstMSEdgeVector::const_iterator & getCurrentRouteEdge() const =0
Returns an iterator pointing to the current edge in this vehicles route.
virtual void addTransportable(MSTransportable *transportable)=0
Adds a person or container to this vehicle.
virtual bool isFrontOnLane(const MSLane *) const =0
Returns the information whether the front of the vehhicle is on the given lane.
virtual bool hasValidRouteStart(std::string &msg)=0
checks wether the vehicle can depart on the first edge
virtual bool isParking() const =0
Returns the information whether the vehicle is parked.
virtual NumericalID getNumericalID() const =0
return the numerical ID which is only for internal usage
virtual double getArrivalPos() const =0
Returns this vehicle's desired arrivalPos for its current route (may change on reroute)
virtual void replaceParameter(const SUMOVehicleParameter *newParameter)=0
Replaces the vehicle's parameter.
virtual int getContainerNumber() const =0
Returns the number of containers.
virtual void loadState(const SUMOSAXAttributes &attrs, const SUMOTime offset)=0
Loads the state of this vehicle from the given description.
virtual double getDepartPos() const =0
Returns this vehicle's real departure position.
virtual const MSEdge * getRerouteOrigin() const =0
Returns the starting point for reroutes (usually the current edge)
virtual void rememberBlockedParkingArea(const MSParkingArea *pa, bool local)=0
virtual bool isIdling() const =0
Returns whether the vehicle is idling (waiting to re-enter the net.
virtual SUMOTime getDepartDelay() const =0
virtual SUMOTime sawBlockedParkingArea(const MSParkingArea *pa, bool local) const =0
virtual bool isRemoteControlled() const =0
Returns the information whether the vehicle is fully controlled via TraCI.
virtual void resetParkingAreaScores()=0
virtual bool isStoppedInRange(const double pos, const double tolerance) const =0
Returns whether the vehicle is stopped in the range of the given position.
virtual double getImpatience() const =0
Returns this vehicles impatience.
virtual double getBrakeGap(bool delayed=false) const =0
get distance for coming to a stop (used for rerouting checks)
virtual bool isLineStop(double position) const =0
returns whether the vehicle serves a public transport line that serves the given stop
virtual int getRoutePosition() const =0
return index of edge within route
virtual const MSEdge * succEdge(int nSuccs) const =0
Returns the nSuccs'th successor of edge the vehicle is currently at.
virtual const std::vector< MSVehicleDevice * > & getDevices() const =0
Returns this vehicle's devices.
virtual void setArrivalPos(double arrivalPos)=0
Sets this vehicle's desired arrivalPos for its current route.
virtual double getAngle() const =0
Get the vehicle's angle.
virtual const SUMOVehicleParameter::Stop * getNextStopParameter() const =0
Returns parameters of the next stop or nullptr.
virtual bool addTraciStop(SUMOVehicleParameter::Stop stop, std::string &errorMsg)=0
virtual void setNumberParkingReroutes(int value)=0
virtual bool allowsBoarding(MSTransportable *t) const =0
whether the given transportable is allowed to board this vehicle
virtual bool abortNextStop(int nextStopIndex=0)=0
deletes the next stop at the given index if it exists
Definition of vehicle stop (position and duration)
Structure representing possible vehicle parameter.