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-2017 German Aerospace Center (DLR) and others.
4 /****************************************************************************/
5 //
6 // This program and the accompanying materials
7 // are made available under the terms of the Eclipse Public License v2.0
8 // which accompanies this distribution, and is available at
9 // http://www.eclipse.org/legal/epl-v20.html
10 //
11 /****************************************************************************/
19 // Abstract base class for vehicle representations
20 /****************************************************************************/
21 #ifndef SUMOVehicle_h
22 #define SUMOVehicle_h
23 
24 
25 // ===========================================================================
26 // included modules
27 // ===========================================================================
28 #ifdef _MSC_VER
29 #include <windows_config.h>
30 #else
31 #include <config.h>
32 #endif
33 
34 #include <vector>
35 #include <typeinfo>
36 #include <utils/common/SUMOTime.h>
37 #include <utils/common/Named.h>
41 
42 
43 // ===========================================================================
44 // class declarations
45 // ===========================================================================
46 class MSVehicleType;
47 class MSRoute;
48 class MSEdge;
49 class MSLane;
50 class MSDevice;
51 class MSPerson;
52 class MSTransportable;
53 class MSParkingArea;
55 
56 typedef std::vector<const MSEdge*> ConstMSEdgeVector;
57 
58 
59 // ===========================================================================
60 // class definitions
61 // ===========================================================================
66 class SUMOVehicle {
67 public:
68 
69  // XXX: This definition was introduced to make the MSVehicle's previousSpeed
70  // available in the context of MSMoveReminder::notifyMove(). Another solution
71  // would be to modify notifyMove()'s interface to work with MSVehicle instead
72  // of SUMOVehicle (it is only called with MSVehicles!). Refs. #2579
76  virtual double getPreviousSpeed() const = 0;
77 
78 
80  virtual ~SUMOVehicle() {}
81 
85  virtual const std::string& getID() const = 0;
86 
90  virtual double getPositionOnLane() const = 0;
91 
95  virtual double getBackPositionOnLane(const MSLane* lane) const = 0;
96 
101  virtual double getLateralPositionOnLane() const = 0;
102 
106  virtual double getAngle() const = 0;
107 
115  virtual Position getPosition(const double offset = 0) const = 0;
116 
120  virtual double getMaxSpeed() const = 0;
121 
125  virtual double getSpeed() const = 0;
126 
130  virtual MSLane* getLane() const = 0;
131 
135  virtual const MSVehicleType& getVehicleType() const = 0;
136 
140  virtual SUMOVehicleClass getVClass() const = 0;
141 
143  virtual const MSRoute& getRoute() const = 0;
144 
152  virtual const MSEdge* succEdge(int nSuccs) const = 0;
153 
166  virtual bool replaceRouteEdges(ConstMSEdgeVector& edges, bool onInit = false, bool check = false, bool removeStops = true) = 0;
167 
169  virtual bool replaceRoute(const MSRoute* route, bool onInit = false, int offset = 0, bool addStops = true, bool removeStops = true) = 0;
170 
180  virtual void reroute(SUMOTime t, SUMOAbstractRouter<MSEdge, SUMOVehicle>& router, const bool onInit = false, const bool withTaz = false) = 0;
181 
187  virtual bool hasValidRoute(std::string& msg, const MSRoute* route = 0) const = 0;
188 
189 
193  virtual const ConstMSEdgeVector::const_iterator& getCurrentRouteEdge() const = 0;
194 
198  virtual double getAcceleration() const = 0;
199 
203  virtual double getSlope() const = 0;
204 
209  virtual const MSEdge* getEdge() const = 0;
210 
215  virtual const SUMOVehicleParameter& getParameter() const = 0;
216 
222  virtual void onDepart() = 0;
223 
227  virtual bool isOnRoad() const = 0;
228 
232  virtual bool isFrontOnLane(const MSLane*) const = 0;
233 
237  virtual bool isParking() const = 0;
238 
243  virtual bool isRemoteControlled() const = 0;
244 
248  virtual SUMOTime getDeparture() const = 0;
249 
253  virtual double getDepartPos() const = 0;
254 
259  virtual double getArrivalPos() const = 0;
260 
263  virtual void setArrivalPos(double arrivalPos) = 0;
264 
267  virtual bool hasDeparted() const = 0;
268 
271  virtual bool hasArrived() const = 0;
272 
276  virtual int getNumberReroutes() const = 0;
277 
281  virtual const std::vector<MSDevice*>& getDevices() const = 0;
282 
289  virtual void addPerson(MSTransportable* person) = 0;
290 
297  virtual void addContainer(MSTransportable* container) = 0;
298 
305  virtual bool addStop(const SUMOVehicleParameter::Stop& stopPar, std::string& errorMsg, SUMOTime untilOffset = 0, bool collision = false,
306  ConstMSEdgeVector::const_iterator* searchStart = 0) = 0;
307 
308 
313  virtual MSParkingArea* getNextParkingArea() = 0;
314 
321  virtual bool replaceParkingArea(MSParkingArea* parkingArea, std::string& errorMsg) = 0;
322 
326  virtual bool isStopped() const = 0;
327 
328 
331  virtual bool isStoppedTriggered() const = 0;
332 
334  virtual bool isStoppedInRange(double pos) const = 0;
335 
337  virtual MSDevice* getDevice(const std::type_info& type) const = 0;
338 
339 
340  virtual double getChosenSpeedFactor() const = 0;
341 
342  virtual void setChosenSpeedFactor(const double factor) = 0;
343 
344  virtual SUMOTime getWaitingTime() const = 0;
345 
346  virtual SUMOTime getAccumulatedWaitingTime() const = 0;
347 
348  virtual SUMOTime getDepartDelay() const = 0;
349 
351  virtual double getImpatience() const = 0;
352 
354  virtual bool isSelected() const = 0;
355 
357 
358 
360  virtual void saveState(OutputDevice& out) = 0;
361 
364  virtual void loadState(const SUMOSAXAttributes& attrs, const SUMOTime offset) = 0;
366 };
367 
368 
369 #endif
370 
371 /****************************************************************************/
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.
A lane area vehicles can halt at.
Definition: MSParkingArea.h:65
virtual bool hasDeparted() const =0
Returns whether this vehicle has departed.
virtual double getArrivalPos() const =0
Returns this vehicle&#39;s desired arrivalPos for its current route (may change on reroute) ...
virtual MSParkingArea * getNextParkingArea()=0
SUMOVehicleClass
Definition of vehicle classes to differ between different lane usage and authority types...
virtual const MSRoute & getRoute() const =0
Returns the current route.
virtual bool isStoppedTriggered() const =0
Returns whether the vehicle is at a stop and waiting for a person or container to continue...
virtual void onDepart()=0
Called when the vehicle is inserted into the network.
virtual bool replaceRoute(const MSRoute *route, bool onInit=false, int offset=0, bool addStops=true, bool removeStops=true)=0
Replaces the current route by the given one.
virtual const MSEdge * getEdge() const =0
Returns the edge the vehicle is currently at.
virtual bool replaceRouteEdges(ConstMSEdgeVector &edges, bool onInit=false, bool check=false, bool removeStops=true)=0
Replaces the current route by the given edges.
virtual MSLane * getLane() const =0
Returns the lane the vehicle is on.
virtual double getSlope() const =0
Returns the slope of the road at vehicle&#39;s position.
std::vector< const MSEdge * > ConstMSEdgeVector
Definition: MSEdge.h:78
virtual bool isParking() const =0
Returns the information whether the vehicle is parked.
The car-following model and parameter.
Definition: MSVehicleType.h:72
virtual bool isSelected() const =0
whether this vehicle is selected in the GUI
std::vector< const MSEdge * > ConstMSEdgeVector
Definition: SUMOVehicle.h:54
virtual void addContainer(MSTransportable *container)=0
Adds a container to this vehicle.
virtual const MSEdge * succEdge(int nSuccs) const =0
Returns the nSuccs&#39;th successor of edge the vehicle is currently at.
A road/street connecting two junctions.
Definition: MSEdge.h:80
virtual SUMOVehicleClass getVClass() const =0
Returns the vehicle&#39;s access class.
virtual const std::vector< MSDevice * > & getDevices() const =0
Returns this vehicle&#39;s devices.
virtual void setChosenSpeedFactor(const double factor)=0
virtual void saveState(OutputDevice &out)=0
Saves the states of a vehicle.
Representation of a vehicle.
Definition: SUMOVehicle.h:66
Encapsulated SAX-Attributes.
virtual int getNumberReroutes() const =0
Returns the number of new routes this vehicle got.
virtual bool hasValidRoute(std::string &msg, const MSRoute *route=0) const =0
Validates the current or given route.
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:45
virtual void reroute(SUMOTime t, SUMOAbstractRouter< MSEdge, SUMOVehicle > &router, const bool onInit=false, const bool withTaz=false)=0
Performs a rerouting using the given router.
virtual SUMOTime getAccumulatedWaitingTime() const =0
virtual bool isFrontOnLane(const MSLane *) const =0
Returns the information whether the front of the vehhicle is on the given lane.
virtual bool isRemoteControlled() const =0
Returns the information whether the vehicle is fully controlled via TraCI.
virtual bool isOnRoad() const =0
Returns the information whether the vehicle is on a road (is simulated)
virtual bool isStoppedInRange(double pos) const =0
Returns whether the vehicle is stoped in range of the given position.
virtual double getChosenSpeedFactor() const =0
virtual double getMaxSpeed() const =0
Returns the vehicle&#39;s maximum speed.
Abstract in-vehicle device.
Definition: MSDevice.h:70
virtual double getBackPositionOnLane(const MSLane *lane) const =0
Get the vehicle&#39;s back position along the given lane.
virtual double getDepartPos() const =0
Returns this vehicle&#39;s real departure position.
virtual SUMOTime getDepartDelay() const =0
Structure representing possible vehicle parameter.
virtual double getAngle() const =0
Get the vehicle&#39;s angle.
virtual SUMOTime getDeparture() const =0
Returns this vehicle&#39;s real departure time.
virtual bool hasArrived() const =0
Returns whether this vehicle has arrived.
virtual double getPositionOnLane() const =0
Get the vehicle&#39;s position along the lane.
virtual const SUMOVehicleParameter & getParameter() const =0
Returns the vehicle&#39;s parameter (including departure definition)
Definition of vehicle stop (position and duration)
virtual double getLateralPositionOnLane() const =0
Get the vehicle&#39;s lateral position on the lane.
virtual Position getPosition(const double offset=0) const =0
Return current position (x/y, cartesian)
virtual SUMOTime getWaitingTime() const =0
virtual void addPerson(MSTransportable *person)=0
Adds a person to this vehicle.
virtual double getImpatience() const =0
Returns this vehicles impatience.
virtual void setArrivalPos(double arrivalPos)=0
Sets this vehicle&#39;s desired arrivalPos for its current route.
virtual bool isStopped() const =0
Returns whether the vehicle is at a stop.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:70
long long int SUMOTime
Definition: TraCIDefs.h:51
virtual MSDevice * getDevice(const std::type_info &type) const =0
Returns a device of the given type if it exists or 0.
virtual bool replaceParkingArea(MSParkingArea *parkingArea, std::string &errorMsg)=0
Replaces a stop.
virtual const ConstMSEdgeVector::const_iterator & getCurrentRouteEdge() const =0
Returns an iterator pointing to the current edge in this vehicles route.
virtual double getSpeed() const =0
Returns the vehicle&#39;s current speed.
Representation of a lane in the micro simulation.
Definition: MSLane.h:77
virtual double getPreviousSpeed() const =0
Returns the vehicle&#39;s previous speed.
virtual ~SUMOVehicle()
Destructor.
Definition: SUMOVehicle.h:80
virtual const std::string & getID() const =0
Get the vehicle&#39;s ID.
virtual void loadState(const SUMOSAXAttributes &attrs, const SUMOTime offset)=0
Loads the state of this vehicle from the given description.
virtual double getAcceleration() const =0
Returns the vehicle&#39;s acceleration.
virtual const MSVehicleType & getVehicleType() const =0
Returns the vehicle&#39;s type.