Representation of a vehicle, person, or container. More...

#include <SUMOTrafficObject.h>

Inheritance diagram for SUMOTrafficObject:

Collaboration diagram for SUMOTrafficObject:

Public Types
typedef long long int	NumericalID

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

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

virtual double	getAngle () const =0
	Returns the object's angle in degrees. More...

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

virtual double	getChosenSpeedFactor () const =0

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

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

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

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

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

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

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

virtual const SUMOVehicleParameter &	getParameter () const =0
	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 object's position along the lane. More...

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

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

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

virtual int	getRNGIndex () const =0

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

virtual int	getRoutingMode () const =0

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

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

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

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

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

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

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

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

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

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

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

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

virtual bool	isStopped () const =0
	Returns whether the object is at a stop. More...

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

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

virtual void	replaceVehicleType (MSVehicleType *type)=0
	Replaces the current vehicle type by the one given. More...

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

	SUMOTrafficObject (const std::string &id)
	Constructor. More...

virtual	~SUMOTrafficObject ()
	Destructor. More...

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

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

Detailed Description

Representation of a vehicle, person, or container.

Definition at line 52 of file SUMOTrafficObject.h.

Member Typedef Documentation

◆ NumericalID

typedef long long int SUMOTrafficObject::NumericalID

Definition at line 54 of file SUMOTrafficObject.h.

Constructor & Destructor Documentation

◆ SUMOTrafficObject()

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

inline

Constructor.

Definition at line 57 of file SUMOTrafficObject.h.

◆ ~SUMOTrafficObject()

virtual SUMOTrafficObject::~SUMOTrafficObject ( )

inlinevirtual

Destructor.

Definition at line 60 of file SUMOTrafficObject.h.

Member Function Documentation

◆ 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().

◆ getAcceleration()

virtual double SUMOTrafficObject::getAcceleration ( ) const

pure virtual

Returns the object's acceleration.

Returns: The acceleration

Implemented in MSTransportable, MSVehicle, and MSBaseVehicle.

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 SUMOTrafficObject::getAngle ( ) const

pure virtual

Returns the object's angle in degrees.

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

Referenced by PolygonDynamics::initTrackedPosition(), and PolygonDynamics::update().

Here is the caller graph for this function:

◆ getBackPositionOnLane()

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

pure virtual

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 MSTransportable, MSVehicle, and MEVehicle.

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

Here is the caller graph for this function:

◆ getChosenSpeedFactor()

virtual double SUMOTrafficObject::getChosenSpeedFactor ( ) const

pure virtual

Implemented in MSTransportable, MSPerson, and MSBaseVehicle.

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:

◆ getDevice()

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

pure virtual

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

Implemented in MSTransportable, and MSBaseVehicle.

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

Here is the caller graph for this function:

◆ getEdge()

virtual const MSEdge* SUMOTrafficObject::getEdge ( ) const

pure virtual

Returns the edge the object is currently at.

Returns: The current edge in the object's route

Implemented in MSTransportable, and MSBaseVehicle.

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

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(), MSLaneChanger::avoidDeadlock(), MSLaneChanger::changeOpposite(), MSLaneChanger::checkChangeOpposite(), MSRailSignal::DriveWay::checkFlanks(), MSVehicle::checkReversal(), MSVehicle::checkRewindLinkLanes(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), NBOwnTLDef::computeLogicAndConts(), MSRailSignal::DriveWay::conflictLaneOccupied(), NBPTLineCont::constructRoute(), MSLaneChanger::continueChange(), MSLane::detectCollisions(), MSVehicle::enterLaneAtLaneChange(), MSVehicle::executeMove(), NBRailwayTopologyAnalyzer::extendDirectionPriority(), MSRailSignal::DriveWay::findProtection(), NBPTLineCont::findWay(), 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(), MSCFModel_IDM::insertionFollowSpeed(), MSLane::isInsertionSuccess(), MESegment::isOpen(), 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(), MSVehicle::Influencer::postProcessRemoteControl(), MSVehicle::processNextStop(), MSBaseVehicle::replaceRoute(), MSBaseVehicle::reroute(), MSTriggeredRerouter::rerouteParkingArea(), MSRailSignal::DriveWay::reserve(), MSLaneChanger::resolveDeadlock(), MSLCM_LC2013::slowDownForBlocked(), MSLCM_SL2015::slowDownForBlocked(), MSLaneChangerSublane::startChangeSublane(), MSLeaderInfo::toString(), MSLeaderDistanceInfo::toString(), MSCriticalFollowerDistanceInfo::toString(), toString(), MSTriggeredRerouter::triggerRouting(), MSVehicle::updateBestLanes(), MSLCHelper::updateBlockerLength(), MSAbstractLaneChangeModel::updateShadowLane(), MSPModel_Striping::PState::walk(), and MSLaneChanger::yieldToDeadlockOncoming().

◆ getLane()

virtual const MSLane* SUMOTrafficObject::getLane ( ) const

pure virtual

Returns the lane the object is currently at.

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

Implemented in MSTransportable, MSVehicle, and MEVehicle.

Referenced by MSStageDriving::abort(), MSBaseVehicle::addStop(), libsumo::Helper::applySubscriptionFilters(), MSE2Collector::calculateTimeLossAndTimeOnDetector(), GUIBaseVehicle::drawOnPos(), 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::haveValidStopEdges(), MSBaseVehicle::insertStop(), LIBSUMO_NAMESPACE::Vehicle::isOnInit(), 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(), 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:

◆ getMaxSpeed()

virtual double SUMOTrafficObject::getMaxSpeed ( ) const

pure virtual

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

Returns: The object's maximum speed

Implemented in MSTransportable, and MSBaseVehicle.

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

Here is the caller graph for this function:

◆ getNextEdgePtr()

virtual const MSEdge* SUMOTrafficObject::getNextEdgePtr ( ) const

pure virtual

returns the next edge (possibly an internal edge)

Implemented in MSTransportable, MSPerson, MSVehicle, and MSBaseVehicle.

Referenced by MSDetectorFileOutput::vehicleApplies().

Here is the caller graph for this function:

◆ getNumericalID()

virtual NumericalID SUMOTrafficObject::getNumericalID ( ) const

pure virtual

return the numerical ID which is only for internal usage

Implemented in MSTransportable, and MSBaseVehicle.

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

Here is the caller graph for this function:

◆ getParameter()

virtual const SUMOVehicleParameter& SUMOTrafficObject::getParameter ( ) const

pure virtual

Returns the vehicle's parameter (including departure definition)

Returns: The vehicle's parameter

Implemented in MSTransportable, and MSBaseVehicle.

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_ToC::getOutputFilename(), MSDevice_SSM::getOutputFilename(), MSDevice::getStringParam(), LIBSUMO_NAMESPACE::TrafficLight::getVehicleByTripId(), MSRailSignalConstraint::getVehID(), MSTriggeredRerouter::getWeight(), MSVehicleControl::handleTriggeredDepart(), 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(), MSDevice_Routing::preInsertionReroute(), MSStageDriving::proceed(), MSDevice_Battery::readParameterValue(), MSVehicleContainer::remove(), MSDevice_SSM::requestsTrajectories(), MSStageTrip::setArrived(), MSDevice_Taxi::setParameter(), MSStageDriving::setVehicle(), MSDevice_ToC::setVehicleColor(), MSTriggeredRerouter::triggerRouting(), MSInsertionControl::tryInsert(), MSDevice_SSM::useGeoCoords(), MSEdge::validateDepartSpeed(), MSVehicleControl::vehicleDeparted(), MSDevice_SSM::writeLanesPositions(), MSDevice_Vehroutes::writeOutput(), MSDevice_SSM::writePositions(), and MSDevice_Vehroutes::writeXMLRoute().

◆ getPosition()

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

pure virtual

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 MSTransportable, MSVehicle, MEVehicle, GUIMEVehicle, and GUIVehicle.

Referenced by libsumo::Helper::applySubscriptionFilterFieldOfVision(), libsumo::Helper::applySubscriptionFilterLateralDistanceSinglePass(), MSVTypeProbe::execute(), 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 virtual

Get the object's position along the lane.

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

Implemented in MSTransportable, MSVehicle, and MEVehicle.

Referenced by MSTriggeredRerouter::addParkValues(), MSBaseVehicle::addStop(), MSDispatch::computePickupTime(), MSDevice_Taxi::dispatchShared(), GUIBaseVehicle::drawStopLabels(), MSParkingArea::enter(), MSStoppingPlace::enter(), 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(), MSBaseVehicle::haveValidStopEdges(), MSIdling_Stop::idle(), MSIdling_RandomCircling::idle(), MSBaseVehicle::insertStop(), MSE2Collector::makeVehicleInfo(), 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_StationFinder::notifyMove(), MSDevice_ToC::notifyMove(), MSDevice_Battery::notifyParking(), MSBaseVehicle::onDepart(), MSOverheadWire::vehicle_position_sorter::operator()(), MSBaseVehicle::replaceRoute(), MSBaseVehicle::replaceStop(), MSDevice_ToC::requestToC(), MSBaseVehicle::reroute(), MSBaseVehicle::rerouteBetweenStops(), MSTriggeredRerouter::rerouteParkingArea(), 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 virtual

Returns the object's previous speed.

Returns: The object's previous speed

Implemented in MSTransportable, MSVehicle, and MSBaseVehicle.

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 virtual

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

Returns: The rerouting end point

Implemented in MSTransportable, and MSBaseVehicle.

Referenced by MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ getRNG()

virtual SumoRNG* SUMOTrafficObject::getRNG ( ) const

pure virtual

Returns the associated RNG for this object.

Returns: The vehicle's associated RNG

Implemented in MSTransportable, and MSBaseVehicle.

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

Here is the caller graph for this function:

◆ getRNGIndex()

virtual int SUMOTrafficObject::getRNGIndex ( ) const

pure virtual

Returns: The index of the associated RNG

Implemented in MSTransportable, and MSBaseVehicle.

Referenced by MSDevice_Taxi::dispatchShared(), MSDevice_Routing::notifyEnter(), MSDevice_StationFinder::notifyMove(), MSDevice_Taxi::prepareStop(), MSTriggeredRerouter::rerouteParkingArea(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ getRoutePosition()

virtual int SUMOTrafficObject::getRoutePosition ( ) const

pure virtual

return index of edge within route

Implemented in MSTransportable, and MSBaseVehicle.

Referenced by MSDevice_Vehroutes::addRoute(), MSDevice_Taxi::dispatchShared(), 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(), MSDevice_BTsender::notifyMove(), and MSDevice_StationFinder::notifyMove().

Here is the caller graph for this function:

◆ getRoutingMode()

virtual int SUMOTrafficObject::getRoutingMode ( ) const

pure virtual

Implemented in MSTransportable, and MSBaseVehicle.

◆ getSlope()

virtual double SUMOTrafficObject::getSlope ( ) const

pure virtual

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

Returns: The slope

Implemented in MSTransportable, MSVehicle, and MEVehicle.

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 virtual

Returns the object's current speed.

Returns: The object's speed

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

Referenced by MSChargingStation::addChargeValueForOutput(), 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(), MSRailSignal::hasOncomingRailTraffic(), 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:

◆ getUpcomingEdgeIDs()

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

pure virtual

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

Implemented in MSTransportable, and MSBaseVehicle.

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

Here is the caller graph for this function:

◆ getVClass()

virtual SUMOVehicleClass SUMOTrafficObject::getVClass ( ) const

pure virtual

Returns the object's access class.

Returns: The object's access class

Implemented in MSTransportable, and MSBaseVehicle.

Referenced by MSVehicleControl::addVehicle(), MSDevice_Taxi::buildVehicleDevices(), MSDevice_Taxi::dispatchShared(), MSDevice_Tripinfo::generateOutput(), MSRoutingEngine::getEffortExtra(), MSDevice_Taxi::getStopLane(), MSLane::getVehicleMaxSpeed(), MSIdling_RandomCircling::idle(), MSRoutingEngine::initRouter(), MSDevice_Routing::notifyEnter(), MSDevice_StationFinder::notifyMove(), MSDetectorFileOutput::personApplies(), MSDevice_Taxi::prepareStop(), MSEdge::prohibits(), MSDevice_Routing::reroute(), MSRoutingEngine::reroute(), MSStageDriving::setVehicle(), 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 virtual

Returns the object's "vehicle" type.

Returns: The vehicle's type

Implemented in MSTransportable, and MSBaseVehicle.

Referenced by MSChargingStation::addChargeValueForOutput(), MSOverheadWire::addChargeValueForOutput(), MSTriggeredRerouter::applies(), MSLink::blockedAtTime(), MSLink::blockedByFoe(), MSDevice_ElecHybrid::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), MSDevice_Taxi::buildVehicleDevices(), MSLink::computeFoeArrivalTimeBraking(), MSDevice_SSM::computeGlobalMeasures(), MSParkingArea::enter(), MSStoppingPlace::enter(), MSVTypeProbe::execute(), MSDevice_SSM::filterByConflictType(), MSStoppingPlace::fits(), MSDevice_Tripinfo::generateOutput(), MSEdge::getDepartLaneMeso(), MSDevice_SSM::getDetectionRange(), MSDevice_SSM::getExtraTime(), MSParkingArea::getLastFreePos(), MSStoppingPlace::getLastFreePos(), MSParkingArea::getLastFreePosWithReservation(), MSDevice_SSM::getMDRAC_PRT(), MSDevice_SSM::getMeasuresAndThresholds(), MSDevice_ToC::getOutputFilename(), MSDevice_SSM::getOutputFilename(), MSDevice::getStringParam(), MSTriggeredRerouter::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(), 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(), 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(), MSElecHybridExport::writeAggregated(), MSDevice_SSM::writeLanesPositions(), MSDevice_Vehroutes::writeOutput(), MSDevice_SSM::writePositions(), MSAmitranTrajectories::writeVehicle(), and MSFullExport::writeVehicles().

◆ getWaitingTime()

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

pure virtual

Implemented in MSTransportable, MSVehicle, and MEVehicle.

Referenced by 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 virtual

Returns whether this object has arrived.

Implemented in MSTransportable, MSVehicle, MSBaseVehicle, and MEVehicle.

Referenced by MSMeanData::MeanDataValues::notifyMove().

Here is the caller graph for this function:

◆ hasInfluencer()

virtual bool SUMOTrafficObject::hasInfluencer ( ) const

pure virtual

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

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

◆ ignoreTransientPermissions()

virtual bool SUMOTrafficObject::ignoreTransientPermissions ( ) const

inlinevirtual

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

Reimplemented in MSBaseVehicle.

Definition at line 168 of file SUMOTrafficObject.h.

Referenced by MSEdge::prohibits().

Here is the caller graph for this function:

◆ isContainer()

virtual bool SUMOTrafficObject::isContainer ( ) const

inlinevirtual

Whether it is a container.

Returns: true for containers, false otherwise

Reimplemented in MSTransportable.

Definition at line 79 of file SUMOTrafficObject.h.

◆ isPerson()

virtual bool SUMOTrafficObject::isPerson ( ) const

inlinevirtual

Whether it is a person.

Returns: true for persons, false otherwise

Reimplemented in MSTransportable.

Definition at line 72 of file SUMOTrafficObject.h.

Referenced by MSE3Collector::enter(), 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:

◆ isSelected()

virtual bool SUMOTrafficObject::isSelected ( ) const

pure virtual

whether this object is selected in the GUI

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

Referenced by MSLink::blockedByFoe().

Here is the caller graph for this function:

◆ isStopped()

virtual bool SUMOTrafficObject::isStopped ( ) const

pure virtual

Returns whether the object is at a stop.

Returns: Whether it has stopped

Implemented in MSTransportable, and MSBaseVehicle.

Referenced by MSVehicleControl::getVehicleMeanSpeeds(), MSDevice_Transportable::notifyMove(), MSDevice_Tripinfo::notifyMove(), MSMeanData_Net::MSLaneMeanDataValues::notifyMoveInternal(), MSDevice_Transportable::removeTransportable(), MSDevice_Taxi::updateMove(), and MSDevice_Routing::wrappedRerouteCommandExecute().

Here is the caller graph for this function:

◆ isVehicle()

virtual bool SUMOTrafficObject::isVehicle ( ) const

inlinevirtual

Whether it is a vehicle.

Returns: true for vehicles, false otherwise

Reimplemented in MSBaseVehicle.

Definition at line 65 of file SUMOTrafficObject.h.

Referenced by libsumo::Helper::debugPrint(), MSE3Collector::enter(), MSE3Collector::leave(), MSE3Collector::leaveFront(), MSDevice_ElecHybrid::notifyEnter(), MSE2Collector::notifyEnter(), MSDevice_SSM::notifyEnter(), MSMeanData_Net::MSLaneMeanDataValues::notifyEnter(), MSDevice_Tripinfo::notifyIdle(), MSMeanData_Emissions::MSLaneMeanDataValues::notifyIdle(), MSDevice_ElecHybrid::notifyLeave(), MSDevice_SSM::notifyLeave(), MSMeanData_Net::MSLaneMeanDataValues::notifyLeave(), 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:

◆ 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 virtual

Replaces the current route by the given one.

Implemented in MSTransportable, MSVehicle, MSBaseVehicle, and MEVehicle.

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

Here is the caller graph for this function:

◆ replaceVehicleType()

virtual void SUMOTrafficObject::replaceVehicleType ( MSVehicleType * type )

pure virtual

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 MSTransportable, MSVehicle, and MSBaseVehicle.

Referenced by MSCalibrator::VehicleRemover::notifyEnter().

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 NBLoadedSUMOTLDef, MSTransportable, and MSBaseVehicle.

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:

Field Documentation

◆ myID

std::string Named::myID

protectedinherited

The name of the object.

Definition at line 125 of file Named.h.

Referenced by MSE2Collector::addDetectorToLanes(), RODFDetector::buildDestinationDistribution(), NGEdge::buildNBEdge(), NGNode::buildNBNode(), MSSOTLTrafficLightLogic::checkPhases(), NBNode::computeNodeShape(), NEMALogic::constructTimingAndPhaseDefs(), MSE2Collector::detectorUpdate(), GNEPOI::getAttribute(), GNEPoly::getAttribute(), MSLane::getCanonicalPredecessorLane(), MSLane::getCanonicalSuccessorLane(), Named::getID(), NBEdge::getLaneID(), ROEdge::getStoredEffort(), GNEPOI::getSumoBaseObject(), MSLane::getSurroundingVehicles(), ROEdge::getTravelTime(), NBEdge::init(), MSDelayBasedTrafficLightLogic::init(), MSSOTLTrafficLightLogic::init(), NEMALogic::init(), MSLane::isInsertionSuccess(), 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::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:

SUMOTrafficObject.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ NumericalID

Constructor & Destructor Documentation

◆ SUMOTrafficObject()

◆ ~SUMOTrafficObject()

Member Function Documentation

◆ addTo()

◆ getAcceleration()

◆ getAngle()

◆ getBackPositionOnLane()

◆ getChosenSpeedFactor()

◆ getDevice()

◆ getEdge()

◆ getID()

◆ getIDSecure()

◆ getLane()

◆ getMaxSpeed()

◆ getNextEdgePtr()

◆ getNumericalID()

◆ getParameter()

◆ getPosition()

◆ getPositionOnLane()

◆ getPreviousSpeed()

◆ getRerouteDestination()

◆ getRNG()

◆ getRNGIndex()

◆ getRoutePosition()

◆ getRoutingMode()

◆ getSlope()

◆ getSpeed()

◆ getUpcomingEdgeIDs()

◆ getVClass()

◆ getVehicleType()

◆ getWaitingTime()

◆ hasArrived()

◆ hasInfluencer()

◆ ignoreTransientPermissions()

◆ isContainer()

◆ isPerson()

◆ isSelected()

◆ isStopped()

◆ isVehicle()

◆ replaceRoute()

◆ replaceVehicleType()

◆ setID()

Field Documentation

◆ myID