#include <MSTransportable.h>

Inheritance diagram for MSTransportable::Stage:

Collaboration diagram for MSTransportable::Stage:

Public Member Functions
virtual void	abort (MSTransportable *)
	abort this stage (TraCI) More...

virtual void	beginEventOutput (const MSTransportable &transportable, SUMOTime t, OutputDevice &os) const =0
	Called for writing the events output (begin of an action) More...

virtual void	endEventOutput (const MSTransportable &transportable, SUMOTime t, OutputDevice &os) const =0
	Called for writing the events output (end of an action) More...

virtual double	getAngle (SUMOTime now) const =0
	returns the angle of the transportable More...

double	getArrivalPos () const

const MSEdge *	getDestination () const
	returns the destination edge More...

MSStoppingPlace *	getDestinationStop () const
	returns the destination stop (if any) More...

virtual const MSEdge *	getEdge () const
	Returns the current edge. More...

double	getEdgeAngle (const MSEdge *e, double at) const
	get angle of the edge at a certain position More...

virtual double	getEdgePos (SUMOTime now) const

Position	getEdgePosition (const MSEdge *e, double at, double offset) const
	get position on edge e at length at with orthogonal offset More...

virtual ConstMSEdgeVector	getEdges () const
	the edges of the current stage More...

virtual const MSEdge *	getFromEdge () const

Position	getLanePosition (const MSLane *lane, double at, double offset) const
	get position on lane at length at with orthogonal offset More...

virtual Position	getPosition (SUMOTime now) const =0
	returns the position of the transportable More...

virtual double	getSpeed () const
	the speed of the transportable More...

virtual std::string	getStageDescription () const =0
	return (brief) string representation of the current stage More...

virtual std::string	getStageSummary () const =0
	return string summary of the current stage More...

StageType	getStageType () const

virtual SUMOVehicle *	getVehicle () const
	Whether the transportable waits for a vehicle. More...

virtual SUMOTime	getWaitingTime (SUMOTime now) const
	the time this transportable spent waiting More...

virtual bool	isWaiting4Vehicle () const
	Whether the transportable waits for a vehicle. More...

virtual bool	isWaitingFor (const std::string &line) const
	Whether the transportable waits for a vehicle of the line specified. More...

virtual void	proceed (MSNet net, MSTransportable transportable, SUMOTime now, Stage *previous)=0
	proceeds to this stage More...

virtual void	routeOutput (OutputDevice &os) const =0
	Called on writing vehroute output. More...

virtual void	setArrived (SUMOTime now)
	logs end of the step More...

void	setDeparted (SUMOTime now)
	logs end of the step More...

virtual void	setSpeed (double)
	sets the walking speed (ignored in other stages) More...

	Stage (const MSEdge destination, MSStoppingPlace toStop, const double arrivalPos, StageType type)
	constructor More...

virtual void	tripInfoOutput (OutputDevice &os, MSTransportable *transportable) const =0
	Called on writing tripinfo output. More...

virtual	~Stage ()
	destructor More...

Protected Attributes
double	myArrivalPos
	the position at which we want to arrive More...

SUMOTime	myArrived
	the time at which this stage ended More...

SUMOTime	myDeparted
	the time at which this stage started More...

const MSEdge *	myDestination
	the next edge to reach by getting transported More...

MSStoppingPlace *	myDestinationStop
	the stop to reach by getting transported (if any) More...

StageType	myType
	The type of this stage. More...

Private Member Functions
Stage &	operator= (const Stage &)
	Invalidated assignment operator. More...

	Stage (const Stage &)
	Invalidated copy constructor. More...

Detailed Description

The "abstract" class for a single stage of a movement Contains the destination of the current movement step

Definition at line 70 of file MSTransportable.h.

Constructor & Destructor Documentation

◆ Stage() [1/2]

MSTransportable::Stage::Stage	(	const MSEdge *	destination,
		MSStoppingPlace *	toStop,
		const double	arrivalPos,
		StageType	type
	)

constructor

Definition at line 49 of file MSTransportable.cpp.

◆ ~Stage()

MSTransportable::Stage::~Stage ( )

virtual

destructor

Definition at line 52 of file MSTransportable.cpp.

◆ Stage() [2/2]

MSTransportable::Stage::Stage ( const Stage & )

private

Invalidated copy constructor.

Member Function Documentation

◆ abort()

virtual void MSTransportable::Stage::abort ( MSTransportable * )

inlinevirtual

abort this stage (TraCI)

Reimplemented in MSTransportable::Stage_Driving, MSTransportable::Stage_Waiting, and MSPerson::MSPersonStage_Walking.

Definition at line 116 of file MSTransportable.h.

◆ beginEventOutput()

virtual void MSTransportable::Stage::beginEventOutput	(	const MSTransportable &	transportable,
		SUMOTime	t,
		OutputDevice &	os
	)		const

pure virtual

Called for writing the events output (begin of an action)

Parameters

[in] os The stream to write the information into

Exceptions

IOError not yet implemented

Implemented in MSTransportable::Stage_Driving, MSPerson::MSPersonStage_Access, MSTransportable::Stage_Waiting, MSContainer::MSContainerStage_Tranship, and MSPerson::MSPersonStage_Walking.

Referenced by MSTransportable::Stage_Waiting::getStageDescription(), getVehicle(), and MSTransportable::Stage_Driving::getVehicle().

◆ endEventOutput()

virtual void MSTransportable::Stage::endEventOutput	(	const MSTransportable &	transportable,
		SUMOTime	t,
		OutputDevice &	os
	)		const

pure virtual

Called for writing the events output (end of an action)

Parameters

[in] os The stream to write the information into

Exceptions

IOError not yet implemented

Implemented in MSTransportable::Stage_Driving, MSPerson::MSPersonStage_Access, MSTransportable::Stage_Waiting, MSContainer::MSContainerStage_Tranship, and MSPerson::MSPersonStage_Walking.

Referenced by MSTransportable::Stage_Waiting::getStageDescription(), getVehicle(), and MSTransportable::Stage_Driving::getVehicle().

◆ getAngle()

virtual double MSTransportable::Stage::getAngle ( SUMOTime now ) const

pure virtual

returns the angle of the transportable

Implemented in MSTransportable::Stage_Driving, MSPerson::MSPersonStage_Access, MSTransportable::Stage_Waiting, MSContainer::MSContainerStage_Tranship, and MSPerson::MSPersonStage_Walking.

Referenced by getArrivalPos(), and MSTransportable::getFromEdge().

◆ getArrivalPos()

double MSTransportable::Stage::getArrivalPos ( ) const

inline

Definition at line 86 of file MSTransportable.h.

References getAngle(), getEdge(), getEdgePos(), getFromEdge(), getPosition(), and myArrivalPos.

Referenced by MSRouteHandler::parseWalkPositions(), MSTransportable::rerouteParkingArea(), and libsumo::Person::rerouteTraveltime().

◆ getDestination()

const MSEdge * MSTransportable::Stage::getDestination ( ) const

returns the destination edge

Definition at line 55 of file MSTransportable.cpp.

References myDestination.

Referenced by getEdges(), MSTransportable::Stage_Driving::getEdges(), MSContainer::MSContainerStage_Driving::getStageSummary(), MSPerson::MSPersonStage_Walking::getStageSummary(), MSContainer::MSContainerStage_Tranship::getStageSummary(), MSTransportable::Stage_Waiting::getStageSummary(), MSPerson::MSPersonStage_Driving::getStageSummary(), MSPModel_Striping::moveInDirectionOnLane(), MSRouteHandler::parseWalkPositions(), MSPerson::proceed(), MSTransportable::rerouteParkingArea(), MSContainer::MSContainerStage_Driving::routeOutput(), MSTransportable::Stage_Waiting::routeOutput(), and MSPerson::MSPersonStage_Driving::routeOutput().

◆ getDestinationStop()

MSStoppingPlace* MSTransportable::Stage::getDestinationStop ( ) const

inline

returns the destination stop (if any)

Definition at line 82 of file MSTransportable.h.

References myDestinationStop.

Referenced by MSContainer::MSContainerStage_Driving::getStageSummary(), MSPerson::MSPersonStage_Walking::getStageSummary(), MSContainer::MSContainerStage_Tranship::getStageSummary(), MSPerson::MSPersonStage_Driving::getStageSummary(), MSPerson::MSPersonStage_Access::getStageSummary(), MSPModel_Striping::moveInDirectionOnLane(), MSRouteHandler::parseWalkPositions(), MSContainer::MSContainerStage_Driving::proceed(), MSPerson::MSPersonStage_Driving::proceed(), MSPerson::proceed(), and MSPerson::MSPersonStage_Access::tripInfoOutput().

◆ getEdge()

const MSEdge * MSTransportable::Stage::getEdge ( ) const

virtual

Returns the current edge.

Reimplemented in MSTransportable::Stage_Driving, MSContainer::MSContainerStage_Tranship, and MSPerson::MSPersonStage_Walking.

Definition at line 61 of file MSTransportable.cpp.

References myDestination.

Referenced by MSTransportable::Stage_Waiting::beginEventOutput(), MSTransportable::Stage_Waiting::endEventOutput(), getArrivalPos(), MSContainer::MSContainerStage_Driving::proceed(), MSPerson::MSPersonStage_Walking::proceed(), MSContainer::proceed(), MSTransportable::Stage_Waiting::proceed(), MSPerson::MSPersonStage_Driving::proceed(), and MSPerson::proceed().

◆ getEdgeAngle()

double MSTransportable::Stage::getEdgeAngle	(	const MSEdge *	e,
		double	at
	)		const

get angle of the edge at a certain position

Definition at line 126 of file MSTransportable.cpp.

References MSEdge::getLanes().

Referenced by MSPModel_NonInteracting::PState::getAngle(), CState::getAngle(), MSTransportable::Stage_Waiting::getAngle(), MSTransportable::Stage_Driving::getAngle(), and getVehicle().

◆ getEdgePos()

double MSTransportable::Stage::getEdgePos ( SUMOTime now ) const

virtual

Reimplemented in MSTransportable::Stage_Driving, MSContainer::MSContainerStage_Tranship, and MSPerson::MSPersonStage_Walking.

Definition at line 73 of file MSTransportable.cpp.

References myArrivalPos.

Referenced by getArrivalPos(), MSTransportable::getFromEdge(), MSEdge::transportable_by_position_sorter::operator()(), MSContainer::MSContainerStage_Driving::proceed(), MSPerson::MSPersonStage_Walking::proceed(), MSContainer::MSContainerStage_Tranship::proceed(), and MSPerson::MSPersonStage_Driving::proceed().

◆ getEdgePosition()

Position MSTransportable::Stage::getEdgePosition	(	const MSEdge *	e,
		double	at,
		double	offset
	)		const

get position on edge e at length at with orthogonal offset

Definition at line 116 of file MSTransportable.cpp.

References getLanePosition(), and MSEdge::getLanes().

Referenced by MSTransportable::Stage_Waiting::getPosition(), MSTransportable::Stage_Driving::getPosition(), and getVehicle().

◆ getEdges()

ConstMSEdgeVector MSTransportable::Stage::getEdges ( ) const

virtual

the edges of the current stage

Reimplemented in MSTransportable::Stage_Driving, MSContainer::MSContainerStage_Tranship, and MSPerson::MSPersonStage_Walking.

Definition at line 91 of file MSTransportable.cpp.

References getDestination().

Referenced by MSTransportable::getEdges(), getVehicle(), MSTransportable::Stage_Driving::getVehicle(), and libsumo::Person::rerouteTraveltime().

◆ getFromEdge()

const MSEdge * MSTransportable::Stage::getFromEdge ( ) const

virtual

Reimplemented in MSTransportable::Stage_Driving, MSContainer::MSContainerStage_Tranship, and MSPerson::MSPersonStage_Walking.

Definition at line 67 of file MSTransportable.cpp.

References myDestination.

Referenced by getArrivalPos().

◆ getLanePosition()

Position MSTransportable::Stage::getLanePosition	(	const MSLane *	lane,
		double	at,
		double	offset
	)		const

get position on lane at length at with orthogonal offset

Definition at line 121 of file MSTransportable.cpp.

References MSLane::getShape(), MSLane::interpolateLanePosToGeometryPos(), and PositionVector::positionAtOffset().

Referenced by CState::computeTranshipTime(), getEdgePosition(), MSPModel_NonInteracting::PState::getPosition(), MSPModel_Striping::PState::getPosition(), and getVehicle().

◆ getPosition()

virtual Position MSTransportable::Stage::getPosition ( SUMOTime now ) const

pure virtual

returns the position of the transportable

Implemented in MSTransportable::Stage_Driving, MSPerson::MSPersonStage_Access, MSTransportable::Stage_Waiting, MSContainer::MSContainerStage_Tranship, and MSPerson::MSPersonStage_Walking.

Referenced by getArrivalPos(), and MSTransportable::getFromEdge().

◆ getSpeed()

double MSTransportable::Stage::getSpeed ( ) const

virtual

the speed of the transportable

Reimplemented in MSTransportable::Stage_Driving, MSContainer::MSContainerStage_Tranship, and MSPerson::MSPersonStage_Walking.

Definition at line 85 of file MSTransportable.cpp.

Referenced by MSTransportable::getFromEdge(), getVehicle(), and MSTransportable::Stage_Driving::getVehicle().

◆ getStageDescription()

virtual std::string MSTransportable::Stage::getStageDescription ( ) const

pure virtual

return (brief) string representation of the current stage

Implemented in MSPerson::MSPersonStage_Access, MSPerson::MSPersonStage_Driving, MSTransportable::Stage_Waiting, MSContainer::MSContainerStage_Tranship, MSPerson::MSPersonStage_Walking, and MSContainer::MSContainerStage_Driving.

Referenced by getStageType().

◆ getStageSummary()

virtual std::string MSTransportable::Stage::getStageSummary ( ) const

pure virtual

return string summary of the current stage

Implemented in MSPerson::MSPersonStage_Access, MSPerson::MSPersonStage_Driving, MSTransportable::Stage_Waiting, MSContainer::MSContainerStage_Tranship, MSPerson::MSPersonStage_Walking, and MSContainer::MSContainerStage_Driving.

Referenced by MSTransportable::Stage_Waiting::getStageDescription(), getStageType(), and MSTransportable::getStageType().

◆ getStageType()

StageType MSTransportable::Stage::getStageType ( ) const

inline

Definition at line 102 of file MSTransportable.h.

References getStageDescription(), getStageSummary(), myType, and proceed().

Referenced by MSTransportable::getStageType(), MSPerson::proceed(), and MSTransportable::rerouteParkingArea().

◆ getVehicle()

virtual SUMOVehicle* MSTransportable::Stage::getVehicle ( ) const

inlinevirtual

Whether the transportable waits for a vehicle.

Reimplemented in MSTransportable::Stage_Driving.

Definition at line 136 of file MSTransportable.h.

References beginEventOutput(), endEventOutput(), getEdgeAngle(), getEdgePosition(), getEdges(), getLanePosition(), getSpeed(), getWaitingTime(), routeOutput(), and tripInfoOutput().

◆ getWaitingTime()

SUMOTime MSTransportable::Stage::getWaitingTime ( SUMOTime now ) const

virtual

the time this transportable spent waiting

Reimplemented in MSTransportable::Stage_Driving, MSTransportable::Stage_Waiting, MSContainer::MSContainerStage_Tranship, and MSPerson::MSPersonStage_Walking.

Definition at line 79 of file MSTransportable.cpp.

Referenced by getVehicle(), and MSTransportable::Stage_Driving::getVehicle().

◆ isWaiting4Vehicle()

virtual bool MSTransportable::Stage::isWaiting4Vehicle ( ) const

inlinevirtual

Whether the transportable waits for a vehicle.

Reimplemented in MSTransportable::Stage_Driving.

Definition at line 131 of file MSTransportable.h.

◆ isWaitingFor()

bool MSTransportable::Stage::isWaitingFor ( const std::string & line ) const

virtual

Whether the transportable waits for a vehicle of the line specified.

Reimplemented in MSTransportable::Stage_Driving.

Definition at line 111 of file MSTransportable.cpp.

Referenced by setSpeed().

◆ operator=()

Stage& MSTransportable::Stage::operator= ( const Stage & )

private

Invalidated assignment operator.

◆ proceed()

virtual void MSTransportable::Stage::proceed	(	MSNet *	net,
		MSTransportable *	transportable,
		SUMOTime	now,
		Stage *	previous
	)

pure virtual

proceeds to this stage

Implemented in MSPerson::MSPersonStage_Access, MSPerson::MSPersonStage_Driving, MSTransportable::Stage_Waiting, MSContainer::MSContainerStage_Tranship, MSPerson::MSPersonStage_Walking, and MSContainer::MSContainerStage_Driving.

Referenced by MSTransportable::Stage_Waiting::getStageDescription(), and getStageType().

◆ routeOutput()

virtual void MSTransportable::Stage::routeOutput ( OutputDevice & os ) const

pure virtual

Called on writing vehroute output.

Parameters

[in] os The stream to write the information into

Exceptions

IOError not yet implemented

Implemented in MSPerson::MSPersonStage_Access, MSPerson::MSPersonStage_Driving, MSTransportable::Stage_Waiting, MSContainer::MSContainerStage_Tranship, MSPerson::MSPersonStage_Walking, and MSContainer::MSContainerStage_Driving.

Referenced by MSTransportable::getEdges(), MSTransportable::Stage_Waiting::getStageDescription(), and getVehicle().

◆ setArrived()

void MSTransportable::Stage::setArrived ( SUMOTime now )

virtual

logs end of the step

Reimplemented in MSTransportable::Stage_Driving.

Definition at line 106 of file MSTransportable.cpp.

References myArrived.

Referenced by MSTransportable::Stage_Driving::getVehicle(), MSContainer::proceed(), MSPerson::proceed(), MSTransportable::Stage_Driving::setArrived(), and setSpeed().

◆ setDeparted()

void MSTransportable::Stage::setDeparted ( SUMOTime now )

logs end of the step

Definition at line 99 of file MSTransportable.cpp.

References myDeparted.

Referenced by MSTransportable::getVehicleType(), and setSpeed().

◆ setSpeed()

virtual void MSTransportable::Stage::setSpeed ( double )

inlinevirtual

sets the walking speed (ignored in other stages)

Reimplemented in MSPerson::MSPersonStage_Walking.

Definition at line 119 of file MSTransportable.h.

References isWaitingFor(), setArrived(), and setDeparted().

Referenced by MSTransportable::getVehicle().

◆ tripInfoOutput()

virtual void MSTransportable::Stage::tripInfoOutput	(	OutputDevice &	os,
		MSTransportable *	transportable
	)		const

pure virtual

Called on writing tripinfo output.

Parameters

[in] os The stream to write the information into

Exceptions

IOError not yet implemented

Implemented in MSPerson::MSPersonStage_Access, MSPerson::MSPersonStage_Driving, MSTransportable::Stage_Waiting, MSContainer::MSContainerStage_Tranship, MSPerson::MSPersonStage_Walking, and MSContainer::MSContainerStage_Driving.

Referenced by MSTransportable::getEdges(), MSTransportable::Stage_Waiting::getStageDescription(), and getVehicle().

Field Documentation

◆ myArrivalPos

double MSTransportable::Stage::myArrivalPos

protected

the position at which we want to arrive

Definition at line 190 of file MSTransportable.h.

Referenced by MSTransportable::Stage_Waiting::getAngle(), getArrivalPos(), MSPerson::MSPersonStage_Walking::getArrivalPos(), MSContainer::MSContainerStage_Tranship::getArrivalPos(), getEdgePos(), MSTransportable::Stage_Waiting::getPosition(), MSTransportable::Stage_Driving::setDestination(), MSContainer::MSContainerStage_Driving::tripInfoOutput(), MSPerson::MSPersonStage_Walking::tripInfoOutput(), MSContainer::MSContainerStage_Tranship::tripInfoOutput(), MSTransportable::Stage_Waiting::tripInfoOutput(), MSPerson::MSPersonStage_Driving::tripInfoOutput(), and MSPerson::MSPersonStage_Walking::walkDistance().

◆ myArrived

SUMOTime MSTransportable::Stage::myArrived

protected

the time at which this stage ended

Definition at line 196 of file MSTransportable.h.

Referenced by setArrived(), MSContainer::MSContainerStage_Driving::tripInfoOutput(), MSPerson::MSPersonStage_Walking::tripInfoOutput(), MSContainer::MSContainerStage_Tranship::tripInfoOutput(), MSTransportable::Stage_Waiting::tripInfoOutput(), MSPerson::MSPersonStage_Driving::tripInfoOutput(), and MSPerson::MSPersonStage_Access::tripInfoOutput().

◆ myDeparted

SUMOTime MSTransportable::Stage::myDeparted

protected

the time at which this stage started

Definition at line 193 of file MSTransportable.h.

Referenced by MSPerson::MSPersonStage_Access::getPosition(), MSTransportable::Stage_Waiting::getWaitingTime(), MSTransportable::Stage_Driving::getWaitingTime(), MSPerson::MSPersonStage_Walking::proceed(), MSContainer::MSContainerStage_Tranship::proceed(), MSTransportable::Stage_Waiting::proceed(), MSPerson::MSPersonStage_Access::proceed(), setDeparted(), MSContainer::MSContainerStage_Driving::tripInfoOutput(), MSPerson::MSPersonStage_Walking::tripInfoOutput(), MSContainer::MSContainerStage_Tranship::tripInfoOutput(), MSTransportable::Stage_Waiting::tripInfoOutput(), MSPerson::MSPersonStage_Driving::tripInfoOutput(), and MSPerson::MSPersonStage_Access::tripInfoOutput().

◆ myDestination

const MSEdge* MSTransportable::Stage::myDestination

protected

the next edge to reach by getting transported

Definition at line 184 of file MSTransportable.h.

Referenced by MSTransportable::Stage_Waiting::getAngle(), getDestination(), getEdge(), getFromEdge(), MSTransportable::Stage_Waiting::getPosition(), and MSTransportable::Stage_Driving::setDestination().

◆ myDestinationStop

MSStoppingPlace* MSTransportable::Stage::myDestinationStop

protected

the stop to reach by getting transported (if any)

Definition at line 187 of file MSTransportable.h.

Referenced by getDestinationStop(), MSTransportable::Stage_Driving::getWaitingDescription(), MSPerson::MSPersonStage_Walking::moveToNextEdge(), MSContainer::MSContainerStage_Tranship::moveToNextEdge(), MSPerson::MSPersonStage_Access::MSPersonStage_Access(), MSPerson::MSPersonStage_Access::proceed(), MSPerson::MSPersonStage_Walking::routeOutput(), MSPerson::MSPersonStage_Driving::routeOutput(), and MSTransportable::Stage_Driving::setDestination().

◆ myType

StageType MSTransportable::Stage::myType

protected

The type of this stage.

Definition at line 199 of file MSTransportable.h.

Referenced by getStageType(), MSTransportable::Stage_Waiting::routeOutput(), and MSTransportable::Stage_Waiting::tripInfoOutput().

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Stage() [1/2]

◆ ~Stage()

◆ Stage() [2/2]

Member Function Documentation

◆ abort()

◆ beginEventOutput()

◆ endEventOutput()

◆ getAngle()

◆ getArrivalPos()

◆ getDestination()

◆ getDestinationStop()

◆ getEdge()

◆ getEdgeAngle()

◆ getEdgePos()

◆ getEdgePosition()

◆ getEdges()

◆ getFromEdge()

◆ getLanePosition()

◆ getPosition()

◆ getSpeed()

◆ getStageDescription()

◆ getStageSummary()

◆ getStageType()

◆ getVehicle()

◆ getWaitingTime()

◆ isWaiting4Vehicle()

◆ isWaitingFor()

◆ operator=()

◆ proceed()

◆ routeOutput()

◆ setArrived()

◆ setDeparted()

◆ setSpeed()

◆ tripInfoOutput()

Field Documentation

◆ myArrivalPos

◆ myArrived

◆ myDeparted

◆ myDestination

◆ myDestinationStop

◆ myType