SUMOVehicle Class Reference
#include <SUMOVehicle.h>
Detailed Description
Representation of a vehicle.Definition at line 52 of file SUMOVehicle.h.
Public Member Functions | |
| virtual SUMOReal | adaptMaxSpeed (SUMOReal referenceSpeed)=0 |
| Adapt the vehicle's maximum speed depending on the reference speed. | |
| virtual const std::string & | getID () const =0 throw () |
| Get the vehicle's position along the lane. | |
| virtual SUMOReal | getMaxSpeed () const =0 |
| Returns the vehicle's maximum speed. | |
| virtual SUMOReal | getPositionOnLane () const =0 throw () |
| Get the vehicle's position along the lane. | |
| virtual const MSRoute & | getRoute () const =0 |
| Returns the current route. | |
| virtual SUMOReal | getSpeed () const =0 throw () |
| Returns the vehicle's current speed. | |
| virtual const MSVehicleType & | getVehicleType () const =0 |
| Returns the vehicle's type. | |
| virtual bool | replaceRoute (const MSEdgeVector &edges, SUMOTime simTime, bool onInit=false)=0 |
| Replaces the current route by the given edges. | |
| virtual const MSEdge * | succEdge (unsigned int nSuccs) const =0 throw () |
| Returns the nSuccs'th successor of edge the vehicle is currently at. | |
Member Function Documentation
| virtual SUMOReal SUMOVehicle::adaptMaxSpeed | ( | SUMOReal | referenceSpeed | ) | [pure virtual] |
Adapt the vehicle's maximum speed depending on the reference speed.
- Parameters:
-
[in] the maximum speed on the edge
- Returns:
- The vehicle's new maximum speed
Implemented in MSVehicle.
| virtual const std::string& SUMOVehicle::getID | ( | ) | const throw () [pure virtual] |
Get the vehicle's position along the lane.
- Returns:
- The position of the vehicle (in m from the lane's begin)
Implemented in MSVehicle.
| virtual SUMOReal SUMOVehicle::getMaxSpeed | ( | ) | const [pure virtual] |
Returns the vehicle's maximum speed.
- Returns:
- The vehicle's maximum speed
Implemented in MSVehicle.
Referenced by MSDevice_Routing::getEffort().
| virtual SUMOReal SUMOVehicle::getPositionOnLane | ( | ) | const throw () [pure virtual] |
Get the vehicle's position along the lane.
- Returns:
- The position of the vehicle (in m from the lane's begin)
Implemented in MSVehicle.
| virtual const MSRoute& SUMOVehicle::getRoute | ( | ) | const [pure virtual] |
Returns the current route.
Implemented in MSVehicle.
Referenced by MSTriggeredRerouter::getCurrentReroute(), MSTriggeredRerouter::hasCurrentReroute(), and MSTriggeredRerouter::reroute().
| virtual SUMOReal SUMOVehicle::getSpeed | ( | ) | const throw () [pure virtual] |
| virtual const MSVehicleType& SUMOVehicle::getVehicleType | ( | ) | const [pure virtual] |
Returns the vehicle's type.
- Returns:
- The vehicle's type
Implemented in MSVehicle.
Referenced by MSLane::succLinkSec().
| virtual bool SUMOVehicle::replaceRoute | ( | const MSEdgeVector & | edges, | |
| SUMOTime | simTime, | |||
| bool | onInit = false | |||
| ) | [pure virtual] |
Replaces the current route by the given edges.
Implemented in MSVehicle.
Referenced by MSTriggeredRerouter::reroute().
| virtual const MSEdge* SUMOVehicle::succEdge | ( | unsigned int | nSuccs | ) | const throw () [pure virtual] |
Returns the nSuccs'th successor of edge the vehicle is currently at.
If the rest of the route (counted from the current edge) than nSuccs, 0 is returned.
- Parameters:
-
[in] nSuccs The number of edge to look forward
- Returns:
- The nSuccs'th following edge in the vehicle's route
Implemented in MSVehicle.
Referenced by MSLane::succLinkSec().
The documentation for this class was generated from the following file:
