abstract base class for managing callbacks to retrieve various state information from the model More...

#include <MSPModel.h>

Inheritance diagram for MSTransportableStateAdapter:

Public Member Functions
virtual double	getAngle (const MSStageMoving &stage, SUMOTime now) const =0
	return the direction in which the transportable faces in degrees

virtual int	getDirection () const =0
	return the walking direction (FORWARD, BACKWARD, UNDEFINED_DIRECTION)

virtual double	getEdgePos (SUMOTime now=0) const =0
	return the offset from the start of the current edge measured in its natural direction

virtual const MSLane *	getLane () const
	the current lane of the transportable

virtual const MSEdge *	getNextEdge (const MSStageMoving &stage) const =0
	return the list of internal edges if the transportable is on an intersection

virtual double	getPathLength () const
	return the total length of the current lane (in particular for on a walkingarea)

virtual Position	getPosition (const MSStageMoving &stage, SUMOTime now) const =0
	return the network coordinate of the transportable

virtual double	getSpeed (const MSStageMoving &stage) const =0
	return the current speed of the transportable

virtual SUMOTime	getWaitingTime () const =0
	return the time the transportable spent standing

virtual bool	isFinished () const
	whether the transportable has finished walking

virtual bool	isJammed () const
	whether the transportable is jammed

virtual void	moveTo (MSPerson p, MSLane lane, double lanePos, double lanePosLat, SUMOTime t)
	try to move transportable to the given position

virtual void	moveToXY (MSPerson p, Position pos, MSLane lane, double lanePos, double lanePosLat, double angle, int routeOffset, const ConstMSEdgeVector &edges, SUMOTime t)
	try to move transportable to the given position

virtual void	saveState (std::ostringstream &out)
	Saves the current state into the given stream.

virtual	~MSTransportableStateAdapter ()

Detailed Description

abstract base class for managing callbacks to retrieve various state information from the model

Definition at line 154 of file MSPModel.h.

Constructor & Destructor Documentation

◆ ~MSTransportableStateAdapter()

virtual MSTransportableStateAdapter::~MSTransportableStateAdapter ( )

inlinevirtual

Definition at line 156 of file MSPModel.h.

Member Function Documentation

◆ getAngle()

virtual double MSTransportableStateAdapter::getAngle	(	const MSStageMoving &	stage,
		SUMOTime	now
	)		const

pure virtual

return the direction in which the transportable faces in degrees

Implemented in MSPModel_InteractingState, MSPModel_NonInteracting::PState, MSPModel_NonInteracting::CState, and MSPModel_Striping::PState.

Referenced by MSStageMoving::getAngle().

Here is the caller graph for this function:

◆ getDirection()

virtual int MSTransportableStateAdapter::getDirection ( ) const

pure virtual

return the walking direction (FORWARD, BACKWARD, UNDEFINED_DIRECTION)

Implemented in MSPModel_InteractingState, and MSPModel_NonInteracting::PState.

Referenced by MSPModel_NonInteracting::MoveToNextEdge::execute(), and MSStageMoving::getDirection().

Here is the caller graph for this function:

◆ getEdgePos()

virtual double MSTransportableStateAdapter::getEdgePos ( SUMOTime now = 0 ) const

pure virtual

return the offset from the start of the current edge measured in its natural direction

Implemented in MSPModel_NonInteracting::PState, and MSPModel_InteractingState.

Referenced by MSStageMoving::getEdgePos().

Here is the caller graph for this function:

◆ getLane()

virtual const MSLane * MSTransportableStateAdapter::getLane ( ) const

inlinevirtual

the current lane of the transportable

Reimplemented in MSPModel_InteractingState.

Definition at line 216 of file MSPModel.h.

Referenced by MSStageMoving::getLane(), MSStageWalking::loadState(), and MSPModel_Interacting::remove().

Here is the caller graph for this function:

◆ getNextEdge()

virtual const MSEdge * MSTransportableStateAdapter::getNextEdge ( const MSStageMoving & stage ) const

pure virtual

return the list of internal edges if the transportable is on an intersection

Implemented in MSPModel_NonInteracting::PState, MSPModel_Striping::PState, and MSPModel_JuPedSim::PState.

Referenced by MSPerson::getNextEdgePtr().

Here is the caller graph for this function:

◆ getPathLength()

virtual double MSTransportableStateAdapter::getPathLength ( ) const

inlinevirtual

return the total length of the current lane (in particular for on a walkingarea)

Reimplemented in MSPModel_Striping::PState.

Definition at line 221 of file MSPModel.h.

Referenced by MSStageWalking::moveToNextEdge().

Here is the caller graph for this function:

◆ getPosition()

virtual Position MSTransportableStateAdapter::getPosition	(	const MSStageMoving &	stage,
		SUMOTime	now
	)		const

pure virtual

return the network coordinate of the transportable

Implemented in MSPModel_JuPedSim::PState, MSPModel_NonInteracting::PState, MSPModel_NonInteracting::CState, and MSPModel_Striping::PState.

Referenced by MSStageMoving::getPosition().

Here is the caller graph for this function:

◆ getSpeed()

virtual double MSTransportableStateAdapter::getSpeed ( const MSStageMoving & stage ) const

pure virtual

return the current speed of the transportable

Implemented in MSPModel_InteractingState, and MSPModel_NonInteracting::PState.

Referenced by MSStageMoving::getSpeed().

Here is the caller graph for this function:

◆ getWaitingTime()

virtual SUMOTime MSTransportableStateAdapter::getWaitingTime ( ) const

pure virtual

return the time the transportable spent standing

Implemented in MSPModel_InteractingState, and MSPModel_NonInteracting::PState.

Referenced by MSStageMoving::getWaitingTime().

Here is the caller graph for this function:

◆ isFinished()

virtual bool MSTransportableStateAdapter::isFinished ( ) const

inlinevirtual

whether the transportable has finished walking

Reimplemented in MSPModel_JuPedSim::PState.

Definition at line 211 of file MSPModel.h.

Referenced by MSStageMoving::~MSStageMoving().

Here is the caller graph for this function:

◆ isJammed()

virtual bool MSTransportableStateAdapter::isJammed ( ) const

inlinevirtual

whether the transportable is jammed

Reimplemented in MSPModel_InteractingState.

Definition at line 206 of file MSPModel.h.

Referenced by MSPerson::isJammed().

Here is the caller graph for this function:

◆ moveTo()

virtual void MSTransportableStateAdapter::moveTo	(	MSPerson *	p,
		MSLane *	lane,
		double	lanePos,
		double	lanePosLat,
		SUMOTime	t
	)

inlinevirtual

try to move transportable to the given position

Reimplemented in MSPModel_Striping::PState.

Definition at line 180 of file MSPModel.h.

References TL, UNUSED_PARAMETER, and WRITE_WARNING.

Referenced by LIBSUMO_NAMESPACE::Person::moveTo().

Here is the caller graph for this function:

◆ moveToXY()

virtual void MSTransportableStateAdapter::moveToXY	(	MSPerson *	p,
		Position	pos,
		MSLane *	lane,
		double	lanePos,
		double	lanePosLat,
		double	angle,
		int	routeOffset,
		const ConstMSEdgeVector &	edges,
		SUMOTime	t
	)