Representation of a vehicle. More...

#include <SUMOVehicle.h>

Inheritance diagram for SUMOVehicle:

Collaboration diagram for SUMOVehicle:

Public Types
typedef long long int	NumericalID

Public Member Functions
virtual bool	abortNextStop (int nextStopIndex=0)=0
	deletes the next stop at the given index if it exists

virtual bool	addStop (const SUMOVehicleParameter::Stop &stopPar, std::string &errorMsg, SUMOTime untilOffset=0, ConstMSEdgeVector::const_iterator *searchStart=0)=0
	Adds a stop.

void	addTo (const StoringVisitor &cont) const
	Adds this object to the given container.

virtual bool	addTraciStop (SUMOVehicleParameter::Stop stop, std::string &errorMsg)=0

virtual void	addTransportable (MSTransportable *transportable)=0
	Adds a person or container to this vehicle.

virtual bool	allowsBoarding (const MSTransportable *t) const =0
	whether the given transportable is allowed to board this vehicle

virtual double	getAcceleration () const =0
	Returns the object's acceleration.

virtual double	getAngle () const =0
	Get the vehicle's angle.

virtual double	getArrivalPos () const =0
	Returns this vehicle's desired arrivalPos for its current route (may change on reroute)

virtual const MSLane *	getBackLane () const =0
	Returns the lane the where the rear of the object is currently at.

virtual double	getBackPositionOnLane (const MSLane *lane) const =0
	Get the object's back position along the given lane.

virtual PositionVector	getBoundingBox (double offset=0) const =0
	get bounding rectangle

virtual double	getBrakeGap (bool delayed=false) const =0
	get distance for coming to a stop (used for rerouting checks)

virtual double	getChosenSpeedFactor () const =0

virtual int	getContainerNumber () const =0
	Returns the number of containers.

virtual const std::vector< MSTransportable * > &	getContainers () const =0
	retrieve riding containers

virtual const ConstMSEdgeVector::const_iterator &	getCurrentRouteEdge () const =0
	Returns an iterator pointing to the current edge in this vehicles route.

virtual SUMOTime	getDepartDelay () const =0

virtual double	getDepartPos () const =0
	Returns this vehicle's real departure position.

virtual SUMOTime	getDeparture () const =0
	Returns this vehicle's real departure time.

virtual MSDevice *	getDevice (const std::type_info &type) const =0
	Returns a device of the given type if it exists or nullptr if not.

virtual const std::vector< MSVehicleDevice * > &	getDevices () const =0
	Returns this vehicle's devices.

virtual const MSEdge *	getEdge () const =0
	Returns the edge the object is currently at.

virtual EnergyParams *	getEmissionParameters () const =0
	Returns the vehicle's emission model parameter.

const std::string &	getID () const
	Returns the id.

virtual double	getImpatience () const =0
	Returns this vehicles impatience.

virtual const MSLane *	getLane () const =0
	Returns the lane the object is currently at.

virtual SUMOTime	getLastActionTime () const =0

virtual double	getLateralPositionOnLane () const =0
	Get the vehicle's lateral position on the lane.

virtual double	getLength () const =0
	Returns the vehicles's length.

virtual double	getMaxSpeed () const =0
	Returns the object's maximum speed (minimum of technical and desired maximum speed)

virtual const MSEdge *	getNextEdgePtr () const =0
	returns the next edge (possibly an internal edge)

virtual MSParkingArea *	getNextParkingArea ()=0

virtual MSStop &	getNextStop ()=0

virtual const SUMOVehicleParameter::Stop *	getNextStopParameter () const =0
	Returns parameters of the next stop or nullptr.

virtual int	getNumberReroutes () const =0
	Returns the number of new routes this vehicle got.

virtual NumericalID	getNumericalID () const =0
	return the numerical ID which is only for internal usage

virtual double	getOdometer () const =0
	Returns the distance that was already driven by this vehicle.

virtual const SUMOVehicleParameter &	getParameter () const =0
	Returns the vehicle's parameter (including departure definition)

virtual std::vector< std::string >	getPersonIDList () const =0
	Returns the list of persons.

virtual int	getPersonNumber () const =0
	Returns the number of persons.

virtual const std::vector< MSTransportable * > &	getPersons () const =0
	retrieve riding persons

virtual Position	getPosition (const double offset=0) const =0
	Return current position (x/y, cartesian)

virtual double	getPositionOnLane () const =0
	Get the object's position along the lane.

virtual double	getPreviousSpeed () const =0
	Returns the object's previous speed.

virtual const MSEdge *	getRerouteDestination () const =0
	Returns the end point for reroutes (usually the last edge of the route)

virtual ConstMSEdgeVector::const_iterator	getRerouteOrigin () const =0
	Returns the starting point for reroutes (usually the current edge)

virtual SumoRNG *	getRNG () const =0
	Returns the associated RNG for this object.

virtual int	getRNGIndex () const =0

virtual const MSRoute &	getRoute () const =0
	Returns the current route.

virtual int	getRoutePosition () const =0
	return index of edge within route

virtual ConstMSRoutePtr	getRoutePtr () const =0
	Returns the current route.

virtual int	getRouteValidity (bool update=true, bool silent=false, std::string *msgReturn=nullptr)=0
	computes validity attributes for the current route

virtual int	getRoutingMode () const =0

virtual double	getSlope () const =0
	Returns the slope of the road at object's position in degrees.

virtual double	getSpeed () const =0
	Returns the object's current speed.

virtual std::vector< std::pair< int, double > >	getStopIndices () const =0
	return list of route indices and stop positions for the remaining stops

virtual const std::list< MSStop > &	getStops () const =0

virtual SUMOTime	getTimeLoss () const =0

virtual const std::set< NumericalID >	getUpcomingEdgeIDs () const =0
	returns the numerical IDs of edges to be used (possibly of future stages)

virtual SUMOVehicleClass	getVClass () const =0
	Returns the object's access class.

virtual const MSVehicleType &	getVehicleType () const =0
	Returns the object's "vehicle" type.

virtual const SUMOVTypeParameter &	getVTypeParameter () const =0
	Returns the object's "vehicle" type parameter.

virtual SUMOTime	getWaitingTime (const bool accumulated=false) const =0

virtual bool	hasArrived () const =0
	Returns whether this object has arrived.

virtual bool	hasDeparted () const =0
	Returns whether this vehicle has departed.

virtual bool	hasInfluencer () const =0
	whether the vehicle is individually influenced (via TraCI or special parameters)

virtual bool	hasStops () const =0
	Returns whether the vehicle has to stop somewhere.

virtual bool	hasValidRoute (std::string &msg, ConstMSRoutePtr route=0) const =0
	Validates the current or given route.

virtual bool	hasValidRouteStart (std::string &msg)=0
	checks wether the vehicle can depart on the first edge

virtual bool	ignoreTransientPermissions () const
	Returns whether this object is ignoring transient permission changes (during routing)

virtual bool	isContainer () const
	Whether it is a container.

virtual bool	isFrontOnLane (const MSLane *) const =0
	Returns the information whether the front of the vehhicle is on the given lane.

virtual bool	isIdling () const =0
	Returns whether the vehicle is idling (waiting to re-enter the net.

virtual bool	isLineStop (double position) const =0
	returns whether the vehicle serves a public transport line that serves the given stop

virtual bool	isOnRoad () const =0
	Returns the information whether the vehicle is on a road (is simulated)

virtual bool	isParking () const =0
	Returns the information whether the vehicle is parked.

virtual bool	isPerson () const
	Whether it is a person.

virtual bool	isRemoteControlled () const =0
	Returns the information whether the vehicle is fully controlled via TraCI.

virtual bool	isSelected () const =0
	whether this object is selected in the GUI

virtual bool	isStopped () const =0
	Returns whether the vehicle is at a stop and waiting for a person or container to continue.

virtual bool	isStoppedInRange (const double pos, const double tolerance, bool checkFuture=false) const =0
	Returns whether the vehicle is stopped in the range of the given position.

virtual bool	isStoppedParking () const =0
	Returns whether the vehicle is at a stop and parking.

virtual bool	isStoppedTriggered () const =0
	Returns whether the vehicle is at a stop and waiting for a person or container to continue.

virtual bool	isVehicle () const
	Whether it is a vehicle.

virtual void	onDepart ()=0
	Called when the vehicle is inserted into the network.

virtual SUMOTime	remainingStopDuration () const =0
	Returns the remaining stop duration for a stopped vehicle or 0.

virtual void	removeTransportable (MSTransportable *t)=0
	removes a person or container

virtual void	replaceParameter (const SUMOVehicleParameter *newParameter)=0
	Replaces the vehicle's parameter.

virtual bool	replaceParkingArea (MSParkingArea *parkingArea, std::string &errorMsg)=0
	Replaces a stop.

virtual bool	replaceRoute (ConstMSRoutePtr 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 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 void	replaceVehicleType (MSVehicleType *type)=0
	Replaces the current vehicle type by the one given.

virtual bool	reroute (SUMOTime t, const std::string &info, SUMOAbstractRouter< MSEdge, SUMOVehicle > &router, const bool onInit=false, const bool withTaz=false, const bool silent=false, const MSEdge *sink=nullptr)=0
	Performs a rerouting using the given router.

virtual void	setArrivalPos (double arrivalPos)=0
	Sets this vehicle's desired arrivalPos for its current route.

virtual void	setChosenSpeedFactor (const double factor)=0

virtual void	setID (const std::string &newID)
	resets the id

virtual bool	stopsAt (MSStoppingPlace *stop) const =0
	Returns whether the vehicle stops at the given stopping place.

virtual bool	stopsAtEdge (const MSEdge *edge) const =0
	Returns whether the vehicle stops at the given edge.

virtual const MSEdge *	succEdge (int nSuccs) const =0
	Returns the nSuccs'th successor of edge the vehicle is currently at.

	SUMOVehicle (const std::string &id)
	Constructor.

virtual void	unregisterWaiting ()=0
	mark vehicle as active

virtual bool	wasRemoteControlled (SUMOTime lookBack=DELTA_T) const =0
	Returns the information whether the vehicle is fully controlled via TraCI.

virtual	~SUMOVehicle ()
	Destructor.

parking memory io
virtual void	rememberBlockedParkingArea (const MSStoppingPlace *pa, bool local)=0

virtual SUMOTime	sawBlockedParkingArea (const MSStoppingPlace *pa, bool local) const =0

virtual void	rememberParkingAreaScore (const MSStoppingPlace *pa, const std::string &score)=0

virtual void	resetParkingAreaScores ()=0

virtual int	getNumberParkingReroutes () const =0

virtual void	setNumberParkingReroutes (int value)=0

virtual void	rememberBlockedChargingStation (const MSStoppingPlace *cs, bool local)=0

virtual SUMOTime	sawBlockedChargingStation (const MSStoppingPlace *cs, bool local) const =0

virtual void	rememberChargingStationScore (const MSStoppingPlace *cs, const std::string &score)=0

virtual void	resetChargingStationScores ()=0

state io
virtual void	saveState (OutputDevice &out)=0
	Saves the states of a vehicle.

virtual void	loadState (const SUMOSAXAttributes &attrs, const SUMOTime offset)=0
	Loads the state of this vehicle from the given description.

Helper methods for parsing parameters from the object itself, it's type or the global OptionsCont
std::string	getStringParam (const std::string &paramName, const bool required=false, const std::string &deflt="") const
	Retrieve a string parameter for the traffic object.

double	getFloatParam (const std::string &paramName, const bool required=false, const double deflt=INVALID_DOUBLE) const
	Retrieve a floating point parameter for the traffic object.

bool	getBoolParam (const std::string &paramName, const bool required=false, const bool deflt=false) const
	Retrieve a boolean parameter for the traffic object.

SUMOTime	getTimeParam (const std::string &paramName, const bool required=false, const SUMOTime deflt=SUMOTime_MIN) const
	Retrieve a time parameter for the traffic object.

Static Public Member Functions
template<class T >
static std::string	getIDSecure (const T *obj, const std::string &fallBack="NULL")
	get an identifier for Named-like object which may be Null

Protected Attributes
std::string	myID
	The name of the object.

Detailed Description

Representation of a vehicle.

Definition at line 62 of file SUMOVehicle.h.

Member Typedef Documentation

◆ NumericalID

typedef long long int SUMOTrafficObject::NumericalID

inherited

Definition at line 56 of file SUMOTrafficObject.h.

Constructor & Destructor Documentation

◆ SUMOVehicle()

SUMOVehicle::SUMOVehicle ( const std::string & id )

inline

Constructor.

Definition at line 66 of file SUMOVehicle.h.

◆ ~SUMOVehicle()

virtual SUMOVehicle::~SUMOVehicle ( )

inlinevirtual

Destructor.

Definition at line 69 of file SUMOVehicle.h.

Member Function Documentation

◆ abortNextStop()

virtual bool SUMOVehicle::abortNextStop ( int nextStopIndex = 0 )

pure virtual

deletes the next stop at the given index if it exists

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::customerArrived(), MSDevice_Taxi::dispatchShared(), and MSDevice_StationFinder::rerouteToChargingStation().

Here is the caller graph for this function:

◆ addStop()

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

pure virtual

Adds a stop.

The stop is put into the sorted list.

Parameters

[in] stop The stop to add

Returns: Whether the stop could be added

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::dispatchShared(), and MSDevice_ToC::triggerMRM().

Here is the caller graph for this function:

◆ addTo()

void Named::addTo ( const StoringVisitor & cont ) const

inlineinherited

Adds this object to the given container.

Parameters

[in,filled] cont The container to add this item to

Definition at line 118 of file Named.h.

References Named::StoringVisitor::add().

◆ addTraciStop()

virtual bool SUMOVehicle::addTraciStop	(	SUMOVehicleParameter::Stop	stop,
		std::string &	errorMsg
	)

pure virtual

schedule a new stop for the vehicle; each time a stop is reached, the vehicle will wait for the given duration before continuing on its route

Parameters

[in]	stop	Stop parameters
[out]	errorMsg	returned error message

Implemented in MSBaseVehicle, and MSVehicle.

Referenced by MSIdling_Stop::idle().

Here is the caller graph for this function:

◆ addTransportable()

virtual void SUMOVehicle::addTransportable ( MSTransportable * transportable )

pure virtual

Adds a person or container to this vehicle.

Parameters

[in] transportable The person/container to add

Implemented in MSBaseVehicle, and MSVehicle.

Referenced by MSTransportableControl::loadAnyWaiting(), MSStageDriving::loadState(), and MSStageDriving::proceed().

Here is the caller graph for this function:

◆ allowsBoarding()

virtual bool SUMOVehicle::allowsBoarding ( const MSTransportable * t ) const

pure virtual

whether the given transportable is allowed to board this vehicle

Implemented in MSBaseVehicle.

Referenced by MSTransportableControl::hasAnyWaiting(), and MSTransportableControl::loadAnyWaiting().

Here is the caller graph for this function:

◆ getAcceleration()

virtual double SUMOTrafficObject::getAcceleration ( ) const

pure virtualinherited

Returns the object's acceleration.

Returns: The acceleration

Implemented in MSBaseVehicle, MSVehicle, and MSTransportable.

Referenced by MSE2Collector::makeMoveNotification(), MSDevice_Battery::notifyMove(), MSDevice_Emissions::notifyMove(), MSDevice_Emissions::notifyMoveInternal(), MSMeanData_Harmonoise::MSLaneMeanDataValues::notifyMoveInternal(), MSMeanData_Emissions::MSLaneMeanDataValues::notifyMoveInternal(), MSElecHybridExport::write(), MSEmissionExport::write(), MSElecHybridExport::writeAggregated(), MSAmitranTrajectories::writeVehicle(), and MSFullExport::writeVehicles().

Here is the caller graph for this function:

◆ getAngle()

virtual double SUMOVehicle::getAngle ( ) const

pure virtual

Get the vehicle's angle.

Returns: The angle of the vehicle (in degree)

Implements SUMOTrafficObject.

Implemented in GUIVehicle, GUIMEVehicle, MEVehicle, and MSVehicle.

Referenced by MSDevice_ElecHybrid::acceleration(), libsumo::Helper::applySubscriptionFilterFieldOfVision(), MSDevice_ElecHybrid::consumption(), LIBSUMO_NAMESPACE::Vehicle::getAngle(), LIBSUMO_NAMESPACE::Vehicle::highlight(), MSDevice_ElecHybrid::notifyMove(), MSDevice_Battery::notifyMove(), GUIBaseVehicle::setFunctionalColor(), MSFCDExport::write(), MSEmissionExport::write(), and MSFullExport::writeVehicles().

Here is the caller graph for this function:

◆ getArrivalPos()

virtual double SUMOVehicle::getArrivalPos ( ) const

pure virtual

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

Returns: This vehicle's real arrivalPos

Implemented in MSBaseVehicle.

Referenced by MSStoppingPlaceRerouter::evaluateDestination(), MSDevice_Tripinfo::notifyLeave(), MSStoppingPlaceRerouter::reroute(), MSStageDriving::setArrived(), and MSDevice_Vehroutes::writeOutput().

Here is the caller graph for this function:

◆ getBackLane()

virtual const MSLane * SUMOTrafficObject::getBackLane ( ) const

pure virtualinherited

Returns the lane the where the rear of the object is currently at.

Returns: The current back lane or nullptr if the object is not on a lane

Implemented in MEVehicle, MSVehicle, and MSTransportable.

Referenced by MSDriveWay::notifyLeaveBack().

Here is the caller graph for this function:

◆ getBackPositionOnLane()

virtual double SUMOTrafficObject::getBackPositionOnLane ( const MSLane * lane ) const

pure virtualinherited

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

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

Implemented in MEVehicle, MSVehicle, and MSTransportable.

Referenced by MSE2Collector::notifyEnter(), MSE3Collector::MSE3EntryReminder::notifyEnter(), MSE3Collector::MSE3LeaveReminder::notifyEnter(), and MSInductLoop::notifyEnter().

Here is the caller graph for this function:

◆ getBoolParam()

bool SUMOTrafficObject::getBoolParam	(	const std::string &	paramName,
		const bool	required = `false`,
		const bool	deflt = `false`
	)		const

inherited

Retrieve a boolean parameter for the traffic object.

Parameters

paramName	the parameter name
required	whether it is an error if the parameter is not set
deflt	the default value to take if the parameter is not set (the default in the OptionsCont takes precedence)

Returns: the bool value

Definition at line 76 of file SUMOTrafficObject.cpp.

References Named::getID(), SUMOTrafficObject::getStringParam(), SUMOTrafficObject::isPerson(), SUMOTrafficObject::isVehicle(), TL, StringUtils::toBool(), toString(), and WRITE_ERRORF.

Referenced by MSDevice_GLOSA::buildVehicleDevices(), and MSDevice_ToC::buildVehicleDevices().

Here is the caller graph for this function:

◆ getBoundingBox()

virtual PositionVector SUMOVehicle::getBoundingBox ( double offset = 0 ) const

pure virtual

get bounding rectangle

Implemented in MEVehicle, and MSVehicle.

Referenced by GUIPerson::getGUIPosition().

Here is the caller graph for this function:

◆ getBrakeGap()

virtual double SUMOVehicle::getBrakeGap ( bool delayed = false ) const

pure virtual

get distance for coming to a stop (used for rerouting checks)

Implemented in MEVehicle, and MSVehicle.

Referenced by MSBaseVehicle::addStop(), MSLink::blockedByFoe(), MSDriveWay::foeDriveWayOccupied(), MSStop::getEndPos(), MSDevice_Taxi::prepareStop(), MSBaseVehicle::replaceRoute(), MSStoppingPlaceRerouter::reroute(), and MSBaseVehicle::reroute().

Here is the caller graph for this function:

◆ getChosenSpeedFactor()

virtual double SUMOTrafficObject::getChosenSpeedFactor ( ) const

pure virtualinherited

Implemented in MSBaseVehicle, MSPerson, and MSTransportable.

Referenced by MSDevice_Tripinfo::generateOutput(), MSLane::getVehicleMaxSpeed(), MSRoutingEngine::initRouter(), MSEdge::validateDepartSpeed(), MSVehicleControl::vehicleDeparted(), and MSDevice_Vehroutes::writeOutput().

Here is the caller graph for this function:

◆ getContainerNumber()

virtual int SUMOVehicle::getContainerNumber ( ) const

pure virtual

Returns the number of containers.

Returns: The number of contaiers on-board

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::customerArrived(), MSStageDriving::proceed(), and MSDevice_Taxi::updateMove().

Here is the caller graph for this function:

◆ getContainers()

virtual const std::vector< MSTransportable * > & SUMOVehicle::getContainers ( ) const

pure virtual

retrieve riding containers

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::cancelCurrentCustomers(), MSDevice_Taxi::dispatchShared(), and MSFCDExport::write().

Here is the caller graph for this function:

◆ getCurrentRouteEdge()

virtual const ConstMSEdgeVector::const_iterator & SUMOVehicle::getCurrentRouteEdge ( ) const

pure virtual

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

Returns: The current route pointer

Implemented in MSBaseVehicle.

Referenced by MSDevice_SSM::findFoeConflictLane(), MSDriveWay::foeDriveWayOccupied(), MSDriveWay::getDepartureDriveway(), MSRailSignal::LinkInfo::getDriveWay(), MSDriveWay::notifyEnter(), MSTriggeredRerouter::triggerRouting(), MSDetectorFileOutput::vehicleApplies(), and MSDevice_Vehroutes::writeOutput().

Here is the caller graph for this function:

◆ getDepartDelay()

virtual SUMOTime SUMOVehicle::getDepartDelay ( ) const

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSDevice_Tripinfo::generateOutput(), and MSDevice_Routing::notifyEnter().

Here is the caller graph for this function:

◆ getDepartPos()

virtual double SUMOVehicle::getDepartPos ( ) const

pure virtual

Returns this vehicle's real departure position.

Returns: This vehicle's real departure position

Implemented in MSBaseVehicle.

Referenced by MSDevice_Tripinfo::generateOutput(), MSDevice_Vehroutes::writeOutput(), and MSDevice_Vehroutes::writeXMLRoute().

Here is the caller graph for this function:

◆ getDeparture()

virtual SUMOTime SUMOVehicle::getDeparture ( ) const

pure virtual

Returns this vehicle's real departure time.

Returns: This vehicle's real departure time

Implemented in MSBaseVehicle.

Referenced by MSDevice_StationFinder::estimateConsumption(), MSDevice_Tripinfo::generateOutput(), MSDevice_StationFinder::notifyMove(), MSVehicleControl::vehicleDeparted(), MSDevice_Vehroutes::writeOutput(), and MSAmitranTrajectories::writeVehicle().

Here is the caller graph for this function:

◆ getDevice()

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

pure virtualinherited

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

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSDevice_Transportable::addTransportable(), MSInsertionControl::checkCandidates(), MSStateHandler::closeVehicle(), MSFCDExport::hasOwnOutput(), MSTransportableDevice_FCDReplay::move(), MSDevice_Taxi::MSDevice_Taxi(), MSDevice_Example::notifyMove(), MSDevice_Transportable::notifyMove(), MSDevice_Transportable::removeTransportable(), MSRailSignal::LinkInfo::reroute(), MSTriggeredRerouter::triggerRouting(), MSDevice_FCDReplay::FCDHandler::updateTrafficObjects(), MSElecHybridExport::write(), MSEmissionExport::write(), MSElecHybridExport::writeAggregated(), and MSNet::writeOutput().

Here is the caller graph for this function:

◆ getDevices()

virtual const std::vector< MSVehicleDevice * > & SUMOVehicle::getDevices ( ) const

pure virtual

Returns this vehicle's devices.

Returns: This vehicle's devices

Implemented in MSBaseVehicle.

Referenced by MSStateHandler::closeVehicle(), MSDevice_Tripinfo::generateOutput(), and MSDevice_Tripinfo::generateOutputForUnfinished().

Here is the caller graph for this function:

◆ getEdge()

virtual const MSEdge * SUMOTrafficObject::getEdge ( ) const

pure virtualinherited

Returns the edge the object is currently at.

Returns: The current edge in the object's route

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSStageDriving::abort(), MSDevice_Vehroutes::addRoute(), MSStageDriving::canLeaveVehicle(), MSInsertionControl::checkCandidates(), MSDispatch::computePickupTime(), libsumo::Helper::debugPrint(), MSDevice_Taxi::dispatchShared(), MSStoppingPlaceRerouter::evaluateDestination(), LIBSUMO_NAMESPACE::TrafficLight::findConstraintsDeadLocks(), MSDevice_SSM::findFoeConflictLane(), MSDevice_Tripinfo::generateOutput(), MSStopOut::generateOutputForUnfinished(), MSDriveWay::getDepartureDriveway(), MSStageDriving::getEdge(), MSStop::getEndPos(), MSDevice_BTsender::getLocation(), MSVehicleControl::getVehicleMeanSpeeds(), MSFCDExport::hasOwnOutput(), MSStopOut::loadedContainers(), MSStopOut::loadedPersons(), MSDevice_ElecHybrid::notifyEnter(), MSDevice_BTreceiver::notifyEnter(), MSDevice_BTsender::notifyEnter(), MSDevice_Example::notifyEnter(), MSDevice_Tripinfo::notifyEnter(), MSDevice_Vehroutes::notifyEnter(), MSDriveWay::notifyEnter(), MSDevice_ElecHybrid::notifyLeave(), MSDevice_Example::notifyLeave(), MSDevice_Transportable::notifyLeave(), MSDevice_Tripinfo::notifyLeave(), MSDevice_Vehroutes::notifyLeave(), MSDevice_ElecHybrid::notifyMove(), MSDevice_Transportable::notifyMoveInternal(), MSDevice_Tripinfo::notifyMoveInternal(), MSMeanData_Net::MSLaneMeanDataValues::notifyMoveInternal(), MSStoppingPlaceRerouter::reroute(), MSStageDriving::setArrived(), MSStopOut::stopEnded(), MSStopOut::stopStarted(), MSTriggeredRerouter::triggerRouting(), MSInsertionControl::tryInsert(), MSStopOut::unloadedContainers(), MSStopOut::unloadedPersons(), MSRailSignalControl::vehicleStateChanged(), MSFCDExport::write(), and MSEmissionExport::write().

Here is the caller graph for this function:

◆ getEmissionParameters()

virtual EnergyParams * SUMOVehicle::getEmissionParameters ( ) const

pure virtual

Returns the vehicle's emission model parameter.

Returns: The vehicle's emission parameters

Implemented in MSBaseVehicle.

Referenced by MSDevice_ElecHybrid::acceleration(), MSDevice_ElecHybrid::computeChargedEnergy(), MSDevice_ElecHybrid::consumption(), MSDevice_StationFinder::estimateConsumption(), MSDevice_Battery::getParameter(), MSDevice_ElecHybrid::getParameter(), MSDevice_ElecHybrid::getParameterDouble(), MSDevice_ElecHybrid::MSDevice_ElecHybrid(), MSDevice_Emissions::notifyIdle(), MSMeanData_Emissions::MSLaneMeanDataValues::notifyIdle(), MSDevice_Battery::notifyMove(), MSDevice_Emissions::notifyMove(), MSDevice_Emissions::notifyMoveInternal(), MSMeanData_Emissions::MSLaneMeanDataValues::notifyMoveInternal(), MSDevice_Battery::setParameter(), MSDevice_ElecHybrid::setParameter(), MSEmissionExport::write(), and MSFullExport::writeVehicles().

Here is the caller graph for this function:

◆ getFloatParam()

double SUMOTrafficObject::getFloatParam	(	const std::string &	paramName,
		const bool	required = `false`,
		const double	deflt = `INVALID_DOUBLE`
	)		const

inherited

Retrieve a floating point parameter for the traffic object.

Parameters

paramName	the parameter name
required	whether it is an error if the parameter is not set
deflt	the default value to take if the parameter is not set (the default in the OptionsCont takes precedence)

Returns: the float value

Definition at line 58 of file SUMOTrafficObject.cpp.

References Named::getID(), SUMOTrafficObject::getStringParam(), SUMOTrafficObject::isPerson(), Distribution_Parameterized::isValid(), SUMOTrafficObject::isVehicle(), Distribution_Parameterized::sample(), TL, toString(), and WRITE_ERRORF.

Referenced by MSDevice_Bluelight::buildVehicleDevices(), MSDevice_DriverState::buildVehicleDevices(), MSDevice_Friction::buildVehicleDevices(), MSDevice_GLOSA::buildVehicleDevices(), MSDevice_Routing::buildVehicleDevices(), MSDevice_ToC::buildVehicleDevices(), MSDevice_Taxi::dispatchShared(), MSPModel_JuPedSim::execute(), MSDevice_ToC::getDynamicMRMProbability(), MSDevice_ToC::getOpenGapParams(), MSPModel_Striping::moveInDirectionOnLane(), MSDevice_GLOSA::notifyEnter(), MSDevice_Bluelight::notifyMove(), and MSDevice_Battery::readParameterValue().

Here is the caller graph for this function:

◆ getID()

const std::string & Named::getID ( ) const

inlineinherited

Returns the id.

Returns: The stored id

Definition at line 74 of file Named.h.

References Named::myID.

◆ getIDSecure()

template<class T >

static std::string Named::getIDSecure	(	const T *	obj,
		const std::string &	fallBack = `"NULL"`
	)

inlinestaticinherited

get an identifier for Named-like object which may be Null

Definition at line 67 of file Named.h.

Referenced by MSLCM_LC2013::_wantsChange(), MSLCM_SL2015::_wantsChangeSublane(), MSDriveWay::addSidings(), MSLaneChanger::avoidDeadlock(), MSDriveWay::canUseSiding(), MSLaneChanger::changeOpposite(), MSLaneChanger::checkChangeOpposite(), MSDriveWay::checkFlanks(), MSVehicle::checkReversal(), MSVehicle::checkRewindLinkLanes(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), NBOwnTLDef::computeLogicAndConts(), MSDriveWay::conflictLaneOccupied(), NBPTLineCont::constructRoute(), MSLaneChanger::continueChange(), MSLane::detectCollisions(), MSVehicle::enterLaneAtLaneChange(), MSVehicle::executeMove(), NBRailwayTopologyAnalyzer::extendDirectionPriority(), NBPTLineCont::findWay(), MSDriveWay::foeDriveWayOccupied(), MSCFModel_CACC::followSpeed(), MSCFModel_W99::followSpeed(), MSStopOut::generateOutputForUnfinished(), MSVehicle::getBackPositionOnLane(), NBOwnTLDef::getBestCombination(), NBOwnTLDef::getBestPair(), MSVehicle::getCenterOnEdge(), MSLaneChanger::getColumnleader(), NBEdge::Connection::getDescription(), MSLane::getFollowersOnConsecutive(), GUIVehicle::getLaneID(), LIBSUMO_NAMESPACE::Person::getLaneID(), MSVehicle::getLatOffset(), MSLane::getLeaderOnConsecutive(), MSLaneChanger::getOncomingOppositeVehicle(), MSLaneChanger::getRealLeader(), GUIVehicle::getShadowLaneID(), GUIVehicle::getTargetLaneID(), MSDevice_SSM::getVehiclesOnJunction(), NBEdgeCont::guessRoundabouts(), MSDriveWay::hasLinkConflict(), MSCFModel_IDM::insertionFollowSpeed(), MSLane::isInsertionSuccess(), MESegment::isOpen(), joinNamedToString(), joinNamedToString(), joinNamedToStringSorting(), MSPModel_Striping::PState::moveToNextLane(), LIBSUMO_NAMESPACE::Person::moveToXY(), LIBSUMO_NAMESPACE::Vehicle::moveToXY(), MSPModel_Striping::PState::moveToXY(), libsumo::Helper::moveToXYMap(), libsumo::Helper::moveToXYMap_matchingRoutePosition(), MSDevice_Bluelight::notifyEnter(), MSDevice_Bluelight::notifyLeave(), MSDriveWay::notifyLeave(), MSDriveWay::notifyLeaveBack(), MSVehicle::Influencer::postProcessRemoteControl(), MSVehicle::processNextStop(), MSBaseVehicle::replaceRoute(), MSStoppingPlaceRerouter::reroute(), MSBaseVehicle::reroute(), MSLaneChanger::resolveDeadlock(), MSLCM_LC2013::slowDownForBlocked(), MSLCM_SL2015::slowDownForBlocked(), MSLaneChangerSublane::startChangeSublane(), MSLeaderInfo::toString(), MSLeaderDistanceInfo::toString(), MSCriticalFollowerDistanceInfo::toString(), toString(), toString(), toString(), MSTriggeredRerouter::triggerRouting(), MSVehicle::updateBestLanes(), MSLCHelper::updateBlockerLength(), MSAbstractLaneChangeModel::updateShadowLane(), MSPModel_Striping::PState::walk(), and MSLaneChanger::yieldToDeadlockOncoming().

◆ getImpatience()

virtual double SUMOVehicle::getImpatience ( ) const

pure virtual

Returns this vehicles impatience.

Implemented in MSBaseVehicle.

◆ getLane()

virtual const MSLane * SUMOTrafficObject::getLane ( ) const

pure virtualinherited

Returns the lane the object is currently at.

Returns: The current lane or nullptr if the object is not on a lane

Implemented in MEVehicle, MSVehicle, and MSTransportable.

Referenced by MSStageDriving::abort(), MSBaseVehicle::addStop(), libsumo::Helper::applySubscriptionFilters(), MSE2Collector::calculateTimeLossAndTimeOnDetector(), GUIBaseVehicle::drawOnPos(), MSDevice_StationFinder::estimateConsumption(), Command_RouteReplacement::execute(), MSStopOut::generateOutputForUnfinished(), LIBSUMO_NAMESPACE::Vehicle::getDrivingDistance(), LIBSUMO_NAMESPACE::Vehicle::getDrivingDistance2D(), MSStageDriving::getEdge(), MSStageDriving::getLane(), MSStoppingPlace::getLastFreePos(), MSParkingArea::getLastFreePosWithReservation(), LIBSUMO_NAMESPACE::Vehicle::getLeader(), MSDevice_BTsender::getLocation(), MSBaseVehicle::getRNG(), MSBaseVehicle::getRNGIndex(), MSBaseVehicle::insertStop(), LIBSUMO_NAMESPACE::Vehicle::isOnInit(), MSTransportableDevice_FCDReplay::move(), MSE2Collector::notifyEnter(), MSDevice_SSM::notifyEnter(), MSDevice_SSM::notifyLeave(), MSDevice_ElecHybrid::notifyMove(), MSDevice_Battery::notifyMove(), MSDevice_Friction::notifyMove(), MSDevice_ToC::notifyMove(), MSMeanData_Net::MSLaneMeanDataValues::notifyMoveInternal(), MSDevice_Taxi::prepareStop(), LIBSUMO_NAMESPACE::Vehicle::remove(), MSBaseVehicle::replaceRoute(), MSBaseVehicle::replaceStop(), MSDevice_ToC::requestToC(), MSStoppingPlaceRerouter::reroute(), MSBaseVehicle::reroute(), MSBaseVehicle::rerouteBetweenStops(), MSStageDriving::setArrived(), LIBSUMO_NAMESPACE::Vehicle::setRoute(), LIBSUMO_NAMESPACE::Vehicle::setRouteID(), MSDevice_ToC::triggerDownwardToC(), MSDevice_ToC::triggerMRM(), MSDevice_ToC::triggerUpwardToC(), and MSFCDExport::write().

Here is the caller graph for this function:

◆ getLastActionTime()

virtual SUMOTime SUMOVehicle::getLastActionTime ( ) const

pure virtual

Implemented in MEVehicle, and MSVehicle.

Referenced by MSLink::blockedByFoe().

Here is the caller graph for this function:

◆ getLateralPositionOnLane()

virtual double SUMOVehicle::getLateralPositionOnLane ( ) const

pure virtual

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)

Implemented in MSBaseVehicle, and MSVehicle.

Referenced by MSLink::opened(), and MSFCDExport::write().

Here is the caller graph for this function:

◆ getLength()

virtual double SUMOVehicle::getLength ( ) const

pure virtual

Returns the vehicles's length.

Implemented in MSBaseVehicle.

Referenced by MSStageDriving::canLeaveVehicle(), MSDriveWay::canUseSiding(), MSStoppingPlace::getLastFreePos(), MSDevice_StationFinder::getLastStepStoppingPlaceOccupancy(), MSDevice_StationFinder::getStoppingPlaceCapacity(), and MSDevice_StationFinder::getStoppingPlaceOccupancy().

Here is the caller graph for this function:

◆ getMaxSpeed()

virtual double SUMOTrafficObject::getMaxSpeed ( ) const

pure virtualinherited

Returns the object's maximum speed (minimum of technical and desired maximum speed)

Returns: The object's maximum speed

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSDevice_StationFinder::estimateConsumption(), MSEdge::getTravelTimeAggregated(), MSLane::getVehicleMaxSpeed(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ getNextEdgePtr()

virtual const MSEdge * SUMOTrafficObject::getNextEdgePtr ( ) const

pure virtualinherited

returns the next edge (possibly an internal edge)

Implemented in MSBaseVehicle, MSVehicle, MSPerson, and MSTransportable.

Referenced by MSDetectorFileOutput::vehicleApplies().

Here is the caller graph for this function:

◆ getNextParkingArea()

virtual MSParkingArea * SUMOVehicle::getNextParkingArea ( )

pure virtual

returns the next imminent stop in the stop queue

Returns: the upcoming stop

Implemented in MSBaseVehicle.

Referenced by MSStoppingPlaceRerouter::reroute(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ getNextStop()

virtual MSStop & SUMOVehicle::getNextStop ( )

pure virtual

returns the next imminent stop in the stop queue

Returns: the upcoming stop

Implemented in MSBaseVehicle.

Referenced by MSVehicleControl::abortWaiting(), MSDevice_Taxi::dispatchShared(), MSIdling_Stop::idle(), MSDevice_Transportable::notifyMove(), MSDevice_StationFinder::teleportToChargingStation(), MSDevice_Transportable::transferAtSplitOrJoin(), and MSDevice_Taxi::updateMove().

Here is the caller graph for this function:

◆ getNextStopParameter()

virtual const SUMOVehicleParameter::Stop * SUMOVehicle::getNextStopParameter ( ) const

pure virtual

Returns parameters of the next stop or nullptr.

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::cancelCurrentCustomers(), MSDriveWay::conflictLaneOccupied(), MSStopOut::generateOutputForUnfinished(), MSDriveWay::hasJoin(), and MSDevice_StationFinder::rerouteToChargingStation().

Here is the caller graph for this function:

◆ getNumberParkingReroutes()

virtual int SUMOVehicle::getNumberParkingReroutes ( ) const

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSTriggeredRerouter::getNumberStoppingPlaceReroutes().

Here is the caller graph for this function:

◆ getNumberReroutes()

virtual int SUMOVehicle::getNumberReroutes ( ) const

pure virtual

Returns the number of new routes this vehicle got.

Returns: the number of new routes this vehicle got

Implemented in MSBaseVehicle.

Referenced by MSDevice_Tripinfo::generateOutput(), and MSDevice_Vehroutes::writeXMLRoute().

Here is the caller graph for this function:

◆ getNumericalID()

virtual NumericalID SUMOTrafficObject::getNumericalID ( ) const

pure virtualinherited

return the numerical ID which is only for internal usage

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by LIBSUMO_NAMESPACE::TrafficLight::findConstraintsDeadLocks(), MSVehicleDevice::getNumericalID(), MSVehicleDevice::ComparatorNumericalVehicleIdLess::operator()(), MSMoveReminder::removeFromVehicleUpdateValues(), MSMoveReminder::updateDetector(), and MSDevice_Vehroutes::writeOutput().

Here is the caller graph for this function:

◆ getOdometer()

virtual double SUMOVehicle::getOdometer ( ) const

pure virtual

Returns the distance that was already driven by this vehicle.

Returns: the distance driven [m]

Implemented in MSBaseVehicle.

Referenced by MSStageDriving::getDistance(), MSStageDriving::setArrived(), MSStageDriving::setVehicle(), MSElecHybridExport::write(), MSFCDExport::write(), and MSElecHybridExport::writeAggregated().

Here is the caller graph for this function:

◆ getParameter()

virtual const SUMOVehicleParameter & SUMOTrafficObject::getParameter ( ) const

pure virtualinherited

Returns the vehicle's parameter (including departure definition)

Returns: The vehicle's parameter

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSVehicleControl::abortWaiting(), MSVehicleContainer::add(), MSRouteHandler::addRideOrTransport(), MSVehicleControl::addVehicle(), MSDevice_ElecHybrid::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), MSDevice_Routing::buildVehicleDevices(), MSDevice_Taxi::buildVehicleDevices(), MSDevice_Vehroutes::buildVehicleDevices(), MSRouteHandler::closeVehicle(), MSDevice_Taxi::compatibleLine(), MSRailSignal::constraintsAllow(), MSParkingArea::enter(), MSDevice_SSM::filterByConflictType(), LIBSUMO_NAMESPACE::TrafficLight::findConstraintsDeadLocks(), MSDevice_Tripinfo::generateOutput(), MSDevice_Tripinfo::generateOutputForUnfinished(), MSEdge::getDepartLaneMeso(), MSDevice_SSM::getDetectionRange(), MSDevice_SSM::getExtraTime(), MSDevice_SSM::getMDRAC_PRT(), MSDevice_SSM::getMeasuresAndThresholds(), MSDevice_SSM::getOutputFilename(), SUMOTrafficObject::getStringParam(), MSRailSignalConstraint::getVeh(), LIBSUMO_NAMESPACE::TrafficLight::getVehicleByTripId(), MSStoppingPlaceRerouter::getWeight(), MSVehicleControl::handleTriggeredDepart(), MSRailSignalControl::haveDeadlock(), MSLink::ignoreFoe(), MSRailSignal::initDriveWays(), MSEdge::insertVehicle(), MSStageDriving::isWaitingFor(), MSDevice_Routing::MSDevice_Routing(), MSDevice_Taxi::MSDevice_Taxi(), MSDevice_Vehroutes::notifyEnter(), MSRailSignalConstraint_Predecessor::PassedTracker::notifyEnter(), MSCalibrator::VehicleRemover::notifyEnter(), MSCalibrator::VehicleRemover::notifyLeave(), MSDevice_Routing::preInsertionReroute(), MSStageDriving::proceed(), MSDevice_Battery::readParameterValue(), MSVehicleContainer::remove(), MSDevice_SSM::requestsTrajectories(), MSStageTrip::reroute(), MSDevice_Taxi::setParameter(), MSStageDriving::setVehicle(), MSDevice_ToC::setVehicleColor(), MSTriggeredRerouter::triggerRouting(), MSInsertionControl::tryInsert(), MSDevice_SSM::useGeoCoords(), MSEdge::validateDepartSpeed(), MSVehicleControl::vehicleDeparted(), MSRailSignalControl::vehicleStateChanged(), MSDevice_SSM::writeLanesPositions(), MSDevice_Vehroutes::writeOutput(), MSDevice_SSM::writePositions(), and MSDevice_Vehroutes::writeXMLRoute().

◆ getPersonIDList()

virtual std::vector< std::string > SUMOVehicle::getPersonIDList ( ) const

pure virtual

Returns the list of persons.

Returns: The list of passengers on-board

Implemented in MSBaseVehicle.

◆ getPersonNumber()

virtual int SUMOVehicle::getPersonNumber ( ) const

pure virtual

Returns the number of persons.

Returns: The number of passengers on-board

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::customerArrived(), MSStageDriving::proceed(), and MSDevice_Taxi::updateMove().

Here is the caller graph for this function:

◆ getPersons()

virtual const std::vector< MSTransportable * > & SUMOVehicle::getPersons ( ) const

pure virtual

retrieve riding persons

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::cancelCurrentCustomers(), MSDevice_Taxi::dispatchShared(), MSTriggeredRerouter::triggerRouting(), and MSFCDExport::write().

Here is the caller graph for this function:

◆ getPosition()

virtual Position SUMOTrafficObject::getPosition ( const double offset = 0 ) const

pure virtualinherited

Return current position (x/y, cartesian)

If the object is not in the net, Position::INVALID.

Parameters

[in] offset optional offset in longitudinal direction

Returns: The current position (in cartesian coordinates)

See also: myLane

Implemented in GUIVehicle, GUIMEVehicle, MEVehicle, MSVehicle, and MSTransportable.

Referenced by libsumo::Helper::applySubscriptionFilterFieldOfVision(), libsumo::Helper::applySubscriptionFilterLateralDistanceSinglePass(), MSVTypeProbe::execute(), MSDevice_StationFinder::findChargingStation(), LIBSUMO_NAMESPACE::Vehicle::getPosition(), MSStageDriving::getPosition(), LIBSUMO_NAMESPACE::Vehicle::highlight(), PolygonDynamics::initTrackedPosition(), LIBSUMO_NAMESPACE::Vehicle::moveTo(), MSDevice_BTreceiver::notifyEnter(), MSDevice_BTsender::notifyEnter(), MSDevice_BTreceiver::notifyLeave(), MSDevice_BTsender::notifyLeave(), MSDevice_Bluelight::notifyMove(), MSDevice_BTreceiver::notifyMove(), MSDevice_BTsender::notifyMove(), MSDevice_ToC::notifyMove(), MSDevice_ToC::requestToC(), MSDevice_FCD::shapeFilter(), MSDevice_ToC::triggerDownwardToC(), MSDevice_ToC::triggerMRM(), MSDevice_ToC::triggerUpwardToC(), PolygonDynamics::update(), MSElecHybridExport::write(), MSFCDExport::write(), MSEmissionExport::write(), MSElecHybridExport::writeAggregated(), and MSFullExport::writeVehicles().

Here is the caller graph for this function:

◆ getPositionOnLane()

virtual double SUMOTrafficObject::getPositionOnLane ( ) const

pure virtualinherited

Get the object's position along the lane.

Returns: The position of the object (in m from the lane's begin)

Implemented in MEVehicle, MSVehicle, and MSTransportable.

Referenced by MSBaseVehicle::addStop(), MSDispatch::computePickupTime(), MSDevice_Taxi::dispatchShared(), GUIBaseVehicle::drawStopLabels(), MSParkingArea::enter(), MSStoppingPlace::enter(), MSStoppingPlaceRerouter::evaluateDestination(), MSVTypeProbe::execute(), LIBSUMO_NAMESPACE::TrafficLight::findConstraintsDeadLocks(), MSDevice_Tripinfo::generateOutput(), LIBSUMO_NAMESPACE::Vehicle::getDrivingDistance(), LIBSUMO_NAMESPACE::Vehicle::getDrivingDistance2D(), MSStageDriving::getEdgePos(), MSStop::getEndPos(), LIBSUMO_NAMESPACE::Vehicle::getLanePosition(), MSStoppingPlace::getLastFreePos(), MSParkingArea::getLotIndex(), MSBaseVehicle::getOdometer(), MSIdling_Stop::idle(), MSIdling_RandomCircling::idle(), MSBaseVehicle::insertStop(), MSE2Collector::makeVehicleInfo(), MSTransportableDevice_FCDReplay::move(), LIBSUMO_NAMESPACE::Vehicle::moveToXY(), MSDevice_BTreceiver::notifyEnter(), MSDevice_BTsender::notifyEnter(), MSDevice_Tripinfo::notifyEnter(), MSDevice_Vehroutes::notifyEnter(), MSInductLoop::notifyEnter(), MSDevice_BTreceiver::notifyLeave(), MSDevice_BTsender::notifyLeave(), MSDevice_Tripinfo::notifyLeave(), MSDevice_ElecHybrid::notifyMove(), MSDevice_Battery::notifyMove(), MSDevice_ToC::notifyMove(), MSDevice_Battery::notifyParking(), MSBaseVehicle::onDepart(), MSOverheadWire::vehicle_position_sorter::operator()(), MSBaseVehicle::replaceRoute(), MSBaseVehicle::replaceStop(), MSDevice_ToC::requestToC(), MSStoppingPlaceRerouter::reroute(), MSBaseVehicle::reroute(), MSBaseVehicle::rerouteBetweenStops(), MSStageDriving::setArrived(), MSStopOut::stopEnded(), MSDevice_ToC::triggerDownwardToC(), MSDevice_ToC::triggerMRM(), MSTriggeredRerouter::triggerRouting(), MSDevice_ToC::triggerUpwardToC(), MSElecHybridExport::write(), MSFCDExport::write(), MSEmissionExport::write(), MSElecHybridExport::writeAggregated(), MSDevice_Vehroutes::writeOutput(), MSXMLRawOut::writeVehicle(), and MSFullExport::writeVehicles().

◆ getPreviousSpeed()

virtual double SUMOTrafficObject::getPreviousSpeed ( ) const

pure virtualinherited

Returns the object's previous speed.

Returns: The object's previous speed

Implemented in MSBaseVehicle, MSVehicle, and MSTransportable.

Referenced by MSE2Collector::calculateTimeLossAndTimeOnDetector(), LIBSUMO_NAMESPACE::Vehicle::getJunctionFoes(), MSInductLoop::notifyMove(), MSInstantInductLoop::notifyMove(), MSMeanData::MeanDataValues::notifyMove(), MSE3Collector::MSE3LeaveReminder::notifyMove(), and MSE3Collector::MSE3EntryReminder::notifyMove().

Here is the caller graph for this function:

◆ getRerouteDestination()

virtual const MSEdge * SUMOTrafficObject::getRerouteDestination ( ) const

pure virtualinherited

Returns the end point for reroutes (usually the last edge of the route)

Returns: The rerouting end point

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ getRerouteOrigin()

virtual ConstMSEdgeVector::const_iterator SUMOVehicle::getRerouteOrigin ( ) const

pure virtual

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

This differs from myCurrEdge depending on braking distance and rail signals

Returns: The rerouting start point

Implemented in MSBaseVehicle, and MSVehicle.

Referenced by MSDevice_Taxi::dispatchShared(), and MSStoppingPlaceRerouter::evaluateDestination().

Here is the caller graph for this function:

◆ getRNG()

virtual SumoRNG * SUMOTrafficObject::getRNG ( ) const

pure virtualinherited

Returns the associated RNG for this object.

Returns: The vehicle's associated RNG

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSLink::blockedAtTime(), MSIdling_RandomCircling::idle(), MSDevice_Friction::notifyMove(), MSStoppingPlaceRerouter::reroute(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ getRNGIndex()

virtual int SUMOTrafficObject::getRNGIndex ( ) const

pure virtualinherited

Returns: The index of the associated RNG

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSDevice_Taxi::dispatchShared(), MSDevice_StationFinder::estimateConsumption(), MSDevice_StationFinder::getRouter(), MSStoppingPlaceRerouter::getRouter(), MSDevice_Routing::notifyEnter(), MSDevice_Taxi::prepareStop(), MSDevice_StationFinder::rerouteToChargingStation(), MSDevice_StationFinder::teleportToChargingStation(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ getRoute()

virtual const MSRoute & SUMOVehicle::getRoute ( ) const

pure virtual

Returns the current route.

Implemented in MSBaseVehicle.

Referenced by MSRouteHandler::addRideOrTransport(), MSDevice_Taxi::dispatchShared(), MSDevice_StationFinder::estimateConsumption(), MSStoppingPlaceRerouter::evaluateDestination(), Command_RouteReplacement::execute(), LIBSUMO_NAMESPACE::TrafficLight::findConstraintsDeadLocks(), MSDevice_SSM::findFoeConflictLane(), MSDriveWay::foeDriveWayOccupied(), MSDevice_Tripinfo::generateOutput(), MSDriveWay::getDepartureDriveway(), MSRailSignal::LinkInfo::getDriveWay(), MSVehicleControl::handleTriggeredDepart(), MSIdling_RandomCircling::idle(), MSRailSignal::initDriveWays(), MSDriveWay::notifyEnter(), MSDevice_Routing::preInsertionReroute(), MSStoppingPlaceRerouter::reroute(), MSRailSignal::LinkInfo::reroute(), MSTriggeredRerouter::triggerRouting(), MSDevice_FCDReplay::FCDHandler::updateTrafficObjects(), MSDetectorFileOutput::vehicleApplies(), MSEmissionExport::write(), MSDevice_Vehroutes::writeOutput(), MSFullExport::writeVehicles(), and MSDevice_Vehroutes::writeXMLRoute().

Here is the caller graph for this function:

◆ getRoutePosition()

virtual int SUMOTrafficObject::getRoutePosition ( ) const

pure virtualinherited

return index of edge within route

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSDevice_Vehroutes::addRoute(), MSDevice_Taxi::dispatchShared(), MSDevice_StationFinder::estimateConsumption(), LIBSUMO_NAMESPACE::TrafficLight::findConstraintsDeadLocks(), MSDevice_Tripinfo::generateOutput(), MSRailSignal::LinkInfo::getDriveWay(), MSIdling_RandomCircling::idle(), MSDevice_BTreceiver::notifyEnter(), MSDevice_BTsender::notifyEnter(), MSDevice_Vehroutes::notifyEnter(), MSDevice_BTreceiver::notifyLeave(), MSDevice_BTsender::notifyLeave(), MSDevice_BTreceiver::notifyMove(), and MSDevice_BTsender::notifyMove().

Here is the caller graph for this function:

◆ getRoutePtr()

virtual ConstMSRoutePtr SUMOVehicle::getRoutePtr ( ) const

pure virtual

Returns the current route.

Implemented in MSBaseVehicle.

Referenced by MSDevice_Vehroutes::addRoute(), and MSRouteProbe::notifyEnter().

Here is the caller graph for this function:

◆ getRouteValidity()

virtual int SUMOVehicle::getRouteValidity	(	bool	update = `true`,
		bool	silent = `false`,
		std::string *	msgReturn = `nullptr`
	)

pure virtual

computes validity attributes for the current route

Implemented in MSBaseVehicle.

Referenced by LIBSUMO_NAMESPACE::Vehicle::add(), MSEdge::insertVehicle(), and MSInsertionControl::tryInsert().

Here is the caller graph for this function:

◆ getRoutingMode()

virtual int SUMOTrafficObject::getRoutingMode ( ) const

pure virtualinherited

Implemented in MSBaseVehicle, and MSTransportable.

◆ getSlope()

virtual double SUMOTrafficObject::getSlope ( ) const

pure virtualinherited

Returns the slope of the road at object's position in degrees.

Returns: The slope

Implemented in MEVehicle, MSVehicle, and MSTransportable.

Referenced by MSDevice_ElecHybrid::acceleration(), MSDevice_ElecHybrid::consumption(), MSBaseVehicle::getEmissions(), LIBSUMO_NAMESPACE::Vehicle::getSlope(), MSDevice_Battery::notifyMove(), MSDevice_Emissions::notifyMove(), MSDevice_Emissions::notifyMoveInternal(), MSMeanData_Emissions::MSLaneMeanDataValues::notifyMoveInternal(), MSElecHybridExport::write(), MSFCDExport::write(), MSEmissionExport::write(), MSElecHybridExport::writeAggregated(), and MSFullExport::writeVehicles().

Here is the caller graph for this function:

◆ getSpeed()

virtual double SUMOTrafficObject::getSpeed ( ) const

pure virtualinherited

Returns the object's current speed.

Returns: The object's speed

Implemented in MEVehicle, MSVehicle, MSTransportable, GUIContainer, and GUIPerson.

Referenced by MSChargingStation::addChargeValueForOutput(), MSLink::blockedAtTime(), MSE2Collector::calculateTimeLossAndTimeOnDetector(), MSInductLoop::collectVehiclesOnDet(), MSE3Collector::detectorUpdate(), GUIBaseVehicle::drawOnPos(), MSE3Collector::enter(), MSVTypeProbe::execute(), MSVehicle::Influencer::gapControlSpeed(), MSRailSignal::LinkInfo::getDriveWay(), MSBaseVehicle::getEmissions(), MSVehicleControl::getHaltingVehicleNo(), MSBaseVehicle::getHarmonoise_NoiseEmissions(), LIBSUMO_NAMESPACE::Vehicle::getJunctionFoes(), MSStoppingPlace::getLastFreePos(), MSCFModel_CC::getRadarMeasurements(), GUIBaseVehicle::getScaleValue(), MSStageDriving::getSpeed(), LIBSUMO_NAMESPACE::Vehicle::getSpeed(), LIBSUMO_NAMESPACE::Vehicle::getSpeedWithoutTraCI(), MSVehicleControl::getVehicleMeanSpeeds(), MSBaseVehicle::isParking(), MSE3Collector::leave(), MSDevice_BTreceiver::notifyEnter(), MSDevice_BTsender::notifyEnter(), MSDevice_Tripinfo::notifyEnter(), MSDevice_Vehroutes::notifyEnter(), MSDevice_BTreceiver::notifyLeave(), MSDevice_BTsender::notifyLeave(), MSDevice_Tripinfo::notifyLeave(), MSInstantInductLoop::notifyLeave(), MSDevice_ElecHybrid::notifyMove(), MSDevice_Battery::notifyMove(), MSDevice_Bluelight::notifyMove(), MSDevice_Battery::notifyParking(), MSNet::registerCollision(), MSLink::setApproaching(), MSElecHybridExport::write(), MSFCDExport::write(), MSEmissionExport::write(), MSElecHybridExport::writeAggregated(), MSXMLRawOut::writeVehicle(), MSAmitranTrajectories::writeVehicle(), and MSFullExport::writeVehicles().

Here is the caller graph for this function:

◆ getStopIndices()

virtual std::vector< std::pair< int, double > > SUMOVehicle::getStopIndices ( ) const

pure virtual

return list of route indices and stop positions for the remaining stops

Implemented in MSBaseVehicle.

Referenced by MSStoppingPlaceRerouter::evaluateDestination().

Here is the caller graph for this function:

◆ getStops()

virtual const std::list< MSStop > & SUMOVehicle::getStops ( ) const

pure virtual

returns the list of stops not yet reached in the stop queue

Returns: the list of upcoming stops

Implemented in MSBaseVehicle.

Referenced by MSDevice_StationFinder::alreadyPlannedCharging(), MSDevice_Taxi::customerArrived(), MSDevice_Taxi::dispatchShared(), MSStoppingPlace::getLastFreePos(), MSDevice_Taxi::hasFuturePickup(), MSDriveWay::hasJoin(), MSDevice_Vehroutes::notifyStopEnded(), and MSStoppingPlaceRerouter::reroute().

Here is the caller graph for this function:

◆ getStringParam()

std::string SUMOTrafficObject::getStringParam	(	const std::string &	paramName,
		const bool	required = `false`,
		const std::string &	deflt = `""`
	)		const

inherited

Retrieve a string parameter for the traffic object.

Parameters

paramName	the parameter name
required	whether it is an error if the parameter is not set
deflt	the default value to take if the parameter is not set (the default in the OptionsCont takes precedence)

Returns: the string value

Definition at line 33 of file SUMOTrafficObject.cpp.

References OptionsCont::exists(), Named::getID(), OptionsCont::getOptions(), SUMOTrafficObject::getParameter(), Parameterised::getParameter(), OptionsCont::getValueString(), SUMOTrafficObject::getVTypeParameter(), SUMOTrafficObject::isPerson(), OptionsCont::isSet(), SUMOTrafficObject::isVehicle(), and TLF.

Referenced by MSDevice_ToC::buildVehicleDevices(), MSDevice_Battery::buildVehicleDevices(), SUMOTrafficObject::getBoolParam(), SUMOTrafficObject::getFloatParam(), MSDevice_Taxi::getParameter(), SUMOTrafficObject::getTimeParam(), MSBaseVehicle::initTransientModelParams(), MSDevice_Taxi::MSDevice_Taxi(), MSTransportableDevice_Routing::MSTransportableDevice_Routing(), and MSDevice_Taxi::prepareStop().

Here is the caller graph for this function:

◆ getTimeLoss()

virtual SUMOTime SUMOVehicle::getTimeLoss ( ) const

pure virtual

Implemented in MEVehicle, and MSVehicle.

Referenced by MSStageDriving::setArrived(), and MSStageDriving::setVehicle().

Here is the caller graph for this function:

◆ getTimeParam()

SUMOTime SUMOTrafficObject::getTimeParam	(	const std::string &	paramName,
		const bool	required = `false`,
		const SUMOTime	deflt = `SUMOTime_MIN`
	)		const

inherited

Retrieve a time parameter for the traffic object.

Parameters

paramName	the parameter name
required	whether it is an error if the parameter is not set
deflt	the default value to take if the parameter is not set (the default in the OptionsCont takes precedence)

Returns: the time value

Definition at line 89 of file SUMOTrafficObject.cpp.

References Named::getID(), SUMOTrafficObject::getStringParam(), SUMOTrafficObject::isPerson(), SUMOTrafficObject::isVehicle(), string2time(), time2string(), TL, and WRITE_ERRORF.

Referenced by MSTransportableDevice_Routing::buildDevices(), and MSDevice_Routing::buildVehicleDevices().

Here is the caller graph for this function:

◆ getUpcomingEdgeIDs()

virtual const std::set< NumericalID > SUMOTrafficObject::getUpcomingEdgeIDs ( ) const

pure virtualinherited

returns the numerical IDs of edges to be used (possibly of future stages)

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSTriggeredRerouter::getCurrentReroute(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ getVClass()

virtual SUMOVehicleClass SUMOTrafficObject::getVClass ( ) const

pure virtualinherited

Returns the object's access class.

Returns: The object's access class

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSVehicleControl::addVehicle(), MSDevice_Taxi::buildVehicleDevices(), MSDevice_Taxi::dispatchShared(), MSDevice_StationFinder::estimateConsumption(), MSDevice_Tripinfo::generateOutput(), MSRoutingEngine::getEffortExtra(), MSDevice_StationFinder::getRouter(), MSDevice_Taxi::getStopLane(), MSLane::getVehicleMaxSpeed(), MSIdling_RandomCircling::idle(), MSRoutingEngine::initRouter(), MSDevice_Routing::notifyEnter(), MSDevice_Tripinfo::notifyEnter(), MSDevice_Tripinfo::notifyLeave(), MSDetectorFileOutput::personApplies(), MSDevice_Taxi::prepareStop(), MSEdge::prohibits(), MSDevice_Routing::reroute(), MSRoutingEngine::reroute(), MSDevice_StationFinder::rerouteToChargingStation(), MSStageDriving::setVehicle(), MSDevice_StationFinder::teleportToChargingStation(), MSTriggeredRerouter::triggerRouting(), MSVehicleControl::vehicleDeparted(), MSRailSignalControl::vehicleStateChanged(), MSDevice_Vehroutes::writeOutput(), and MSDevice_Vehroutes::writeXMLRoute().

Here is the caller graph for this function:

◆ getVehicleType()

virtual const MSVehicleType & SUMOTrafficObject::getVehicleType ( ) const

pure virtualinherited

Returns the object's "vehicle" type.

Returns: The vehicle's type

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by MSChargingStation::addChargeValueForOutput(), MSOverheadWire::addChargeValueForOutput(), MSTriggeredRerouter::applies(), MSLink::blockedAtTime(), MSLink::blockedByFoe(), MSDevice_ElecHybrid::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), MSDevice_Taxi::buildVehicleDevices(), MSDevice_FCDReplay::FCDHandler::checkRoute(), MSLink::computeFoeArrivalTimeBraking(), MSDevice_SSM::computeGlobalMeasures(), MSRailSignal::constraintsAllow(), MSParkingArea::enter(), MSStoppingPlace::enter(), MSDevice_StationFinder::evaluateCustomComponents(), MSVTypeProbe::execute(), MSDevice_SSM::filterByConflictType(), MSStoppingPlace::fits(), MSDriveWay::foeDriveWayOccupied(), MSDevice_StationFinder::freeSpaceAtChargingStation(), MSDevice_Tripinfo::generateOutput(), MSEdge::getDepartLaneMeso(), MSDevice_SSM::getDetectionRange(), MSDevice_SSM::getExtraTime(), MSParkingArea::getLastFreePos(), MSStoppingPlace::getLastFreePos(), MSParkingArea::getLastFreePosWithReservation(), MSDevice_StationFinder::getLastStepStoppingPlaceOccupancy(), MSDevice_SSM::getMDRAC_PRT(), MSDevice_SSM::getMeasuresAndThresholds(), MSDevice_SSM::getOutputFilename(), MSDevice_StationFinder::getStoppingPlaceCapacity(), MSDevice_StationFinder::getStoppingPlaceOccupancy(), MSStoppingPlaceRerouter::getWeight(), MSIdling_Stop::idle(), MSIdling_TaxiStand::idle(), MSLink::ignoreFoe(), MSVehicle::ignoreFoe(), MSEdge::insertVehicle(), MSTransportableControl::loadAnyWaiting(), MSE2Collector::makeVehicleInfo(), MSDevice_Battery::MSDevice_Battery(), MSDevice_ElecHybrid::MSDevice_ElecHybrid(), MSDevice_ToC::MSDevice_ToC(), MSMeanData_Amitran::MSLaneMeanDataValues::notifyEnter(), MSCalibrator::VehicleRemover::notifyEnter(), MSE3Collector::MSE3EntryReminder::notifyEnter(), MSDevice_Emissions::notifyIdle(), MSMeanData_Emissions::MSLaneMeanDataValues::notifyIdle(), MSDevice_Battery::notifyMove(), MSDevice_Bluelight::notifyMove(), MSDevice_Emissions::notifyMove(), MSDevice_Transportable::notifyMove(), MSE2Collector::notifyMove(), MSInductLoop::notifyMove(), MSInstantInductLoop::notifyMove(), MSMeanData::MeanDataValues::notifyMove(), MSDevice_StationFinder::notifyMove(), MSE3Collector::MSE3LeaveReminder::notifyMove(), MSDevice_Emissions::notifyMoveInternal(), MSMeanData_Net::MSLaneMeanDataValues::notifyMoveInternal(), MSMeanData_Harmonoise::MSLaneMeanDataValues::notifyMoveInternal(), MSMeanData_Amitran::MSLaneMeanDataValues::notifyMoveInternal(), MSMeanData_Emissions::MSLaneMeanDataValues::notifyMoveInternal(), MSLink::opened(), MSDevice_Taxi::prepareStop(), MSStageDriving::proceed(), MSDevice_Battery::readParameterValue(), MSNet::registerCollision(), MSDispatch::remainingCapacity(), MSDevice_SSM::requestsTrajectories(), MSLink::setApproaching(), MSStageDriving::setVehicle(), MSStopOut::stopEnded(), MSLane::succLinkSec(), MSDevice_SSM::useGeoCoords(), MSEdge::validateDepartSpeed(), MSDetectorFileOutput::vehicleApplies(), MSVehicleControl::vehicleDeparted(), MSInstantInductLoop::write(), MSFCDExport::write(), MSEmissionExport::write(), MSDevice_SSM::writeLanesPositions(), MSDevice_Vehroutes::writeOutput(), MSDevice_SSM::writePositions(), MSAmitranTrajectories::writeVehicle(), and MSFullExport::writeVehicles().

◆ getVTypeParameter()

virtual const SUMOVTypeParameter & SUMOTrafficObject::getVTypeParameter ( ) const

pure virtualinherited

Returns the object's "vehicle" type parameter.

Returns: The type parameter

Implemented in MSBaseVehicle, and MSTransportable.

Referenced by SUMOTrafficObject::getStringParam().

Here is the caller graph for this function:

◆ getWaitingTime()

virtual SUMOTime SUMOTrafficObject::getWaitingTime ( const bool accumulated = false ) const

pure virtualinherited

Implemented in MEVehicle, MSVehicle, and MSTransportable.

Referenced by MSRailSignal::constraintsAllow(), MSDriveWay::foeDriveWayOccupied(), MSBaseVehicle::getImpatience(), MSBaseVehicle::getWaitingSeconds(), MSDevice_Tripinfo::notifyMoveInternal(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ hasArrived()

virtual bool SUMOTrafficObject::hasArrived ( ) const

pure virtualinherited

Returns whether this object has arrived.

Implemented in MEVehicle, MSBaseVehicle, MSVehicle, and MSTransportable.

Referenced by MSStateHandler::closeVehicle(), and MSMeanData::MeanDataValues::notifyMove().

Here is the caller graph for this function:

◆ hasDeparted()

virtual bool SUMOVehicle::hasDeparted ( ) const

pure virtual

Returns whether this vehicle has departed.

Implemented in MSBaseVehicle.

Referenced by MSVehicleControl::abortWaiting(), MSDevice_Vehroutes::addRoute(), MSStateHandler::closeVehicle(), LIBSUMO_NAMESPACE::TrafficLight::findConstraintsDeadLocks(), MSDevice_Tripinfo::generateOutput(), MSDevice_Tripinfo::generateOutputForUnfinished(), LIBSUMO_NAMESPACE::Vehicle::getTeleportingIDList(), MSDriveWay::hasJoin(), MSStopOut::loadedContainers(), MSStopOut::loadedPersons(), MSDevice_Routing::loadState(), MSStageDriving::proceed(), MSDevice_Tripinfo::saveState(), MSStageDriving::setVehicle(), and MSRailSignalControl::vehicleStateChanged().

Here is the caller graph for this function:

◆ hasInfluencer()

virtual bool SUMOTrafficObject::hasInfluencer ( ) const

pure virtualinherited

whether the vehicle is individually influenced (via TraCI or special parameters)

Implemented in MEVehicle, MSVehicle, MSPerson, MSTransportable, and MSBaseVehicle.

◆ hasStops()

virtual bool SUMOVehicle::hasStops ( ) const

pure virtual

Returns whether the vehicle has to stop somewhere.

Returns: Whether the vehicle has to stop somewhere

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::dispatchShared(), MSStoppingPlace::getLastFreePos(), MSIdling_Stop::idle(), and MSDevice_StationFinder::rerouteToChargingStation().

Here is the caller graph for this function:

◆ hasValidRoute()

virtual bool SUMOVehicle::hasValidRoute	(	std::string &	msg,
		ConstMSRoutePtr	route = `0`
	)		const

pure virtual

Validates the current or given route.

Parameters

[out]	msg	Description why the route is not valid (if it is the case)
[in]	route	The route to check (or 0 if the current route shall be checked)

Returns: Whether the vehicle's current route is valid

Implemented in MSBaseVehicle.

Referenced by Command_RouteReplacement::execute(), MSRailSignalControl::vehicleStateChanged(), and MSDevice_Vehroutes::writeOutput().

Here is the caller graph for this function:

◆ hasValidRouteStart()

virtual bool SUMOVehicle::hasValidRouteStart ( std::string & msg )

pure virtual

checks wether the vehicle can depart on the first edge

Implemented in MSBaseVehicle, and MSVehicle.

Referenced by MSDevice_Routing::preInsertionReroute().

Here is the caller graph for this function:

◆ ignoreTransientPermissions()

virtual bool SUMOTrafficObject::ignoreTransientPermissions ( ) const

inlinevirtualinherited

Returns whether this object is ignoring transient permission changes (during routing)

Reimplemented in MSBaseVehicle.

Definition at line 182 of file SUMOTrafficObject.h.

Referenced by MSEdge::prohibits().

Here is the caller graph for this function:

◆ isContainer()

virtual bool SUMOTrafficObject::isContainer ( ) const

inlinevirtualinherited

Whether it is a container.

Returns: true for containers, false otherwise

Reimplemented in MSTransportable.

Definition at line 81 of file SUMOTrafficObject.h.

◆ isFrontOnLane()

virtual bool SUMOVehicle::isFrontOnLane ( const MSLane * ) const

pure virtual

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

Returns: Whether the vehicle's front is on that lane

Implemented in MSBaseVehicle, and MSVehicle.

◆ isIdling()

virtual bool SUMOVehicle::isIdling ( ) const

pure virtual

Returns whether the vehicle is idling (waiting to re-enter the net.

Returns: true if the vehicle is waiting to enter the net (eg after parking)

Implemented in MEVehicle, and MSVehicle.

Referenced by MSBaseVehicle::getEmissions(), MSBaseVehicle::getHarmonoise_NoiseEmissions(), and MSEmissionExport::write().

Here is the caller graph for this function:

◆ isLineStop()

virtual bool SUMOVehicle::isLineStop ( double position ) const

pure virtual

returns whether the vehicle serves a public transport line that serves the given stop

Implemented in MSBaseVehicle.

◆ isOnRoad()

virtual bool SUMOVehicle::isOnRoad ( ) const

pure virtual

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

Returns: Whether the vehicle is simulated

Implemented in MEVehicle, MSBaseVehicle, and MSVehicle.

Referenced by MSVTypeProbe::execute(), MSDriveWay::foeDriveWayOccupied(), MSVehicleControl::getHaltingVehicleNo(), MSVehicleControl::getVehicleMeanSpeeds(), GUIMEVehicleControl::insertVehicleIDs(), GUIVehicleControl::insertVehicleIDs(), LIBSUMO_NAMESPACE::Vehicle::isVisible(), MSFCDExport::isVisible(), MSInsertionControl::tryInsert(), MSDevice_SSM::updateAndWriteOutput(), MSElecHybridExport::write(), MSEmissionExport::write(), MSElecHybridExport::writeAggregated(), MSNet::writeOutput(), MSAmitranTrajectories::writeVehicle(), and MSFullExport::writeVehicles().

Here is the caller graph for this function:

◆ isParking()

virtual bool SUMOVehicle::isParking ( ) const

pure virtual

Returns the information whether the vehicle is parked.

Returns: Whether the vehicle is parked

Implemented in MSBaseVehicle.

Referenced by GUIVehicleControl::insertVehicleIDs(), LIBSUMO_NAMESPACE::Vehicle::isVisible(), MSFCDExport::isVisible(), and MSDevice_Battery::notifyMove().

Here is the caller graph for this function:

◆ isPerson()

virtual bool SUMOTrafficObject::isPerson ( ) const

inlinevirtualinherited

Whether it is a person.

Returns: true for persons, false otherwise

Reimplemented in MSTransportable.

Definition at line 74 of file SUMOTrafficObject.h.

Referenced by MSE3Collector::enter(), SUMOTrafficObject::getBoolParam(), SUMOTrafficObject::getFloatParam(), SUMOTrafficObject::getStringParam(), SUMOTrafficObject::getTimeParam(), MSE3Collector::leave(), MSE3Collector::leaveFront(), MSE2Collector::notifyEnter(), MSInductLoop::notifyEnter(), MSE2Collector::notifyLeave(), MSInductLoop::notifyLeave(), MSE2Collector::notifyMove(), MSInductLoop::notifyMove(), MSE3Collector::MSE3EntryReminder::notifyMove(), and MSDetectorFileOutput::vehicleApplies().

Here is the caller graph for this function:

◆ isRemoteControlled()

virtual bool SUMOVehicle::isRemoteControlled ( ) const

pure virtual

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

Returns: Whether the vehicle is remote-controlled

Implemented in MSBaseVehicle, and MSVehicle.

Referenced by MSVehicleControl::getHaltingVehicleNo(), MSVehicleControl::getVehicleMeanSpeeds(), and MSFCDExport::isVisible().

Here is the caller graph for this function:

◆ isSelected()

virtual bool SUMOTrafficObject::isSelected ( ) const

pure virtualinherited

whether this object is selected in the GUI

Implemented in GUIVehicle, MSBaseVehicle, MSPerson, MSTransportable, GUIContainer, and GUIPerson.

Referenced by MSLink::blockedByFoe().

Here is the caller graph for this function:

◆ isStopped()

virtual bool SUMOVehicle::isStopped ( ) const

pure virtual

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

Implements SUMOTrafficObject.

Implemented in MSBaseVehicle.

Referenced by MSVehicleControl::getVehicleMeanSpeeds(), MSDriveWay::hasJoin(), MSDevice_Transportable::notifyMove(), MSDevice_StationFinder::notifyMove(), MSDevice_Transportable::removeTransportable(), MSDevice_StationFinder::teleportToChargingStation(), MSDevice_Taxi::updateMove(), and MSDevice_Routing::wrappedRerouteCommandExecute().

Here is the caller graph for this function:

◆ isStoppedInRange()

virtual bool SUMOVehicle::isStoppedInRange	(	const double	pos,
		const double	tolerance,
		bool	checkFuture = `false`
	)		const

pure virtual

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

Implemented in MSBaseVehicle.

Referenced by MSTransportableControl::hasAnyWaiting(), and MSTransportableControl::loadAnyWaiting().

Here is the caller graph for this function:

◆ isStoppedParking()

virtual bool SUMOVehicle::isStoppedParking ( ) const

pure virtual

Returns whether the vehicle is at a stop and parking.

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::dispatchShared().

Here is the caller graph for this function:

◆ isStoppedTriggered()

virtual bool SUMOVehicle::isStoppedTriggered ( ) const

pure virtual

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

Implemented in MSBaseVehicle.

Referenced by MSVehicleControl::abortWaiting(), and MSDevice_Taxi::dispatchShared().

Here is the caller graph for this function:

◆ isVehicle()

virtual bool SUMOTrafficObject::isVehicle ( ) const

inlinevirtualinherited

Whether it is a vehicle.

Returns: true for vehicles, false otherwise

Reimplemented in MSBaseVehicle.

Definition at line 67 of file SUMOTrafficObject.h.

Referenced by libsumo::Helper::debugPrint(), MSE3Collector::enter(), SUMOTrafficObject::getBoolParam(), SUMOTrafficObject::getFloatParam(), SUMOTrafficObject::getStringParam(), SUMOTrafficObject::getTimeParam(), MSE3Collector::leave(), MSE3Collector::leaveFront(), MSDevice_ElecHybrid::notifyEnter(), MSE2Collector::notifyEnter(), MSDevice_SSM::notifyEnter(), MSMeanData_Net::MSLaneMeanDataValues::notifyEnter(), MSDriveWay::notifyEnter(), MSDevice_Tripinfo::notifyIdle(), MSMeanData_Emissions::MSLaneMeanDataValues::notifyIdle(), MSDevice_ElecHybrid::notifyLeave(), MSDevice_SSM::notifyLeave(), MSMeanData_Net::MSLaneMeanDataValues::notifyLeave(), MSDriveWay::notifyLeave(), MSDriveWay::notifyLeaveBack(), MSDevice_ElecHybrid::notifyMove(), MSDevice_Battery::notifyMove(), MSDevice_Example::notifyMove(), MSMeanData_Emissions::MSLaneMeanDataValues::notifyMoveInternal(), MSTriggeredRerouter::triggerRouting(), and MSDetectorFileOutput::vehicleApplies().

Here is the caller graph for this function:

◆ loadState()

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

pure virtual

Loads the state of this vehicle from the given description.

Implemented in MEVehicle, and MSVehicle.

Referenced by MSStateHandler::closeVehicle().

Here is the caller graph for this function:

◆ onDepart()

virtual void SUMOVehicle::onDepart ( )

pure 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.

Implemented in MSBaseVehicle.

◆ remainingStopDuration()

virtual SUMOTime SUMOVehicle::remainingStopDuration ( ) const

pure virtual

Returns the remaining stop duration for a stopped vehicle or 0.

Implemented in MEVehicle, and MSVehicle.

Referenced by MSStoppingPlace::getLastFreePos().

Here is the caller graph for this function:

◆ rememberBlockedChargingStation()

virtual void SUMOVehicle::rememberBlockedChargingStation	(	const MSStoppingPlace *	cs,
		bool	local
	)

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSDevice_StationFinder::rememberBlockedStoppingPlace().

Here is the caller graph for this function:

◆ rememberBlockedParkingArea()

virtual void SUMOVehicle::rememberBlockedParkingArea	(	const MSStoppingPlace *	pa,
		bool	local
	)

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSTriggeredRerouter::rememberBlockedStoppingPlace().

Here is the caller graph for this function:

◆ rememberChargingStationScore()

virtual void SUMOVehicle::rememberChargingStationScore	(	const MSStoppingPlace *	cs,
		const std::string &	score
	)

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSDevice_StationFinder::rememberStoppingPlaceScore().

Here is the caller graph for this function:

◆ rememberParkingAreaScore()

virtual void SUMOVehicle::rememberParkingAreaScore	(	const MSStoppingPlace *	pa,
		const std::string &	score
	)

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSTriggeredRerouter::rememberStoppingPlaceScore().

Here is the caller graph for this function:

◆ removeTransportable()

virtual void SUMOVehicle::removeTransportable ( MSTransportable * t )

pure virtual

removes a person or container

Implemented in MSBaseVehicle.

Referenced by MSStageDriving::abort(), and MSTransportable::~MSTransportable().

Here is the caller graph for this function:

◆ replaceParameter()

virtual void SUMOVehicle::replaceParameter ( const SUMOVehicleParameter * newParameter )

pure virtual

Replaces the vehicle's parameter.

Implemented in MSBaseVehicle.

Referenced by MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ replaceParkingArea()

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

pure virtual

Replaces a stop.

The stop replace the next stop into the sorted list.

Parameters

[in] stop The stop to add

Returns: Whether the stop could be added

Implemented in MSBaseVehicle.

Referenced by MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ replaceRoute()

virtual bool SUMOTrafficObject::replaceRoute	(	ConstMSRoutePtr	route,
		const std::string &	info,
		bool	onInit = `false`,
		int	offset = `0`,
		bool	addStops = `true`,
		bool	removeStops = `true`,
		std::string *	msgReturn = `nullptr`
	)

pure virtualinherited

Replaces the current route by the given one.

Implemented in MEVehicle, MSBaseVehicle, MSVehicle, and MSTransportable.

Referenced by Command_RouteReplacement::execute(), MSDevice_Routing::preInsertionReroute(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ replaceRouteEdges()

virtual bool SUMOVehicle::replaceRouteEdges	(	ConstMSEdgeVector &	edges,
		double	cost,
		double	savings,
		const std::string &	info,
		bool	onInit = `false`,
		bool	check = `false`,
		bool	removeStops = `true`,
		std::string *	msgReturn = `nullptr`
	)

pure 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]	edges	The new list of edges to pass
[in]	onInit	Whether the vehicle starts with this route
[in]	check	Whether the route should be checked for validity
[in]	removeStops	Whether stops should be removed if they do not fit onto the new route

Returns: Whether the new route was accepted

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::dispatchShared(), MSIdling_RandomCircling::idle(), MSStageTrip::reroute(), MSTriggeredRerouter::triggerRouting(), and MSDevice_FCDReplay::FCDHandler::updateTrafficObjects().

Here is the caller graph for this function:

◆ replaceVehicleType()

virtual void SUMOTrafficObject::replaceVehicleType ( MSVehicleType * type )

pure virtualinherited

Replaces the current vehicle type by the one given.

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

Parameters

[in] type The new vehicle type

See also: MSTransportable::myVType

Implemented in MSBaseVehicle, MSVehicle, and MSTransportable.

Referenced by MSCalibrator::VehicleRemover::notifyEnter(), and MSCalibrator::VehicleRemover::notifyLeave().

Here is the caller graph for this function:

◆ reroute()

virtual bool SUMOVehicle::reroute	(	SUMOTime	t,
		const std::string &	info,
		SUMOAbstractRouter< MSEdge, SUMOVehicle > &	router,
		const bool	onInit = `false`,
		const bool	withTaz = `false`,
		const bool	silent = `false`,
		const MSEdge *	sink = `nullptr`
	)

pure 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]	t	The time for which the route is computed
[in]	router	The router to use

Returns: whether a valid route was found

See also: replaceRoute

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::dispatchShared(), MSDevice_Routing::notifyEnter(), MSRoutingEngine::reroute(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ resetChargingStationScores()

virtual void SUMOVehicle::resetChargingStationScores ( )

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSDevice_StationFinder::resetStoppingPlaceScores().

Here is the caller graph for this function:

◆ resetParkingAreaScores()

virtual void SUMOVehicle::resetParkingAreaScores ( )

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSTriggeredRerouter::resetStoppingPlaceScores().

Here is the caller graph for this function:

◆ saveState()

virtual void SUMOVehicle::saveState ( OutputDevice & out )

pure virtual

Saves the states of a vehicle.

Implemented in MEVehicle, MSBaseVehicle, and MSVehicle.

◆ sawBlockedChargingStation()

virtual SUMOTime SUMOVehicle::sawBlockedChargingStation	(	const MSStoppingPlace *	cs,
		bool	local
	)		const

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSDevice_StationFinder::sawBlockedStoppingPlace().

Here is the caller graph for this function:

◆ sawBlockedParkingArea()

virtual SUMOTime SUMOVehicle::sawBlockedParkingArea	(	const MSStoppingPlace *	pa,
		bool	local
	)		const

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSTriggeredRerouter::sawBlockedStoppingPlace().

Here is the caller graph for this function:

◆ setArrivalPos()

virtual void SUMOVehicle::setArrivalPos ( double arrivalPos )

pure virtual

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

Implemented in MSBaseVehicle.

Referenced by MSStageTrip::reroute(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ setChosenSpeedFactor()

virtual void SUMOVehicle::setChosenSpeedFactor ( const double factor )

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSStateHandler::closeVehicle(), LIBSUMO_NAMESPACE::Simulation::findIntermodalRoute(), MSRoutingEngine::initRouter(), and MSEdge::validateDepartSpeed().

Here is the caller graph for this function:

◆ setID()

virtual void Named::setID ( const std::string & newID )

inlinevirtualinherited

resets the id

Parameters

[in] newID The new id of this object

Reimplemented in MSBaseVehicle, MSTransportable, and NBLoadedSUMOTLDef.

Definition at line 82 of file Named.h.

References Named::myID.

Referenced by Distribution_Parameterized::parse(), NBLoadedSUMOTLDef::reconstructLogic(), NBEdgeCont::rename(), NBNodeCont::rename(), GNEJunction::setAttribute(), NBLoadedSUMOTLDef::setID(), and IntermodalNetwork< E, L, N, V >::splitEdge().

Here is the caller graph for this function:

◆ setNumberParkingReroutes()

virtual void SUMOVehicle::setNumberParkingReroutes ( int value )

pure virtual

Implemented in MSBaseVehicle.

Referenced by MSParkingArea::enter(), and MSTriggeredRerouter::setNumberStoppingPlaceReroutes().

Here is the caller graph for this function:

◆ stopsAt()

virtual bool SUMOVehicle::stopsAt ( MSStoppingPlace * stop ) const

pure virtual

Returns whether the vehicle stops at the given stopping place.

Implemented in MSBaseVehicle.

Referenced by MSStageDriving::isWaitingFor().

Here is the caller graph for this function:

◆ stopsAtEdge()

virtual bool SUMOVehicle::stopsAtEdge ( const MSEdge * edge ) const

pure virtual

Returns whether the vehicle stops at the given edge.

Implemented in MSBaseVehicle.

Referenced by MSStageDriving::isWaitingFor().

Here is the caller graph for this function:

◆ succEdge()

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

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 MSBaseVehicle.

Referenced by MSLane::succLinkSec().

Here is the caller graph for this function:

◆ unregisterWaiting()

virtual void SUMOVehicle::unregisterWaiting ( )

pure virtual

mark vehicle as active

Implemented in MSBaseVehicle.

Referenced by MSDevice_Taxi::dispatchShared().

Here is the caller graph for this function:

◆ wasRemoteControlled()

virtual bool SUMOVehicle::wasRemoteControlled ( SUMOTime lookBack = DELTA_T ) const

pure virtual

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

Returns: Whether the vehicle was remote-controlled within the given time range

Implemented in MSBaseVehicle, and MSVehicle.

Referenced by LIBSUMO_NAMESPACE::Vehicle::isVisible().

Here is the caller graph for this function:

Field Documentation

◆ myID

std::string Named::myID

protectedinherited

The name of the object.

Definition at line 125 of file Named.h.

Referenced by MSDriveWay::addBidiFoes(), MSE2Collector::addDetectorToLanes(), MSDriveWay::addFoes(), MSDriveWay::addParallelFoes(), MSDriveWay::addReversalFoes(), MSDriveWay::addSwitchFoes(), RODFDetector::buildDestinationDistribution(), MSDriveWay::buildDriveWay(), NGEdge::buildNBEdge(), NGNode::buildNBNode(), MSSOTLTrafficLightLogic::checkPhases(), NBNode::computeNodeShape(), NEMALogic::constructTimingAndPhaseDefs(), MSE2Collector::detectorUpdate(), GNEPOI::getAttribute(), GNEPoly::getAttribute(), MSLane::getCanonicalPredecessorLane(), MSLane::getCanonicalSuccessorLane(), Named::getID(), NBEdge::getLaneID(), NEMALogic::getPhaseObj(), ROEdge::getStoredEffort(), GNEPOI::getSumoBaseObject(), MSLane::getSurroundingVehicles(), ROEdge::getTravelTime(), NBEdge::init(), MSSOTLTrafficLightLogic::init(), MSDelayBasedTrafficLightLogic::init(), NEMALogic::init(), MSLane::isInsertionSuccess(), NBNode::NBNode(), NBNode::NBNode(), MSE2Collector::notifyEnter(), MSE2Collector::notifyLeave(), MSE2Collector::notifyMove(), MSMeanData::openInterval(), NEMALogic::parseControllerType(), RORouteDef::preComputeCurrentRoute(), NBEdge::reinitNodes(), GNEPOI::setAttribute(), GNEPoly::setAttribute(), NBEdge::setGeometry(), Named::setID(), MSSOTLTrafficLightLogic::setToATargetPhase(), Distribution_Parameterized::toStr(), MSChargingStation::writeAggregatedChargingStationOutput(), MSDriveWay::writeBlocks(), MSDriveWay::writeBlockVehicles(), MSChargingStation::writeChargingStationOutput(), RODFDetector::writeEmitterDefinition(), MSOverheadWire::writeOverheadWireSegmentOutput(), RODFDetector::writeSingleSpeedTrigger(), MSTractionSubstation::writeTractionSubstationOutput(), MEInductLoop::writeXMLOutput(), and MSE3Collector::writeXMLOutput().

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

SUMOVehicle.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ NumericalID

Constructor & Destructor Documentation

◆ SUMOVehicle()

◆ ~SUMOVehicle()

Member Function Documentation

◆ abortNextStop()

◆ addStop()

◆ addTo()

◆ addTraciStop()

◆ addTransportable()

◆ allowsBoarding()

◆ getAcceleration()

◆ getAngle()

◆ getArrivalPos()

◆ getBackLane()

◆ getBackPositionOnLane()

◆ getBoolParam()

◆ getBoundingBox()

◆ getBrakeGap()

◆ getChosenSpeedFactor()

◆ getContainerNumber()

◆ getContainers()

◆ getCurrentRouteEdge()

◆ getDepartDelay()

◆ getDepartPos()

◆ getDeparture()

◆ getDevice()

◆ getDevices()

◆ getEdge()

◆ getEmissionParameters()

◆ getFloatParam()

◆ getID()

◆ getIDSecure()

◆ getImpatience()

◆ getLane()

◆ getLastActionTime()

◆ getLateralPositionOnLane()

◆ getLength()

◆ getMaxSpeed()

◆ getNextEdgePtr()

◆ getNextParkingArea()

◆ getNextStop()

◆ getNextStopParameter()

◆ getNumberParkingReroutes()

◆ getNumberReroutes()

◆ getNumericalID()

◆ getOdometer()

◆ getParameter()

◆ getPersonIDList()

◆ getPersonNumber()

◆ getPersons()

◆ getPosition()

◆ getPositionOnLane()

◆ getPreviousSpeed()

◆ getRerouteDestination()

◆ getRerouteOrigin()

◆ getRNG()

◆ getRNGIndex()

◆ getRoute()

◆ getRoutePosition()

◆ getRoutePtr()

◆ getRouteValidity()

◆ getRoutingMode()

◆ getSlope()

◆ getSpeed()

◆ getStopIndices()

◆ getStops()

◆ getStringParam()

◆ getTimeLoss()

◆ getTimeParam()

◆ getUpcomingEdgeIDs()

◆ getVClass()

◆ getVehicleType()

◆ getVTypeParameter()