#include <MSStop.h>

Collaboration diagram for MSStop:

Public Member Functions
SUMOTime	getArrival () const
	return arrival / started time

std::string	getDescription () const
	get a short description for showing in the gui

const MSEdge *	getEdge () const

double	getEndPos (const SUMOVehicle &veh) const
	return halting position for upcoming stop;

SUMOTime	getMinDuration (SUMOTime time) const
	return minimum stop duration when starting stop at time

double	getReachedThreshold () const
	return startPos taking into account opposite stopping

double	getSpeed () const
	return speed for passing waypoint / skipping on-demand stop

int	getStateFlagsOld () const
	return flags as used by Vehicle::getStopState

SUMOTime	getUntil () const
	return until / ended time

void	initPars (const SUMOVehicleParameter::Stop &stopPar)
	initialize attributes from the given stop parameters

bool	isInRange (const double pos, const double tolerance) const
	whether the stop is in range of the given position

	MSStop (const SUMOVehicleParameter::Stop &par)

void	write (OutputDevice &dev) const
	Write the current stop configuration (used for state saving)

Data Fields
MSStoppingPlace *	busstop = nullptr
	(Optional) bus stop if one is assigned to the stop

MSStoppingPlace *	chargingStation = nullptr
	(Optional) charging station if one is assigned to the stop

MSStoppingPlace *	containerstop = nullptr
	(Optional) container stop if one is assigned to the stop

bool	containerTriggered = false
	whether an arriving container lets the vehicle continue

SUMOTime	duration = -1
	The stopping duration.

MSRouteIterator	edge
	The edge in the route to stop at.

SUMOTime	endBoarding = SUMOTime_MAX
	the maximum time at which persons may board this vehicle

bool	isOpposite = false
	whether this an opposite-direction stop

bool	joinTriggered = false
	whether coupling another vehicle (train) the vehicle continue

const MSLane *	lane = nullptr
	The lane to stop at (microsim only)

int	numExpectedContainer = 0
	The number of still expected containers.

int	numExpectedPerson = 0
	The number of still expected persons.

MSStoppingPlace *	overheadWireSegment = nullptr
	(Optional) overhead wire segment if one is assigned to the stop

MSParkingArea *	parkingarea = nullptr
	(Optional) parkingArea if one is assigned to the stop

const SUMOVehicleParameter::Stop	pars
	The stop parameter.

bool	reached = false
	Information whether the stop has been reached.

const MESegment *	segment = nullptr
	The segment to stop at (mesosim only)

bool	skipOnDemand = false
	whether the decision to skip this stop has been made

bool	startedFromState = false
	whether the 'started' value was loaded from simulaton state

SUMOTime	timeToBoardNextPerson = 0
	The time at which the vehicle is able to board another person.

SUMOTime	timeToLoadNextContainer = 0
	The time at which the vehicle is able to load another container.

bool	triggered = false
	whether an arriving person lets the vehicle continue

Detailed Description

Definition at line 44 of file MSStop.h.

Constructor & Destructor Documentation

◆ MSStop()

MSStop::MSStop ( const SUMOVehicleParameter::Stop & par )

inline

Definition at line 46 of file MSStop.h.

Member Function Documentation

◆ getArrival()

SUMOTime MSStop::getArrival ( ) const

return arrival / started time

Definition at line 157 of file MSStop.cpp.

References SUMOVehicleParameter::Stop::arrival, MSGlobals::gUseStopStarted, pars, and SUMOVehicleParameter::Stop::started.

Referenced by MSBaseVehicle::addStop().

Here is the caller graph for this function:

◆ getDescription()

std::string MSStop::getDescription ( ) const

get a short description for showing in the gui

Definition at line 69 of file MSStop.cpp.

References SUMOVehicleParameter::Stop::actType, busstop, chargingStation, containerstop, SUMOVehicleParameter::Stop::endPos, Named::getID(), lane, overheadWireSegment, parkingarea, pars, and toString().

Referenced by MSBaseVehicle::addStop().

Here is the caller graph for this function:

◆ getEdge()

const MSEdge * MSStop::getEdge ( ) const

Definition at line 54 of file MSStop.cpp.

References MESegment::getEdge(), MSLane::getEdge(), lane, and segment.

Referenced by MSStageDriving::canLeaveVehicle(), getEndPos(), and MSVehicle::processNextStop().

Here is the caller graph for this function:

◆ getEndPos()

double MSStop::getEndPos ( const SUMOVehicle & veh ) const

return halting position for upcoming stop;

Definition at line 35 of file MSStop.cpp.

References busstop, chargingStation, containerstop, SUMOVehicleParameter::Stop::endPos, SUMOVehicle::getBrakeGap(), getEdge(), SUMOTrafficObject::getEdge(), MSParkingArea::getLastFreePos(), MSStoppingPlace::getLastFreePos(), SUMOTrafficObject::getPositionOnLane(), overheadWireSegment, SUMOVehicleParameter::Stop::parametersSet, parkingarea, pars, and STOP_END_SET.

Referenced by MSBaseVehicle::addStop(), MSBaseVehicle::getStopEdges(), MSBaseVehicle::insertStop(), MSLane::insertVehicle(), MSVehicle::planMoveInternal(), and MSBaseVehicle::replaceStop().

Here is the caller graph for this function:

◆ getMinDuration()

SUMOTime MSStop::getMinDuration ( SUMOTime time ) const

return minimum stop duration when starting stop at time

Definition at line 134 of file MSStop.cpp.

References duration, SUMOVehicleParameter::Stop::ended, MSGlobals::gUseStopEnded, MAX2(), pars, and SUMOVehicleParameter::Stop::until.

Referenced by MSVehicle::processNextStop().

Here is the caller graph for this function:

◆ getReachedThreshold()

double MSStop::getReachedThreshold ( ) const

return startPos taking into account opposite stopping

Definition at line 64 of file MSStop.cpp.

References SUMOVehicleParameter::Stop::endPos, MSLane::getOppositePos(), isOpposite, lane, pars, and SUMOVehicleParameter::Stop::startPos.

Referenced by MSVehicle::processNextStop().

Here is the caller graph for this function:

◆ getSpeed()

double MSStop::getSpeed ( ) const

return speed for passing waypoint / skipping on-demand stop

Definition at line 163 of file MSStop.cpp.

References pars, skipOnDemand, and SUMOVehicleParameter::Stop::speed.

Referenced by MSVehicle::estimateTimeToNextStop(), MSVehicle::planMoveInternal(), MSVehicle::processNextStop(), MSVehicle::resumeFromStopping(), and MSVehicle::updateBestLanes().

Here is the caller graph for this function:

◆ getStateFlagsOld()

int MSStop::getStateFlagsOld ( ) const

return flags as used by Vehicle::getStopState

Definition at line 128 of file MSStop.cpp.

References SUMOVehicleParameter::Stop::getFlags(), pars, and reached.

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

Here is the caller graph for this function:

◆ getUntil()

SUMOTime MSStop::getUntil ( ) const

return until / ended time

Definition at line 151 of file MSStop.cpp.

References SUMOVehicleParameter::Stop::ended, MSGlobals::gUseStopEnded, pars, and SUMOVehicleParameter::Stop::until.

Referenced by MSBaseVehicle::addStop(), MSVehicle::planMoveInternal(), and MSVehicle::processNextStop().

Here is the caller graph for this function:

◆ initPars()

void MSStop::initPars ( const SUMOVehicleParameter::Stop & stopPar )

initialize attributes from the given stop parameters

Definition at line 112 of file MSStop.cpp.

Referenced by MSBaseVehicle::addStop(), MSBaseVehicle::insertJump(), MSBaseVehicle::insertStop(), MSBaseVehicle::replaceStop(), and LIBSUMO_NAMESPACE::Vehicle::setStopParameter().

Here is the caller graph for this function:

◆ isInRange()

bool MSStop::isInRange	(	const double	pos,
		const double	tolerance
	)		const

whether the stop is in range of the given position

Definition at line 169 of file MSStop.cpp.

References SUMOVehicleParameter::Stop::endPos, pars, and SUMOVehicleParameter::Stop::startPos.

Referenced by MSStageDriving::canLeaveVehicle().

Here is the caller graph for this function:

◆ write()

void MSStop::write ( OutputDevice & dev ) const

Write the current stop configuration (used for state saving)

Definition at line 92 of file MSStop.cpp.

References busstop, chargingStation, OutputDevice::closeTag(), containerstop, duration, SUMOVehicleParameter::Stop::duration, SUMOVehicleParameter::Stop::parametersSet, parkingarea, pars, SUMOVehicleParameter::Stop::started, STOP_END_SET, STOP_START_SET, STOP_STARTED_SET, SUMO_ATTR_STARTED, time2string(), SUMOVehicleParameter::Stop::write(), OutputDevice::writeAttr(), and Parameterised::writeParams().

Field Documentation

◆ busstop

MSStoppingPlace* MSStop::busstop = nullptr

(Optional) bus stop if one is assigned to the stop

Definition at line 54 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), getDescription(), getEndPos(), initPars(), MSVehicle::leaveLane(), MSVehicle::processNextStop(), MSVehicle::resumeFromStopping(), and write().

◆ chargingStation

MSStoppingPlace* MSStop::chargingStation = nullptr

(Optional) charging station if one is assigned to the stop

Definition at line 60 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), getDescription(), getEndPos(), initPars(), MSVehicle::leaveLane(), MSDevice_StationFinder::notifyMove(), MSVehicle::processNextStop(), MSVehicle::resumeFromStopping(), and write().

◆ containerstop

MSStoppingPlace* MSStop::containerstop = nullptr

(Optional) container stop if one is assigned to the stop

Definition at line 56 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), getDescription(), getEndPos(), initPars(), MSVehicle::leaveLane(), MSVehicle::processNextStop(), MSVehicle::resumeFromStopping(), and write().

◆ containerTriggered

bool MSStop::containerTriggered = false

whether an arriving container lets the vehicle continue

Definition at line 71 of file MSStop.h.

Referenced by MSVehicleControl::abortWaiting(), MSVehicle::boardTransportables(), MSDevice_Taxi::dispatchShared(), MSIdling_Stop::idle(), initPars(), MSVehicle::processNextStop(), and MEVehicle::resumeFromStopping().

◆ duration

SUMOTime MSStop::duration = -1

The stopping duration.

Definition at line 67 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), MSDevice_Taxi::dispatchShared(), getMinDuration(), MSVehicle::getStopDelay(), MSIdling_Stop::idle(), initPars(), MSDevice_Transportable::notifyMove(), MSVehicle::processNextStop(), LIBSUMO_NAMESPACE::Vehicle::resume(), MSDevice_StationFinder::teleportToChargingStation(), and write().

◆ edge

MSRouteIterator MSStop::edge

The edge in the route to stop at.

Definition at line 48 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), MSVehicle::estimateTimeToNextStop(), MSBaseVehicle::getStopEdges(), MSVehicle::handleCollisionStop(), MSBaseVehicle::insertJump(), MSBaseVehicle::insertStop(), MSVehicle::processNextStop(), MEVehicle::processStop(), MSBaseVehicle::replaceParkingArea(), MSBaseVehicle::replaceStop(), LIBSUMO_NAMESPACE::Vehicle::resume(), MEVehicle::resumeFromStopping(), MSVehicle::resumeFromStopping(), MSBaseVehicle::setSkips(), and MSVehicle::updateBestLanes().

◆ endBoarding

SUMOTime MSStop::endBoarding = SUMOTime_MAX

the maximum time at which persons may board this vehicle

Definition at line 85 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), MSVehicle::processNextStop(), and MSDevice_Taxi::updateMove().

◆ isOpposite

bool MSStop::isOpposite = false

whether this an opposite-direction stop

Definition at line 87 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), MSAbstractLaneChangeModel::endLaneChangeManeuver(), getReachedThreshold(), MSLaneChanger::hasOppositeStop(), and MSVehicle::updateBestLanes().

◆ joinTriggered

bool MSStop::joinTriggered = false

whether coupling another vehicle (train) the vehicle continue

Definition at line 73 of file MSStop.h.

Referenced by MSVehicleControl::abortWaiting(), MSDevice_Taxi::dispatchShared(), initPars(), MSVehicle::processNextStop(), and MEVehicle::resumeFromStopping().

◆ lane

const MSLane* MSStop::lane = nullptr

◆ numExpectedContainer

int MSStop::numExpectedContainer = 0

The number of still expected containers.

Definition at line 79 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), and initPars().

◆ numExpectedPerson

int MSStop::numExpectedPerson = 0

The number of still expected persons.

Definition at line 77 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), and initPars().

◆ overheadWireSegment

MSStoppingPlace* MSStop::overheadWireSegment = nullptr

(Optional) overhead wire segment if one is assigned to the stop

Todo:: Check that this should really be a stopping place instance

Definition at line 63 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), getDescription(), getEndPos(), and initPars().

◆ parkingarea

MSParkingArea* MSStop::parkingarea = nullptr

(Optional) parkingArea if one is assigned to the stop

Definition at line 58 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), MSVehicle::Manoeuvre::configureEntryManoeuvre(), MSVehicle::Manoeuvre::configureExitManoeuvre(), GUIBaseVehicle::drawAction_drawVehicleAsPolyWithCarriagges(), MSVehicle::Manoeuvre::entryManoeuvreIsComplete(), getDescription(), getEndPos(), MSBaseVehicle::getNextParkingArea(), MSIdling_TaxiStand::idle(), initPars(), MSVehicle::planMoveInternal(), MSVehicle::processNextStop(), MSBaseVehicle::replaceParkingArea(), MSVehicle::resumeFromStopping(), and write().

◆ pars

const SUMOVehicleParameter::Stop MSStop::pars

The stop parameter.

Definition at line 65 of file MSStop.h.

Referenced by MSVehicleControl::abortWaiting(), MSBaseVehicle::addStop(), MSDevice_Taxi::dispatchShared(), MSVehicle::estimateTimeToNextStop(), getArrival(), getDescription(), getEndPos(), getMinDuration(), getReachedThreshold(), getSpeed(), getStateFlagsOld(), MSVehicle::getStopArrivalDelay(), MSVehicle::getStopDelay(), LIBSUMO_NAMESPACE::Vehicle::getStopParameter(), getUntil(), MSVehicle::handleCollisionStop(), MSBaseVehicle::insertJump(), isInRange(), MSLane::isInsertionSuccess(), MSBaseVehicle::isStoppedInRange(), MSVehicle::leaveLane(), MSDevice_Transportable::notifyMove(), MSVehicle::planMoveInternal(), MSVehicle::processNextStop(), MEVehicle::processStop(), MSBaseVehicle::replaceParkingArea(), MSBaseVehicle::replaceStop(), MSBaseVehicle::reroute(), LIBSUMO_NAMESPACE::Vehicle::resume(), MEVehicle::resumeFromStopping(), MSVehicle::resumeFromStopping(), MSBaseVehicle::setSkips(), LIBSUMO_NAMESPACE::Vehicle::setStopParameter(), MSVehicle::slowDownForSchedule(), MSDevice_StationFinder::teleportToChargingStation(), MSVehicle::updateBestLanes(), and write().

◆ reached

bool MSStop::reached = false

Information whether the stop has been reached.

Definition at line 75 of file MSStop.h.

Referenced by MSBaseVehicle::getNextParkingArea(), getStateFlagsOld(), MSVehicle::getStopArrivalDelay(), MSVehicle::getStopDelay(), MSVehicle::leaveLane(), MSVehicle::planMoveInternal(), MSVehicle::processNextStop(), MEVehicle::processStop(), and LIBSUMO_NAMESPACE::Vehicle::resume().

◆ segment

const MESegment* MSStop::segment = nullptr

The segment to stop at (mesosim only)

Definition at line 52 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), getEdge(), MSBaseVehicle::insertStop(), MEVehicle::processStop(), and MSBaseVehicle::replaceStop().

◆ skipOnDemand

bool MSStop::skipOnDemand = false

whether the decision to skip this stop has been made

Definition at line 89 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), getSpeed(), and MSVehicle::processNextStop().

◆ startedFromState

bool MSStop::startedFromState = false

whether the 'started' value was loaded from simulaton state

Definition at line 91 of file MSStop.h.

Referenced by MSVehicle::processNextStop().

◆ timeToBoardNextPerson

SUMOTime MSStop::timeToBoardNextPerson = 0

The time at which the vehicle is able to board another person.

Definition at line 81 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), and MSDevice_Transportable::notifyMove().

◆ timeToLoadNextContainer

SUMOTime MSStop::timeToLoadNextContainer = 0

The time at which the vehicle is able to load another container.

Definition at line 83 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), and MSDevice_Transportable::notifyMove().

◆ triggered

bool MSStop::triggered = false

whether an arriving person lets the vehicle continue

Definition at line 69 of file MSStop.h.

Referenced by MSVehicleControl::abortWaiting(), MSVehicle::boardTransportables(), MSDevice_Taxi::dispatchShared(), MSIdling_Stop::idle(), initPars(), MSVehicle::processNextStop(), and MEVehicle::resumeFromStopping().

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

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ MSStop()

Member Function Documentation

◆ getArrival()

◆ getDescription()

◆ getEdge()

◆ getEndPos()

◆ getMinDuration()

◆ getReachedThreshold()

◆ getSpeed()

◆ getStateFlagsOld()

◆ getUntil()

◆ initPars()

◆ isInRange()

◆ write()

Field Documentation

◆ busstop

◆ chargingStation

◆ containerstop

◆ containerTriggered

◆ duration

◆ edge

◆ endBoarding

◆ isOpposite

◆ joinTriggered

◆ lane

◆ numExpectedContainer

◆ numExpectedPerson

◆ overheadWireSegment

◆ parkingarea

◆ pars

◆ reached

◆ segment

◆ skipOnDemand

◆ startedFromState

◆ timeToBoardNextPerson

◆ timeToLoadNextContainer

◆ triggered