SUMO - Simulation of Urban MObility
MSBaseVehicle Class Referenceabstract

The base class for microscopic and mesoscopic vehicles. More...

#include <MSBaseVehicle.h>

Inheritance diagram for MSBaseVehicle:
Inheritance graph
Collaboration diagram for MSBaseVehicle:
Collaboration graph

Public Types

typedef Named::NamedLikeComparatorIdLess< SUMOVehicleComparatorIdLess
 

Public Member Functions

virtual void activateReminders (const MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
 "Activates" all current move reminder More...
 
virtual void addContainer (MSTransportable *container)
 Adds a container to this vehicle. More...
 
virtual void addPerson (MSTransportable *person)
 Adds a person to this vehicle. More...
 
void addReminder (MSMoveReminder *rem)
 Adds a MoveReminder dynamically. More...
 
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. More...
 
void addStops (const bool ignoreStopErrors)
 Adds stops to the built vehicle. More...
 
void createDevice (const std::string &deviceName)
 create device of the given type More...
 
virtual double getAcceleration () const
 Returns the vehicle's acceleration. More...
 
virtual SUMOTime getAccumulatedWaitingTime () const =0
 
virtual double getAngle () const =0
 Get the vehicle's angle. More...
 
virtual double getArrivalPos () const
 Returns this vehicle's desired arrivalPos for its current route (may change on reroute) More...
 
virtual double getBackPositionOnLane (const MSLane *lane) const =0
 Get the vehicle's back position along the given lane. More...
 
double getChosenSpeedFactor () const
 Returns the precomputed factor by which the driver wants to be faster than the speed limit. More...
 
const MSRouteIteratorgetCurrentRouteEdge () const
 Returns an iterator pointing to the current edge in this vehicles route. More...
 
SUMOTime getDepartDelay () const
 Returns the depart delay. More...
 
double getDepartPos () const
 Returns this vehicle's real departure position. More...
 
SUMOTime getDeparture () const
 Returns this vehicle's real departure time. More...
 
MSDevicegetDevice (const std::type_info &type) const
 Returns a device of the given type if it exists or 0. More...
 
std::string getDeviceParameter (const std::string &deviceName, const std::string &key) const
 try to retrieve the given parameter from any of the vehicles devices, raise InvalidArgument if no device parameter by that name exists More...
 
const std::vector< MSDevice * > & getDevices () const
 Returns this vehicle's devices. More...
 
const MSEdgegetEdge () const
 Returns the edge the vehicle is currently at. More...
 
const std::string & getID () const
 Returns the name of the vehicle. More...
 
double getImpatience () const
 Returns this vehicles impatience. More...
 
virtual MSLanegetLane () const =0
 Returns the lane the vehicle is on. More...
 
virtual double getLateralPositionOnLane () const
 Get the vehicle's lateral position on the lane. More...
 
double getLength () const
 Returns the vehicle's length. More...
 
double getMaxSpeed () const
 Returns the maximum speed. More...
 
virtual MSParkingAreagetNextParkingArea ()=0
 
int getNumberReroutes () const
 Returns the number of new routes this vehicle got. More...
 
const SUMOVehicleParametergetParameter () const
 Returns the vehicle's parameter (including departure definition) More...
 
virtual Position getPosition (const double offset=0) const =0
 Return current position (x/y, cartesian) More...
 
virtual double getPositionOnLane () const =0
 Get the vehicle's position along the lane. More...
 
double getPreviousSpeed () const
 Returns the vehicle's previous speed. More...
 
virtual const MSEdgegetRerouteOrigin () const
 Returns the starting point for reroutes (usually the current edge) More...
 
const MSRoutegetRoute () const
 Returns the current route. More...
 
MSVehicleTypegetSingularType ()
 Replaces the current vehicle type with a new one used by this vehicle only. More...
 
virtual double getSlope () const
 Returns the slope of the road at vehicle's position. More...
 
virtual double getSpeed () const =0
 Returns the vehicle's current speed. More...
 
SUMOVehicleClass getVClass () const
 Returns the vehicle's access class. More...
 
const MSVehicleTypegetVehicleType () const
 Returns the vehicle's type definition. More...
 
virtual SUMOTime getWaitingTime () const =0
 
double getWidth () const
 Returns the vehicle's width. More...
 
virtual bool hasArrived () const
 Returns whether this vehicle has already arived (by default this is true if the vehicle has reached its final edge) More...
 
bool hasDeparted () const
 Returns whether this vehicle has already departed. More...
 
bool hasDevice (const std::string &deviceName) const
 check whether the vehicle is equiped with a device of the given type More...
 
bool hasValidRoute (std::string &msg, const MSRoute *route=0) const
 Validates the current or given route. More...
 
virtual bool isFrontOnLane (const MSLane *) const
 Returns the information whether the front of the vehhicle is on the given lane. More...
 
virtual bool isOnRoad () const
 Returns the information whether the vehicle is on a road (is simulated) More...
 
virtual bool isParking () const =0
 Returns the information whether the vehicle is parked. More...
 
virtual bool isRemoteControlled () const
 Returns the information whether the vehicle is fully controlled via TraCI. More...
 
virtual bool isSelected () const
 whether this vehicle is selected in the GUI More...
 
virtual bool isStopped () const =0
 Returns whether the vehicle is at a stop. More...
 
virtual bool isStoppedInRange (double pos) const =0
 Returns whether the vehicle is stoped in range of the given position. More...
 
virtual bool isStoppedTriggered () const =0
 Returns whether the vehicle is at a stop and waiting for a person or container to continue. More...
 
 MSBaseVehicle (SUMOVehicleParameter *pars, const MSRoute *route, MSVehicleType *type, const double speedFactor)
 Constructor. More...
 
void onDepart ()
 Called when the vehicle is inserted into the network. More...
 
void removeReminder (MSMoveReminder *rem)
 Removes a MoveReminder dynamically. More...
 
virtual bool replaceParkingArea (MSParkingArea *parkingArea, std::string &errorMsg)=0
 Replaces a stop. More...
 
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. More...
 
bool replaceRouteEdges (ConstMSEdgeVector &edges, bool onInit=false, bool check=false, bool removeStops=true)
 Replaces the current route by the given edges. More...
 
void replaceVehicleType (MSVehicleType *type)
 Replaces the current vehicle type by the one given. More...
 
void reroute (SUMOTime t, SUMOAbstractRouter< MSEdge, SUMOVehicle > &router, const bool onInit=false, const bool withTaz=false)
 Performs a rerouting using the given router. More...
 
virtual void setArrivalPos (double arrivalPos)
 Sets this vehicle's desired arrivalPos for its current route. More...
 
void setChosenSpeedFactor (const double factor)
 Returns the precomputed factor by which the driver wants to be faster than the speed limit. More...
 
void setDeviceParameter (const std::string &deviceName, const std::string &key, const std::string &value)
 try to set the given parameter from any of the vehicles devices, raise InvalidArgument if no device parameter by that name exists More...
 
const MSEdgesuccEdge (int nSuccs) const
 Returns the nSuccs'th successor of edge the vehicle is currently at. More...
 
virtual ~MSBaseVehicle ()
 Destructor. More...
 
state io
virtual void saveState (OutputDevice &out)
 Saves the (common) state of a vehicle. More...
 
state io
virtual void loadState (const SUMOSAXAttributes &attrs, const SUMOTime offset)=0
 Loads the state of this vehicle from the given description. More...
 

Protected Member Functions

void calculateArrivalParams ()
 (Re-)Calculates the arrival position and lane from the vehicle parameters More...
 
virtual const ConstMSEdgeVector getStopEdges () const =0
 Returns the list of still pending stop edges. More...
 

Protected Attributes

int myArrivalLane
 The destination lane where the vehicle stops. More...
 
double myArrivalPos
 The position on the destination lane where the vehicle stops. More...
 
double myChosenSpeedFactor
 A precomputed factor by which the driver wants to be faster than the speed limit. More...
 
MSRouteIterator myCurrEdge
 Iterator to current route-edge. More...
 
double myDepartPos
 The real depart position. More...
 
SUMOTime myDeparture
 The real departure time. More...
 
std::vector< MSDevice * > myDevices
 The devices this vehicle has. More...
 
int myNumberReroutes
 The number of reroutings. More...
 
const SUMOVehicleParametermyParameter
 This vehicle's parameter. More...
 
const MSRoutemyRoute
 This vehicle's route. More...
 
MSVehicleTypemyType
 This vehicle's type. More...
 

Static Protected Attributes

static const SUMOTime NOT_YET_DEPARTED = SUMOTime_MAX
 

Private Member Functions

MSBaseVehicleoperator= (const MSBaseVehicle &s)
 invalidated assignment operator More...
 

Friends

class GUIBaseVehicle
 

Move reminder structures

typedef std::vector< std::pair< MSMoveReminder *, double > > MoveReminderCont
 Definition of a move reminder container. More...
 
MoveReminderCont myMoveReminders
 Currently relevant move reminders. More...
 

Detailed Description

The base class for microscopic and mesoscopic vehicles.

Definition at line 55 of file MSBaseVehicle.h.

Member Typedef Documentation

◆ ComparatorIdLess

◆ MoveReminderCont

typedef std::vector< std::pair<MSMoveReminder*, double> > MSBaseVehicle::MoveReminderCont
protected

Definition of a move reminder container.

Definition at line 468 of file MSBaseVehicle.h.

Constructor & Destructor Documentation

◆ MSBaseVehicle()

MSBaseVehicle::MSBaseVehicle ( SUMOVehicleParameter pars,
const MSRoute route,
MSVehicleType type,
const double  speedFactor 
)

Constructor.

Parameters
[in]parsThe vehicle description
[in]routeThe vehicle's route
[in]typeThe vehicle's type
[in]speedFactorThe factor for driven lane's speed limits
Exceptions
ProcessErrorIf a value is wrong

Definition at line 69 of file MSBaseVehicle.cpp.

References MSRoute::addReference(), MSRoute::begin(), MSDevice::buildVehicleDevices(), calculateArrivalParams(), MSGlobals::gCheckRoutes, MSRoute::getLastEdge(), hasValidRoute(), SUMOVehicleParameter::id, MSEdge::isTazConnector(), myDevices, myMoveReminders, myRoute, SUMOVehicleParameter::parametersSet, VEHPARS_FORCE_REROUTE, and SUMOVehicleParameter::wasSet().

◆ ~MSBaseVehicle()

MSBaseVehicle::~MSBaseVehicle ( )
virtual

Member Function Documentation

◆ activateReminders()

void MSBaseVehicle::activateReminders ( const MSMoveReminder::Notification  reason,
const MSLane enteredLane = 0 
)
virtual

"Activates" all current move reminder

For all move reminder stored in "myMoveReminders", their method "MSMoveReminder::notifyEnter" is called.

Parameters
[in]reasonThe reason for changing the reminders' states
[in]enteredLaneThe lane, which is entered (if applicable)
See also
MSMoveReminder
MSMoveReminder::notifyEnter
MSMoveReminder::Notification

Reimplemented in MSVehicle.

Definition at line 376 of file MSBaseVehicle.cpp.

References myMoveReminders.

Referenced by getDevices(), MESegment::receive(), and MELoop::teleportVehicle().

◆ addContainer()

void MSBaseVehicle::addContainer ( MSTransportable container)
virtual

Adds a container to this vehicle.

The default implementation does nothing since containers are not supported by default

Parameters
[in]containerThe container to add

Implements SUMOVehicle.

Reimplemented in MSVehicle.

Definition at line 316 of file MSBaseVehicle.cpp.

References getID(), and MSTransportable::getID().

Referenced by getDevices().

◆ addPerson()

void MSBaseVehicle::addPerson ( MSTransportable person)
virtual

Adds a person to this vehicle.

The default implementation does nothing since persons are not supported by default

Parameters
[in]personThe person to add

Implements SUMOVehicle.

Reimplemented in MSVehicle.

Definition at line 311 of file MSBaseVehicle.cpp.

References getID(), and MSTransportable::getID().

Referenced by getDevices().

◆ addReminder()

void MSBaseVehicle::addReminder ( MSMoveReminder rem)

Adds a MoveReminder dynamically.

Parameters
[in]remthe reminder to add
See also
MSMoveReminder

Definition at line 349 of file MSBaseVehicle.cpp.

References myMoveReminders.

Referenced by MSVehicle::adaptLaneEntering2MoveReminder(), MESegment::addReminders(), MSVehicle::enterLaneAtInsertion(), MSVehicle::enterLaneAtLaneChange(), getDevices(), and MSVehicle::processNextStop().

◆ addStop()

virtual bool SUMOVehicle::addStop ( const SUMOVehicleParameter::Stop stopPar,
std::string &  errorMsg,
SUMOTime  untilOffset = 0,
bool  collision = false,
ConstMSEdgeVector::const_iterator *  searchStart = 0 
)
pure virtualinherited

Adds a stop.

The stop is put into the sorted list.

Parameters
[in]stopThe stop to add
Returns
Whether the stop could be added

Implemented in MSVehicle, and MEVehicle.

Referenced by addStops(), and SUMOVehicle::~SUMOVehicle().

◆ addStops()

void MSBaseVehicle::addStops ( const bool  ignoreStopErrors)

Adds stops to the built vehicle.

This code needs to be separated from the MSBaseVehicle constructor since it is not allowed to call virtual functions from a constructor

Parameters
[in]ignoreStopErrorswhether invalid stops trigger a warning only

Definition at line 473 of file MSBaseVehicle.cpp.

References SUMOVehicle::addStop(), SUMOVehicleParameter::depart, MSRoute::getStops(), myParameter, myRoute, SUMOVehicleParameter::repetitionOffset, SUMOVehicleParameter::repetitionsDone, SUMOVehicleParameter::stops, and WRITE_WARNING.

Referenced by MEVehicleControl::buildVehicle(), GUIMEVehicleControl::buildVehicle(), GUIVehicleControl::buildVehicle(), MSVehicleControl::buildVehicle(), MEVehicle::getBlockTimeSeconds(), MSVehicle::replaceRoute(), and setChosenSpeedFactor().

◆ calculateArrivalParams()

◆ createDevice()

void MSBaseVehicle::createDevice ( const std::string &  deviceName)

◆ getAcceleration()

double MSBaseVehicle::getAcceleration ( ) const
virtual

Returns the vehicle's acceleration.

This default implementation returns always 0.

Returns
The acceleration

Implements SUMOVehicle.

Reimplemented in MSVehicle.

Definition at line 280 of file MSBaseVehicle.cpp.

Referenced by getCurrentRouteEdge().

◆ getAccumulatedWaitingTime()

virtual SUMOTime SUMOVehicle::getAccumulatedWaitingTime ( ) const
pure virtualinherited

◆ getAngle()

virtual double SUMOVehicle::getAngle ( ) const
pure virtualinherited

Get the vehicle's angle.

Returns
The angle of the vehicle (in degree)

Implemented in MSVehicle, GUIMEVehicle, GUIVehicle, and MEVehicle.

Referenced by MSDevice_Battery::notifyMove(), MSEmissionExport::write(), MSFCDExport::write(), MSFullExport::writeVehicles(), and SUMOVehicle::~SUMOVehicle().

◆ getArrivalPos()

virtual double MSBaseVehicle::getArrivalPos ( ) const
inlinevirtual

Returns this vehicle's desired arrivalPos for its current route (may change on reroute)

Returns
This vehicle's real arrivalPos

Implements SUMOVehicle.

Definition at line 269 of file MSBaseVehicle.h.

References myArrivalPos.

Referenced by MSLCM_SL2015::_wantsChangeSublane().

◆ getBackPositionOnLane()

virtual double SUMOVehicle::getBackPositionOnLane ( const MSLane lane) const
pure virtualinherited

Get the vehicle's back position along the given lane.

Returns
The position of the vehicle (in m from the given lane's begin)

Implemented in MSVehicle, and MEVehicle.

Referenced by MSInductLoop::notifyEnter(), and SUMOVehicle::~SUMOVehicle().

◆ getChosenSpeedFactor()

double MSBaseVehicle::getChosenSpeedFactor ( ) const
inlinevirtual

Returns the precomputed factor by which the driver wants to be faster than the speed limit.

Returns
Speed limit factor

Implements SUMOVehicle.

Definition at line 377 of file MSBaseVehicle.h.

References myChosenSpeedFactor.

Referenced by GUIMEVehicle::getParameterWindow(), GUIVehicle::getParameterWindow(), and libsumo::Vehicle::getSpeedFactor().

◆ getCurrentRouteEdge()

const MSRouteIterator& MSBaseVehicle::getCurrentRouteEdge ( ) const
inlinevirtual

Returns an iterator pointing to the current edge in this vehicles route.

Returns
The current route pointer

Implements SUMOVehicle.

Definition at line 192 of file MSBaseVehicle.h.

References getAcceleration(), getSlope(), myCurrEdge, onDepart(), replaceRouteEdges(), and reroute().

Referenced by MSDevice_SSM::findSurroundingVehicles(), libsumo::Vehicle::getDistance(), and libsumo::Vehicle::moveToXY().

◆ getDepartDelay()

SUMOTime MSBaseVehicle::getDepartDelay ( ) const
inlinevirtual

◆ getDepartPos()

double MSBaseVehicle::getDepartPos ( ) const
inlinevirtual

Returns this vehicle's real departure position.

Returns
This vehicle's real departure position

Implements SUMOVehicle.

Definition at line 261 of file MSBaseVehicle.h.

References myDepartPos.

Referenced by libsumo::Vehicle::getDistance().

◆ getDeparture()

SUMOTime MSBaseVehicle::getDeparture ( ) const
inlinevirtual

Returns this vehicle's real departure time.

Returns
This vehicle's real departure time

Implements SUMOVehicle.

Definition at line 248 of file MSBaseVehicle.h.

References myDeparture.

Referenced by getDepartDelay(), and MSVehicle::Influencer::postProcessRemoteControl().

◆ getDevice()

MSDevice * MSBaseVehicle::getDevice ( const std::type_info &  type) const
virtual

Returns a device of the given type if it exists or 0.

Implements SUMOVehicle.

Definition at line 447 of file MSBaseVehicle.cpp.

References myDevices.

Referenced by createDevice(), GUIBaseVehicle::drawOnPos(), MSVehicle::resumeFromStopping(), setChosenSpeedFactor(), and MSBatteryExport::write().

◆ getDeviceParameter()

std::string MSBaseVehicle::getDeviceParameter ( const std::string &  deviceName,
const std::string &  key 
) const

try to retrieve the given parameter from any of the vehicles devices, raise InvalidArgument if no device parameter by that name exists

Definition at line 527 of file MSBaseVehicle.cpp.

References myDevices.

Referenced by libsumo::Vehicle::getParameter().

◆ getDevices()

const std::vector<MSDevice*>& MSBaseVehicle::getDevices ( ) const
inlinevirtual

Returns this vehicle's devices.

Returns
This vehicle's devices

Implements SUMOVehicle.

Definition at line 302 of file MSBaseVehicle.h.

References activateReminders(), addContainer(), addPerson(), addReminder(), hasValidRoute(), myDevices, and removeReminder().

◆ getEdge()

◆ getID()

const std::string & MSBaseVehicle::getID ( ) const
virtual

Returns the name of the vehicle.

Implements SUMOVehicle.

Definition at line 121 of file MSBaseVehicle.cpp.

References SUMOVehicleParameter::id, and myParameter.

Referenced by MSLCM_LC2013::_patchSpeed(), MSLCM_SL2015::_patchSpeed(), MSLCM_LC2013::_wantsChange(), MSLCM_SL2015::_wantsChangeSublane(), MSLaneChangerSublane::abortLCManeuver(), MSVehicle::adaptToLeader(), MSVehicle::adaptToLeaders(), MSVehicleTransfer::add(), addContainer(), MSPModel_Striping::addCrossingVehs(), MSLCM_SL2015::addLCSpeedAdvice(), addPerson(), MSVehicle::addTraciStopAtStoppingPlace(), calculateArrivalParams(), MSLaneChangerSublane::change(), MSLaneChanger::change(), MSLCM_SL2015::changed(), MSLaneChanger::changeOpposite(), MELoop::changeSegment(), libsumo::Vehicle::changeTarget(), MSLaneChanger::checkChange(), MSLaneChangerSublane::checkChangeSublane(), MSLane::checkFailure(), MSLane::checkForPedestrians(), MSVehicleTransfer::checkInsertions(), MSVehicle::checkLinkLeader(), MSVehicle::checkRewindLinkLanes(), MSLCM_SL2015::checkStrategicChange(), MSLaneChanger::checkTraCICommands(), MSAbstractLaneChangeModel::checkTraCICommands(), MSDevice_SSM::classifyEncounter(), MSLCM_SL2015::commitManoeuvre(), MSVehicle::computeAngle(), MSLCM_SL2015::computeSpeedLat(), MSDevice_SSM::computeSSMs(), MSLaneChanger::continueChange(), MSLaneChangerSublane::continueChangeSublane(), MSLCM_SL2015::decideDirection(), MSLane::detectCollisionBetween(), MSLane::detectCollisions(), MSLane::detectPedestrianJunctionCollision(), MSDevice_SSM::Encounter::Encounter(), MSCalibrator::execute(), MSVehicle::executeMove(), MSLane::executeMovements(), MSLaneChanger::findCandidate(), MSDevice_SSM::findFoeConflictLane(), MSDevice_SSM::findSurroundingVehicles(), MSVehicle::getBackPosition(), MSVehicle::getBackPositionOnLane(), MSVehicle::getCenterOnEdge(), MSLane::getFirstVehicleInformation(), MSLane::getFollower(), MSLane::getFollowersOnConsecutive(), MSLane::getLastVehicleInformation(), MSVehicle::getLatOffset(), MSLane::getLeader(), MSLink::getLeaderInfo(), MSLane::getLeaderOnConsecutive(), MSLaneChangerSublane::getLeaders(), MSLane::getLeadersOnConsecutive(), MSLane::getOppositeFollower(), MSLane::getOppositeLeader(), GUIMEVehicle::getParameterWindow(), GUIVehicle::getParameterWindow(), MSLane::getPartialBehind(), MSLaneChanger::getRealFollower(), MSLaneChanger::getRealLeader(), MSAbstractLaneChangeModel::getShadowLane(), getSingularType(), MSDevice_SSM::getUpstreamVehicles(), MSLane::handleCollisionBetween(), MSVehicle::ignoreRed(), MSLCM_LC2013::inform(), MSLCM_SL2015::inform(), MSLCM_LC2013::informFollower(), MSLCM_SL2015::informFollower(), MSLCM_LC2013::informLeader(), MSLCM_SL2015::informLeader(), MESegment::initialise(), MSPedestrianPushButton::isActiveForEdge(), MSLane::isInsertionSuccess(), MSAbstractLaneChangeModel::laneChangeOutput(), MSVehicle::lateralDistanceToLane(), MSVehicle::leaveLane(), MSCFModel_Daniel1::moveHelper(), MSCFModel_Krauss::moveHelper(), MSCFModel_KraussOrig1::moveHelper(), MSCFModel_SmartSK::moveHelper(), MSPModel_Striping::moveInDirectionOnLane(), libsumo::Vehicle::moveToXY(), MSLCM_LC2013::MSLCM_LC2013(), MSCalibrator::VehicleRemover::notifyEnter(), MSVehicle::onRemovalFromNet(), MSLaneChangerSublane::outputLCStarted(), MSLCM_LC2013::patchSpeed(), MSLCM_SL2015::patchSpeed(), MSVehicle::planMove(), MSVehicle::planMoveInternal(), MSLCM_SL2015::prepareStep(), MSVehicle::processLaneAdvances(), MSVehicle::processLinkAproaches(), MSVehicle::processNextStop(), MSVehicle::removePassedDriveItems(), replaceRouteEdges(), reroute(), MSLane::resetManeuverReservation(), MSLane::resetPartialOccupation(), libsumo::Vehicle::resume(), MSLCM_SL2015::saveBlockerLength(), MSLCM_LC2013::saveBlockerLength(), saveState(), MSCalibrator::scheduleRemoval(), GUIVehicle::selectBlockingFoes(), MSVehicle::setAngle(), MSAbstractLaneChangeModel::setManeuverDist(), MSLane::setManeuverReservation(), MSLCM_SL2015::setOwnState(), MSLane::setPartialOccupation(), libsumo::Helper::setRemoteControlled(), libsumo::Vehicle::setRoute(), libsumo::Vehicle::setRouteID(), MSLCM_LC2013::slowDownForBlocked(), MSLCM_SL2015::slowDownForBlocked(), MSLaneChangerSublane::startChangeSublane(), MELoop::teleportVehicle(), METriggeredCalibrator::tryEmit(), MSVehicle::updateBestLanes(), MSVehicle::updateDriveItems(), MSLCM_SL2015::updateExpectedSublaneSpeeds(), MSLCM_SL2015::updateGaps(), MSAbstractLaneChangeModel::updateShadowLane(), MSVehicle::updateState(), MSAbstractLaneChangeModel::updateTargetLane(), MSLCM_LC2013::wantsChange(), MSLCM_SL2015::wantsChange(), MSLCM_SL2015::wantsChangeSublane(), MSBatteryExport::write(), and MSXMLRawOut::writeVehicle().

◆ getImpatience()

◆ getLane()

◆ getLateralPositionOnLane()

virtual double MSBaseVehicle::getLateralPositionOnLane ( ) const
inlinevirtual

Get the vehicle's lateral position on the lane.

Returns
The lateral position of the vehicle (in m relative to the centerline of the lane)

Implements SUMOVehicle.

Reimplemented in MSVehicle.

Definition at line 175 of file MSBaseVehicle.h.

◆ getLength()

◆ getMaxSpeed()

double MSBaseVehicle::getMaxSpeed ( ) const
virtual

◆ getNextParkingArea()

virtual MSParkingArea* SUMOVehicle::getNextParkingArea ( )
pure virtualinherited

returns the next imminent stop in the stop queue

Returns
the upcoming stop

Implemented in MSVehicle, and MEVehicle.

Referenced by MSTriggeredRerouter::rerouteParkingArea(), and SUMOVehicle::~SUMOVehicle().

◆ getNumberReroutes()

int MSBaseVehicle::getNumberReroutes ( ) const
inlinevirtual

Returns the number of new routes this vehicle got.

Returns
the number of new routes this vehicle got

Implements SUMOVehicle.

Definition at line 291 of file MSBaseVehicle.h.

References getImpatience(), and myNumberReroutes.

Referenced by GUIBaseVehicle::drawGLAdditional(), GUIMEVehicle::getColorValue(), GUIVehicle::getColorValue(), and replaceRouteEdges().

◆ getParameter()

◆ getPosition()

virtual Position SUMOVehicle::getPosition ( const double  offset = 0) const
pure virtualinherited

◆ getPositionOnLane()

◆ getPreviousSpeed()

double MSBaseVehicle::getPreviousSpeed ( ) const
virtual

Returns the vehicle's previous speed.

Returns
The vehicle's speed

Implements SUMOVehicle.

Reimplemented in MSVehicle.

Definition at line 64 of file MSBaseVehicle.cpp.

◆ getRerouteOrigin()

virtual const MSEdge* MSBaseVehicle::getRerouteOrigin ( ) const
inlinevirtual

Returns the starting point for reroutes (usually the current edge)

This differs from *myCurrEdge only if the vehicle is on an internal edge

Returns
The rerouting start point

Reimplemented in MSVehicle.

Definition at line 184 of file MSBaseVehicle.h.

References myCurrEdge.

Referenced by replaceRouteEdges(), and reroute().

◆ getRoute()

◆ getSingularType()

◆ getSlope()

double MSBaseVehicle::getSlope ( ) const
virtual

Returns the slope of the road at vehicle's position.

This default implementation returns always 0.

Returns
The slope

Implements SUMOVehicle.

Reimplemented in MSVehicle, and MEVehicle.

Definition at line 286 of file MSBaseVehicle.cpp.

Referenced by getCurrentRouteEdge().

◆ getSpeed()

◆ getStopEdges()

virtual const ConstMSEdgeVector MSBaseVehicle::getStopEdges ( ) const
protectedpure virtual

Returns the list of still pending stop edges.

Implemented in MSVehicle, and MEVehicle.

Referenced by isSelected(), and reroute().

◆ getVClass()

SUMOVehicleClass MSBaseVehicle::getVClass ( ) const
inlinevirtual

Returns the vehicle's access class.

Returns
The vehicle's access class

Implements SUMOVehicle.

Definition at line 123 of file MSBaseVehicle.h.

References getEdge(), getMaxSpeed(), MSVehicleType::getParameter(), myType, succEdge(), and SUMOVTypeParameter::vehicleClass.

Referenced by GUIVehicle::drawRouteHelper(), MSPedestrianPushButton::isActiveForEdge(), and reroute().

◆ getVehicleType()

const MSVehicleType& MSBaseVehicle::getVehicleType ( ) const
inlinevirtual

Returns the vehicle's type definition.

Returns
The vehicle's type definition

Implements SUMOVehicle.

Definition at line 115 of file MSBaseVehicle.h.

References myType.

Referenced by MSLCM_LC2013::_patchSpeed(), MSLCM_SL2015::_patchSpeed(), MSLCM_LC2013::_wantsChange(), MSLCM_SL2015::_wantsChangeSublane(), MSLCM_LC2013::adaptSpeedToPedestrians(), MSVehicle::adaptToLeaders(), MSPModel_Striping::addCrossingVehs(), MSVehicle::addStop(), MSLane::basePos(), MSTransportableControl::boardAnyWaiting(), MSLaneChanger::change(), MSLaneChanger::changeOpposite(), MSLCM_SL2015::checkBlocking(), MSLaneChanger::checkChange(), MSLaneChangerSublane::checkChangeToNewLane(), MSLane::checkFailure(), MSLane::checkForPedestrians(), GUIApplicationWindow::checkGamingEvents(), MSVehicleTransfer::checkInsertions(), MSVehicle::checkRewindLinkLanes(), MSLCM_SL2015::checkStrategicChange(), MSDevice_SSM::classifyEncounter(), MSLCM_SL2015::commitManoeuvre(), MSLaneChanger::computeOvertakingTime(), MSLCM_SL2015::computeSpeedLat(), MSLane::detectCollisionBetween(), MSLane::detectCollisions(), GUIVehicle::drawAction_drawLinkItems(), GUIVehicle::drawAction_drawRailCarriages(), GUIVehicle::drawAction_drawVehicleBlinker(), GUIVehicle::drawAction_drawVehicleBrakeLight(), GUIEdge::drawMesoVehicles(), MSLane::enteredByLaneChange(), MSVehicle::enterLaneAtInsertion(), MSVehicle::enterLaneAtLaneChange(), MSDevice_SSM::estimateConflictTimes(), MEVehicle::estimateLeaveSpeed(), MSVehicle::estimateLeaveSpeed(), MSLane::executeMovements(), MSLane::freeInsertion(), MEVehicle::getBackPositionOnLane(), MSLane::getBruttoOccupancy(), GUIBaseVehicle::getCenteringBoundary(), MSLane::getCriticalLeader(), MSEdge::getDepartLane(), MSEdge::getDepartPosBound(), MSLane::getDepartPosLat(), MSLane::getFollower(), MSLane::getFollowersOnConsecutive(), getImpatience(), MSVehicle::getLateralOverlap(), MSLane::getLeader(), MSVehicle::getLeader(), MSLink::getLeaderInfo(), MSLane::getLeaderOnConsecutive(), MSLaneChangerSublane::getLeaders(), MSLane::getLeadersOnConsecutive(), GUIVehicle::getLeftSideOnEdge(), MSLane::getNettoOccupancy(), MSLane::getOppositeFollower(), MSLane::getOppositeLeader(), MSLaneChanger::getRealFollower(), MSLaneChanger::getRealLeader(), MSVehicle::getRightSideOnEdge(), MSVehicle::getRightSideOnLane(), MSLeaderInfo::getSubLanes(), MSVehicle::getTimeGapOnLane(), MESegment::getTimeHeadway(), libsumo::Vehicle::getTypeID(), libsumo::Vehicle::getVehicleType(), GUIBaseVehicle::getVType(), MSLCM_SL2015::getWidth(), MSLink::getZipperSpeed(), MSLane::handleCollisionBetween(), MESegment::hasSpaceFor(), MSVehicle::ignoreRed(), MSLane::incorporateVehicle(), MSLCM_SL2015::informFollower(), MSLCM_SL2015::informLeader(), MSLCM_SL2015::informLeaders(), MSLane::insertVehicle(), MSLane::integrateNewVehicle(), MSLane::isInsertionSuccess(), MESegment::isOpen(), MSVehicle::keepClear(), MSLCM_SL2015::keepLatGap(), MSAbstractLaneChangeModel::laneChangeOutput(), MSLane::lastInsertion(), MSLane::leftByLaneChange(), MSTransportableControl::loadAnyWaiting(), MESegment::loadState(), MSCFModel_Krauss::moveHelper(), MSPModel_Striping::moveInDirectionOnLane(), libsumo::Vehicle::moveToXY(), MSVehicle::overlap(), MSLCM_LC2013::overtakeDistance(), MSLCM_DK2008::patchSpeed(), MSVehicle::planMoveInternal(), MSVehicle::Influencer::postProcessRemoteControl(), MSVehicle::processLinkAproaches(), MSVehicle::processNextStop(), MSVehicle::processTraCISpeedControl(), MESegment::receive(), MSLaneChanger::ChangeElem::registerHop(), MSLaneChanger::registerUnchanged(), MESegment::removeCar(), MSLane::removeVehicle(), MSLane::safeInsertionSpeed(), MSLCM_SL2015::saveBlockerLength(), MSLCM_LC2013::saveBlockerLength(), saveState(), GUIVehicle::selectBlockingFoes(), MSVehicleType::setActionStepLength(), MSAbstractLaneChangeModel::setFollowerGaps(), GUIBaseVehicle::setFunctionalColor(), MSAbstractLaneChangeModel::setLeaderGaps(), MSAbstractLaneChangeModel::setOrigLeaderGaps(), MSVehicle::setTentativeLaneAndPosition(), MSLCM_LC2013::slowDownForBlocked(), MSLCM_SL2015::slowDownForBlocked(), MSLaneChangerSublane::startChangeSublane(), MSVehicle::unsafeLinkAhead(), MSLCM_SL2015::updateCFRelated(), MSLCM_SL2015::updateExpectedSublaneSpeeds(), MSLCM_SL2015::updateGaps(), MSLCM_DK2008::wantsChangeToLeft(), MSLCM_DK2008::wantsChangeToRight(), MSBatteryExport::write(), and MSQueueExport::writeLane().

◆ getWaitingTime()

virtual SUMOTime SUMOVehicle::getWaitingTime ( ) const
pure virtualinherited

◆ getWidth()

◆ hasArrived()

bool MSBaseVehicle::hasArrived ( ) const
virtual

Returns whether this vehicle has already arived (by default this is true if the vehicle has reached its final edge)

Implements SUMOVehicle.

Reimplemented in MSVehicle, and MEVehicle.

Definition at line 306 of file MSBaseVehicle.cpp.

References succEdge().

Referenced by setArrivalPos().

◆ hasDeparted()

bool MSBaseVehicle::hasDeparted ( ) const
virtual

◆ hasDevice()

bool MSBaseVehicle::hasDevice ( const std::string &  deviceName) const

check whether the vehicle is equiped with a device of the given type

Definition at line 497 of file MSBaseVehicle.cpp.

References myDevices.

Referenced by createDevice(), and libsumo::Vehicle::getParameter().

◆ hasValidRoute()

bool MSBaseVehicle::hasValidRoute ( std::string &  msg,
const MSRoute route = 0 
) const
virtual

Validates the current or given route.

Parameters
[out]msgDescription why the route is not valid (if it is the case)
[in]routeThe route to check (or 0 if the current route shall be checked)
Returns
Whether the vehicle's current route is valid

Implements SUMOVehicle.

Definition at line 321 of file MSBaseVehicle.cpp.

References MSRoute::begin(), MSRoute::end(), MSVehicleType::getVehicleClass(), myCurrEdge, myRoute, and myType.

Referenced by getDevices(), MESegment::initialise(), libsumo::Vehicle::isRouteValid(), MSBaseVehicle(), replaceRouteEdges(), and libsumo::Vehicle::setRouteID().

◆ isFrontOnLane()

virtual bool MSBaseVehicle::isFrontOnLane ( const MSLane ) const
inlinevirtual

Returns the information whether the front of the vehhicle is on the given lane.

Returns
Whether the vehicle's front is on that lane

Implements SUMOVehicle.

Reimplemented in MSVehicle.

Definition at line 167 of file MSBaseVehicle.h.

◆ isOnRoad()

virtual bool MSBaseVehicle::isOnRoad ( ) const
inlinevirtual

Returns the information whether the vehicle is on a road (is simulated)

Returns
Whether the vehicle is simulated

Implements SUMOVehicle.

Reimplemented in MSVehicle, and MEVehicle.

Definition at line 152 of file MSBaseVehicle.h.

Referenced by GUIBaseVehicle::drawGLAdditional(), and MSXMLRawOut::writeVehicle().

◆ isParking()

virtual bool SUMOVehicle::isParking ( ) const
pure virtualinherited

Returns the information whether the vehicle is parked.

Returns
Whether the vehicle is parked

Implemented in MSVehicle, and MEVehicle.

Referenced by GUIVehicleControl::insertVehicleIDs(), MSFCDExport::write(), and SUMOVehicle::~SUMOVehicle().

◆ isRemoteControlled()

virtual bool MSBaseVehicle::isRemoteControlled ( ) const
inlinevirtual

Returns the information whether the vehicle is fully controlled via TraCI.

Returns
Whether the vehicle is remote-controlled

Implements SUMOVehicle.

Reimplemented in MSVehicle.

Definition at line 160 of file MSBaseVehicle.h.

◆ isSelected()

virtual bool MSBaseVehicle::isSelected ( ) const
inlinevirtual

whether this vehicle is selected in the GUI

Implements SUMOVehicle.

Reimplemented in GUIVehicle.

Definition at line 430 of file MSBaseVehicle.h.

References calculateArrivalParams(), and getStopEdges().

◆ isStopped()

virtual bool SUMOVehicle::isStopped ( ) const
pure virtualinherited

Returns whether the vehicle is at a stop.

Returns
Whether the has stopped

Implemented in MSVehicle, and MEVehicle.

Referenced by MSNet::getVehicleMeanSpeeds(), MSDevice_Transportable::notifyMove(), MSDevice_Tripinfo::notifyMove(), MSDevice_Transportable::removeTransportable(), and SUMOVehicle::~SUMOVehicle().

◆ isStoppedInRange()

virtual bool SUMOVehicle::isStoppedInRange ( double  pos) const
pure virtualinherited

Returns whether the vehicle is stoped in range of the given position.

Implemented in MSVehicle, and MEVehicle.

Referenced by SUMOVehicle::~SUMOVehicle().

◆ isStoppedTriggered()

virtual bool SUMOVehicle::isStoppedTriggered ( ) const
pure virtualinherited

Returns whether the vehicle is at a stop and waiting for a person or container to continue.

Implemented in MSVehicle, and MEVehicle.

Referenced by SUMOVehicle::~SUMOVehicle().

◆ loadState()

virtual void SUMOVehicle::loadState ( const SUMOSAXAttributes attrs,
const SUMOTime  offset 
)
pure virtualinherited

Loads the state of this vehicle from the given description.

Implemented in MSVehicle, and MEVehicle.

Referenced by MSStateHandler::closeVehicle(), and SUMOVehicle::~SUMOVehicle().

◆ onDepart()

void MSBaseVehicle::onDepart ( )
virtual

Called when the vehicle is inserted into the network.

Sets optional information about departure time, informs the vehicle control about a further running vehicle.

Implements SUMOVehicle.

Definition at line 292 of file MSBaseVehicle.cpp.

References MSNet::getCurrentTimeStep(), MSNet::getInstance(), SUMOVehicle::getPositionOnLane(), MSNet::getVehicleControl(), myDepartPos, myDeparture, and MSVehicleControl::vehicleDeparted().

Referenced by MSVehicle::enterLaneAtInsertion(), getCurrentRouteEdge(), MSVehicle::Influencer::postProcessRemoteControl(), and MESegment::receive().

◆ operator=()

MSBaseVehicle& MSBaseVehicle::operator= ( const MSBaseVehicle s)
private

invalidated assignment operator

◆ removeReminder()

void MSBaseVehicle::removeReminder ( MSMoveReminder rem)

Removes a MoveReminder dynamically.

Parameters
[in]remthe reminder to remove
See also
MSMoveReminder

Definition at line 360 of file MSBaseVehicle.cpp.

References myMoveReminders.

Referenced by getDevices().

◆ replaceParkingArea()

virtual bool SUMOVehicle::replaceParkingArea ( MSParkingArea parkingArea,
std::string &  errorMsg 
)
pure virtualinherited

Replaces a stop.

The stop replace the next stop into the sorted list.

Parameters
[in]stopThe stop to add
Returns
Whether the stop could be added

Implemented in MSVehicle, and MEVehicle.

Referenced by SUMOVehicle::~SUMOVehicle().

◆ replaceRoute()

virtual bool SUMOVehicle::replaceRoute ( const MSRoute route,
bool  onInit = false,
int  offset = 0,
bool  addStops = true,
bool  removeStops = true 
)
pure virtualinherited

Replaces the current route by the given one.

Implemented in MEVehicle, and MSVehicle.

Referenced by MSTriggeredRerouter::notifyEnter(), MSDevice_Routing::preInsertionReroute(), replaceRouteEdges(), and SUMOVehicle::~SUMOVehicle().

◆ replaceRouteEdges()

bool MSBaseVehicle::replaceRouteEdges ( ConstMSEdgeVector edges,
bool  onInit = false,
bool  check = false,
bool  removeStops = true 
)
virtual

Replaces the current route by the given edges.

It is possible that the new route is not accepted, if a) it does not contain the vehicle's current edge, or b) something fails on insertion into the routes container (see in-line comments).

Parameters
[in]edgesThe new list of edges to pass
[in]onInitWhether the vehicle starts with this route
[in]checkWhether the route should be checked for validity
[in]removeStopsWhether stops should be removed if they do not fit onto the new route
Returns
Whether the new route was accepted

Implements SUMOVehicle.

Definition at line 227 of file MSBaseVehicle.cpp.

References MSRoute::addReference(), MSRoute::begin(), RGBColor::DEFAULT_COLOR, MSRoute::dictionary(), MSGlobals::gCheckRoutes, MSRoute::getColor(), MSRoute::getEdges(), Named::getID(), getID(), getNumberReroutes(), getRerouteOrigin(), hasValidRoute(), myCurrEdge, myRoute, MSRoute::release(), SUMOVehicle::replaceRoute(), MSRoute::size(), toString(), and WRITE_WARNING.

Referenced by libsumo::Vehicle::changeTarget(), getCurrentRouteEdge(), MSVehicle::Influencer::postProcessRemoteControl(), reroute(), and libsumo::Vehicle::setRoute().

◆ replaceVehicleType()

void MSBaseVehicle::replaceVehicleType ( MSVehicleType type)

Replaces the current vehicle type by the one given.

If the currently used vehicle type is marked as being used by this vehicle only, it is deleted, first. The new, given type is then assigned to "myType".

Parameters
[in]typeThe new vehicle type
See also
MSBaseVehicle::myType

Definition at line 550 of file MSBaseVehicle.cpp.

References MSNet::getInstance(), MSNet::getVehicleControl(), MSVehicleType::isVehicleSpecific(), myType, and MSVehicleControl::removeVType().

Referenced by getSingularType(), setChosenSpeedFactor(), and libsumo::Vehicle::setType().

◆ reroute()

void MSBaseVehicle::reroute ( SUMOTime  t,
SUMOAbstractRouter< MSEdge, SUMOVehicle > &  router,
const bool  onInit = false,
const bool  withTaz = false 
)
virtual

Performs a rerouting using the given router.

Tries to find a new route between the current edge and the destination edge, first. Tries to replace the current route by the new one using replaceRoute.

Parameters
[in]tThe time for which the route is computed
[in]routerThe router to use
See also
replaceRoute

Implements SUMOVehicle.

Definition at line 155 of file MSBaseVehicle.cpp.

References MSEdge::allowedLanes(), calculateArrivalParams(), SUMOAbstractRouter< E, V >::compute(), MSInsertionControl::descheduleDeparture(), MSEdge::dictionary(), SUMOVehicleParameter::fromTaz, MSGlobals::gCheckRoutes, Named::getID(), getID(), MSNet::getInsertionControl(), MSNet::getInstance(), MSRoute::getLastEdge(), getRerouteOrigin(), getStopEdges(), getVClass(), MSEdge::isTazConnector(), myParameter, myRoute, replaceRouteEdges(), SUMOVehicleParameter::toTaz, SUMOVehicleParameter::via, and WRITE_WARNING.

Referenced by libsumo::Vehicle::changeTarget(), getCurrentRouteEdge(), libsumo::Vehicle::rerouteEffort(), and libsumo::Vehicle::rerouteTraveltime().

◆ saveState()

◆ setArrivalPos()

virtual void MSBaseVehicle::setArrivalPos ( double  arrivalPos)
inlinevirtual

Sets this vehicle's desired arrivalPos for its current route.

Implements SUMOVehicle.

Definition at line 275 of file MSBaseVehicle.h.

References hasArrived(), hasDeparted(), and myArrivalPos.

◆ setChosenSpeedFactor()

void MSBaseVehicle::setChosenSpeedFactor ( const double  factor)
inlinevirtual

Returns the precomputed factor by which the driver wants to be faster than the speed limit.

Returns
Speed limit factor

Implements SUMOVehicle.

Definition at line 384 of file MSBaseVehicle.h.

References addStops(), getDevice(), getSingularType(), myChosenSpeedFactor, replaceVehicleType(), and saveState().

Referenced by TraCIServerAPI_Vehicle::processSet().

◆ setDeviceParameter()

void MSBaseVehicle::setDeviceParameter ( const std::string &  deviceName,
const std::string &  key,
const std::string &  value 
)

try to set the given parameter from any of the vehicles devices, raise InvalidArgument if no device parameter by that name exists

Definition at line 538 of file MSBaseVehicle.cpp.

References myDevices.

Referenced by libsumo::Vehicle::setParameter().

◆ succEdge()

const MSEdge * MSBaseVehicle::succEdge ( int  nSuccs) const
virtual

Returns the nSuccs'th successor of edge the vehicle is currently at.

If the rest of the route (counted from the current edge) has less than nSuccs edges, 0 is returned.

Parameters
[in]nSuccsThe number of edge to look forward
Returns
The nSuccs'th following edge in the vehicle's route

Implements SUMOVehicle.

Definition at line 139 of file MSBaseVehicle.cpp.

References MSRoute::begin(), myCurrEdge, and myRoute.

Referenced by MSVehicleTransfer::add(), MSLane::appropriate(), MSVehicleTransfer::checkInsertions(), MESegment::getLink(), getVClass(), hasArrived(), MSPedestrianPushButton::isActiveForEdge(), libsumo::Vehicle::moveTo(), MELoop::nextSegment(), and MESegment::receive().

Friends And Related Function Documentation

◆ GUIBaseVehicle

friend class GUIBaseVehicle
friend

Definition at line 66 of file MSBaseVehicle.h.

Field Documentation

◆ myArrivalLane

int MSBaseVehicle::myArrivalLane
protected

The destination lane where the vehicle stops.

Definition at line 487 of file MSBaseVehicle.h.

Referenced by calculateArrivalParams(), and MSVehicle::updateBestLanes().

◆ myArrivalPos

double MSBaseVehicle::myArrivalPos
protected

◆ myChosenSpeedFactor

double MSBaseVehicle::myChosenSpeedFactor
protected

A precomputed factor by which the driver wants to be faster than the speed limit.

Definition at line 457 of file MSBaseVehicle.h.

Referenced by getChosenSpeedFactor(), and setChosenSpeedFactor().

◆ myCurrEdge

◆ myDepartPos

double MSBaseVehicle::myDepartPos
protected

The real depart position.

Definition at line 481 of file MSBaseVehicle.h.

Referenced by getDepartPos(), MSVehicle::loadState(), onDepart(), and MSVehicle::saveState().

◆ myDeparture

SUMOTime MSBaseVehicle::myDeparture
protected

◆ myDevices

◆ myMoveReminders

◆ myNumberReroutes

int MSBaseVehicle::myNumberReroutes
protected

The number of reroutings.

Definition at line 490 of file MSBaseVehicle.h.

Referenced by getNumberReroutes(), MSVehicle::replaceRoute(), and MEVehicle::replaceRoute().

◆ myParameter

◆ myRoute

◆ myType

◆ NOT_YET_DEPARTED

const SUMOTime MSBaseVehicle::NOT_YET_DEPARTED = SUMOTime_MAX
staticprotected

The documentation for this class was generated from the following files: