#include <MSTransportable.h>

Inheritance diagram for MSTransportable:

Collaboration diagram for MSTransportable:

Data Structures
class	Stage

class	Stage_Driving

class	Stage_Waiting

Public Types
typedef std::vector< MSTransportable::Stage * >	MSTransportablePlan
	the structure holding the plan of a transportable More...

enum	StageType { WAITING_FOR_DEPART = 0, WAITING = 1, MOVING_WITHOUT_VEHICLE = 2, DRIVING = 3 }

Public Member Functions
void	appendStage (Stage *stage)
	Appends the given stage to the current plan. More...

virtual double	getAngle () const
	return the current angle of the transportable More...

const MSEdge *	getArrivalEdge () const
	returns the final arrival edge More...

double	getArrivalPos () const
	returns the final arrival pos More...

MSTransportable::Stage *	getCurrentStage () const
	Return the current stage. More...

std::string	getCurrentStageDescription () const
	Returns the current stage description as a string. More...

StageType	getCurrentStageType () const
	the current stage type of the transportable More...

SUMOTime	getDesiredDepart () const
	Returns the desired departure time. More...

const MSEdge &	getDestination () const
	Returns the current destination. More...

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

virtual double	getEdgePos () const
	Return the position on the edge. More...

ConstMSEdgeVector	getEdges (int next) const
	Return the edges of the nth next stage. More...

const MSEdge *	getFromEdge () const
	Returns the departure edge. More...

const std::string &	getID () const
	returns the id of the transportable More...

const MSEdge &	getNextDestination () const
	Returns the destination after the current destination. More...

int	getNumRemainingStages () const
	Return the number of remaining stages (including the current) More...

int	getNumStages () const
	Return the total number stages in this persons plan. More...

const SUMOVehicleParameter &	getParameter () const

virtual Position	getPosition () const
	Return the Network coordinate of the transportable. More...

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

StageType	getStageType (int next) const
	the stage type for the nth next stage More...

SUMOVehicle *	getVehicle () const
	The vehicle associated with this transportable. More...

const MSVehicleType &	getVehicleType () const

virtual double	getWaitingSeconds () const
	the time this transportable spent waiting in seconds More...

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

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

	MSTransportable (const SUMOVehicleParameter pars, const MSVehicleType vtype, MSTransportablePlan *plan)
	constructor More...

virtual bool	proceed (MSNet *net, SUMOTime time)=0

void	removeStage (int next)
	removes the nth next stage More...

void	replaceVehicleType (MSVehicleType *type)
	replace myVType More...

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

void	setDeparted (SUMOTime now)
	logs depart time of the current stage More...

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

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

virtual	~MSTransportable ()
	destructor More...

Protected Attributes
const SUMOVehicleParameter *	myParameter
	the plan of the transportable More...

MSTransportablePlan *	myPlan
	the plan of the transportable More...

MSTransportablePlan::iterator	myStep
	the iterator over the route More...

const MSVehicleType *	myVType
	This transportable's type. (mainly used for drawing related information Note sure if it is really necessary. More...

bool	myWriteEvents
	Whether events shall be written. More...

Static Protected Attributes
static const double	ROADSIDE_OFFSET
	the offset for computing positions when standing at an edge More...

Private Member Functions
	MSTransportable (const MSTransportable &)
	Invalidated copy constructor. More...

MSTransportable &	operator= (const MSTransportable &)
	Invalidated assignment operator. More...

Detailed Description

The class holds a simulated moveable object

Definition at line 60 of file MSTransportable.h.

Member Typedef Documentation

◆ MSTransportablePlan

typedef std::vector<MSTransportable::Stage*> MSTransportable::MSTransportablePlan

the structure holding the plan of a transportable

Definition at line 377 of file MSTransportable.h.

Member Enumeration Documentation

◆ StageType

enum MSTransportable::StageType

Enumerator
WAITING_FOR_DEPART
WAITING
MOVING_WITHOUT_VEHICLE
DRIVING

Definition at line 62 of file MSTransportable.h.

Constructor & Destructor Documentation

◆ MSTransportable() [1/2]

MSTransportable::MSTransportable	(	const SUMOVehicleParameter *	pars,
		const MSVehicleType *	vtype,
		MSTransportablePlan *	plan
	)

constructor

Definition at line 344 of file MSTransportable.cpp.

References myPlan, and myStep.

◆ ~MSTransportable()

MSTransportable::~MSTransportable ( )

virtual

destructor

Definition at line 349 of file MSTransportable.cpp.

References myParameter, and myPlan.

◆ MSTransportable() [2/2]

MSTransportable::MSTransportable ( const MSTransportable & )

private

Invalidated copy constructor.

Member Function Documentation

◆ appendStage()

void MSTransportable::appendStage ( Stage * stage )

Appends the given stage to the current plan.

Definition at line 412 of file MSTransportable.cpp.

References myPlan, and myStep.

Referenced by getVehicle(), TraCIServerAPI_Person::processSet(), and removeStage().

◆ getAngle()

double MSTransportable::getAngle ( ) const

virtual

return the current angle of the transportable

Reimplemented in GUIContainer.

Definition at line 386 of file MSTransportable.cpp.

References MSNet::getCurrentTimeStep(), and MSNet::getInstance().

Referenced by GUIPerson::drawAction_drawAsImage(), GUIPerson::drawAction_drawAsPoly(), GUIPerson::drawAction_drawAsTriangle(), GUIContainer::getAngle(), GUIPerson::getNaviDegree(), TraCIServerAPI_Person::processGet(), GUIPerson::setFunctionalColor(), MSFCDExport::writeTransportable(), and MSXMLRawOut::writeTransportable().

◆ getArrivalEdge()

const MSEdge* MSTransportable::getArrivalEdge ( ) const

inline

returns the final arrival edge

Definition at line 520 of file MSTransportable.h.

References myPlan, and replaceVehicleType().

Referenced by TraCIServerAPI_Person::processSet().

◆ getArrivalPos()

double MSTransportable::getArrivalPos ( ) const

inline

returns the final arrival pos

Definition at line 515 of file MSTransportable.h.

References myPlan.

Referenced by TraCIServerAPI_Person::processSet().

◆ getCurrentStage()

MSTransportable::Stage* MSTransportable::getCurrentStage ( ) const

inline

Return the current stage.

Definition at line 459 of file MSTransportable.h.

References myStep.

Referenced by GUIPerson::drawAction_drawWalkingareaPath(), GUIPerson::drawGLAdditional(), and MSEdge::transportable_by_position_sorter::operator()().

◆ getCurrentStageDescription()

std::string MSTransportable::getCurrentStageDescription ( ) const

inline

Returns the current stage description as a string.

Definition at line 454 of file MSTransportable.h.

Referenced by GUIContainer::getParameterWindow(), GUIPerson::getParameterWindow(), and MSXMLRawOut::writeTransportable().

◆ getCurrentStageType()

StageType MSTransportable::getCurrentStageType ( ) const

inline

the current stage type of the transportable

Definition at line 442 of file MSTransportable.h.

Referenced by MSPModel_Striping::add(), GUIContainer::drawGL(), GUIPerson::drawGL(), GUIPerson::drawGLAdditional(), GUIContainer::getColorValue(), GUIPerson::getColorValue(), MSPerson::getNextEdgePtr(), and GUIContainer::getPosition().

◆ getDesiredDepart()

SUMOTime MSTransportable::getDesiredDepart ( ) const

Returns the desired departure time.

Definition at line 366 of file MSTransportable.cpp.

References SUMOVehicleParameter::depart, and myParameter.

Referenced by getVehicleType(), MSContainer::routeOutput(), MSPerson::routeOutput(), MSContainer::tripInfoOutput(), and MSPerson::tripInfoOutput().

◆ getDestination()

const MSEdge& MSTransportable::getDestination ( ) const

inline

Returns the current destination.

Definition at line 407 of file MSTransportable.h.

Referenced by GUIContainer::getParameterWindow(), GUIPerson::getParameterWindow(), MSDevice_Transportable::notifyLeave(), and MSDevice_Transportable::notifyMove().

◆ getEdge()

const MSEdge* MSTransportable::getEdge ( ) const

inline

Returns the current edge.

Definition at line 417 of file MSTransportable.h.

Referenced by MSPModel_Striping::add(), GUIContainer::getParameterWindow(), GUIPerson::getParameterWindow(), GUIContainer::getPosition(), TraCIServerAPI_Person::processGet(), and removeStage().

◆ getEdgePos()

double MSTransportable::getEdgePos ( ) const

virtual

Return the position on the edge.

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 376 of file MSTransportable.cpp.

References MSNet::getCurrentTimeStep(), and MSNet::getInstance().

Referenced by GUIContainer::getEdgePos(), GUIPerson::getEdgePos(), TraCIServerAPI_Person::processGet(), removeStage(), MSFCDExport::writeTransportable(), and MSXMLRawOut::writeTransportable().

◆ getEdges()

ConstMSEdgeVector MSTransportable::getEdges ( int next ) const

inline

Return the edges of the nth next stage.

Definition at line 464 of file MSTransportable.h.

References MSTransportable::Stage::getEdges(), getNumRemainingStages(), getNumStages(), myPlan, myStep, MSTransportable::Stage::routeOutput(), and MSTransportable::Stage::tripInfoOutput().

Referenced by TraCIServerAPI_Person::processGet().

◆ getFromEdge()

const MSEdge* MSTransportable::getFromEdge ( ) const

inline

Returns the departure edge.

Definition at line 422 of file MSTransportable.h.

References MSTransportable::Stage::getAngle(), MSTransportable::Stage::getEdgePos(), MSTransportable::Stage::getPosition(), MSTransportable::Stage::getSpeed(), and getWaitingSeconds().

Referenced by GUIContainer::getParameterWindow(), and GUIPerson::getParameterWindow().

◆ getID()

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

returns the id of the transportable

Definition at line 361 of file MSTransportable.cpp.

References SUMOVehicleParameter::id, and myParameter.

◆ getNextDestination()

const MSEdge& MSTransportable::getNextDestination ( ) const

inline

Returns the destination after the current destination.

Definition at line 412 of file MSTransportable.h.

References myStep.

◆ getNumRemainingStages()

int MSTransportable::getNumRemainingStages ( ) const

Return the number of remaining stages (including the current)

Definition at line 402 of file MSTransportable.cpp.

References myPlan, and myStep.

Referenced by getEdges(), TraCIServerAPI_Person::processGet(), and TraCIServerAPI_Person::processSet().

◆ getNumStages()

int MSTransportable::getNumStages ( ) const

Return the total number stages in this persons plan.

Definition at line 407 of file MSTransportable.cpp.

References myPlan.

Referenced by getEdges(), and TraCIServerAPI_Person::processGet().

◆ getParameter()

const SUMOVehicleParameter& MSTransportable::getParameter ( ) const

inline

Definition at line 392 of file MSTransportable.h.

References myParameter.

Referenced by MSTransportableControl::add(), GUIPerson::getParameterWindow(), TraCIServerAPI_Person::processGet(), TraCIServerAPI_Person::processSet(), GUIContainer::setFunctionalColor(), and GUIPerson::setFunctionalColor().

◆ getPosition()

Position MSTransportable::getPosition ( ) const

virtual

Return the Network coordinate of the transportable.

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 381 of file MSTransportable.cpp.

References MSNet::getCurrentTimeStep(), and MSNet::getInstance().

Referenced by TraCIServerAPI_Person::getPosition(), GUIContainer::getPosition(), GUIPerson::getPosition(), TraCIServerAPI_Person::processGet(), and MSFCDExport::writeTransportable().

◆ getSpeed()

double MSTransportable::getSpeed ( ) const

virtual

the current speed of the transportable

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 396 of file MSTransportable.cpp.

Referenced by GUIContainer::getSpeed(), GUIPerson::getSpeed(), TraCIServerAPI_Person::processGet(), and MSFCDExport::writeTransportable().

◆ getStageType()

StageType MSTransportable::getStageType ( int next ) const

inline

the stage type for the nth next stage

Definition at line 447 of file MSTransportable.h.

References MSTransportable::Stage::getStageType(), myPlan, and myStep.

Referenced by TraCIServerAPI_Person::processGet().

◆ getVehicle()

SUMOVehicle* MSTransportable::getVehicle ( ) const

inline

The vehicle associated with this transportable.

Definition at line 501 of file MSTransportable.h.

References appendStage(), removeStage(), and MSTransportable::Stage::setSpeed().

Referenced by TraCIServerAPI_Person::processGet().

◆ getVehicleType()

const MSVehicleType& MSTransportable::getVehicleType ( ) const

inline

Definition at line 396 of file MSTransportable.h.

References getDesiredDepart(), myVType, and MSTransportable::Stage::setDeparted().

Referenced by MSStoppingPlace::addTransportable(), GUIContainer::drawAction_drawAsImage(), GUIPerson::drawAction_drawAsImage(), GUIContainer::drawAction_drawAsPoly(), GUIPerson::drawAction_drawAsPoly(), GUIPerson::drawAction_drawAsTriangle(), GUIPerson::getCenteringBoundary(), MSPModel_Striping::PState::getImpatience(), MSPModel_Striping::PState::getLength(), MSPModel_Striping::PState::getMinGap(), MSPModel_Striping::getNextLaneObstacles(), TraCIServerAPI_Person::getSingularType(), MSPModel_Striping::PState::otherStripe(), TraCIServerAPI_Person::processGet(), TraCIServerAPI_Person::processSet(), MSStoppingPlace::removeTransportable(), GUIContainer::setFunctionalColor(), and GUIPerson::setFunctionalColor().

◆ getWaitingSeconds()

double MSTransportable::getWaitingSeconds ( ) const

virtual

the time this transportable spent waiting in seconds

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 391 of file MSTransportable.cpp.

References MSNet::getCurrentTimeStep(), MSNet::getInstance(), and STEPS2TIME.

Referenced by getFromEdge(), GUIContainer::getWaitingSeconds(), GUIPerson::getWaitingSeconds(), MSPedestrianPushButton::isActiveForEdge(), and TraCIServerAPI_Person::processGet().

◆ isWaiting4Vehicle()

bool MSTransportable::isWaiting4Vehicle ( ) const

inline

Whether the transportable waits for a vehicle.

Definition at line 496 of file MSTransportable.h.

Referenced by GUIContainer::drawGL(), GUIPerson::drawGL(), GUIContainer::getColorValue(), and GUIPerson::getColorValue().

◆ isWaitingFor()

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

inline

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

Definition at line 491 of file MSTransportable.h.

◆ operator=()

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

private

Invalidated assignment operator.

◆ proceed()

virtual bool MSTransportable::proceed	(	MSNet *	net,
		SUMOTime	time
	)

pure virtual

Implemented in MSPerson, and MSContainer.

Referenced by MSContainer::MSContainerStage_Tranship::moveToNextEdge(), MSDevice_Transportable::notifyLeave(), MSDevice_Transportable::notifyMove(), MSPerson::MSPersonStage_Walking::proceed(), and removeStage().

◆ removeStage()

void MSTransportable::removeStage ( int next )

removes the nth next stage

Definition at line 421 of file MSTransportable.cpp.

References appendStage(), getEdge(), getEdgePos(), MSNet::getInstance(), myPlan, myStep, and proceed().

Referenced by getVehicle(), and TraCIServerAPI_Person::processSet().

◆ replaceVehicleType()

void MSTransportable::replaceVehicleType ( MSVehicleType * type )

replace myVType

Definition at line 450 of file MSTransportable.cpp.

References myVType.

Referenced by getArrivalEdge(), TraCIServerAPI_Person::getSingularType(), and TraCIServerAPI_Person::processSet().

◆ routeOutput()

virtual void MSTransportable::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, and MSContainer.

Referenced by MSTransportableControl::erase().

◆ setDeparted()

void MSTransportable::setDeparted ( SUMOTime now )

logs depart time of the current stage

Definition at line 371 of file MSTransportable.cpp.

◆ setSpeed()

void MSTransportable::setSpeed ( double speed )

sets the walking speed (ignored in other stages)

Definition at line 442 of file MSTransportable.cpp.

References myPlan.

Referenced by TraCIServerAPI_Person::processSet().

◆ tripInfoOutput()

virtual void MSTransportable::tripInfoOutput ( OutputDevice & os ) 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, and MSContainer.

Referenced by MSTransportableControl::erase().

Field Documentation

◆ myParameter

const SUMOVehicleParameter* MSTransportable::myParameter

protected

the plan of the transportable

Definition at line 532 of file MSTransportable.h.

Referenced by getDesiredDepart(), getID(), getParameter(), and ~MSTransportable().

◆ myPlan

MSTransportablePlan* MSTransportable::myPlan

protected

the plan of the transportable

Definition at line 542 of file MSTransportable.h.

Referenced by appendStage(), getArrivalEdge(), getArrivalPos(), getEdges(), getNumRemainingStages(), getNumStages(), getStageType(), MSTransportable(), MSContainer::proceed(), MSPerson::proceed(), removeStage(), MSContainer::routeOutput(), MSPerson::routeOutput(), setSpeed(), MSContainer::tripInfoOutput(), MSPerson::tripInfoOutput(), and ~MSTransportable().

◆ myStep

MSTransportablePlan::iterator MSTransportable::myStep

protected

the iterator over the route

Definition at line 545 of file MSTransportable.h.

Referenced by appendStage(), getCurrentStage(), getEdges(), getNextDestination(), getNumRemainingStages(), getStageType(), MSTransportable(), MSContainer::proceed(), MSPerson::proceed(), removeStage(), MSContainer::routeOutput(), and MSPerson::routeOutput().

◆ myVType

const MSVehicleType* MSTransportable::myVType

protected

This transportable's type. (mainly used for drawing related information Note sure if it is really necessary.

Definition at line 536 of file MSTransportable.h.

Referenced by GUIPerson::getTypeParameterWindow(), getVehicleType(), and replaceVehicleType().

◆ myWriteEvents

bool MSTransportable::myWriteEvents

protected

Whether events shall be written.

Definition at line 539 of file MSTransportable.h.

◆ ROADSIDE_OFFSET

const double MSTransportable::ROADSIDE_OFFSET

staticprotected

the offset for computing positions when standing at an edge

Definition at line 529 of file MSTransportable.h.

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

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

Data Structures

Public Types

Public Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ MSTransportablePlan

Member Enumeration Documentation

◆ StageType

Constructor & Destructor Documentation

◆ MSTransportable() [1/2]

◆ ~MSTransportable()

◆ MSTransportable() [2/2]

Member Function Documentation

◆ appendStage()

◆ getAngle()

◆ getArrivalEdge()

◆ getArrivalPos()

◆ getCurrentStage()

◆ getCurrentStageDescription()

◆ getCurrentStageType()

◆ getDesiredDepart()

◆ getDestination()

◆ getEdge()

◆ getEdgePos()

◆ getEdges()

◆ getFromEdge()

◆ getID()

◆ getNextDestination()

◆ getNumRemainingStages()

◆ getNumStages()

◆ getParameter()

◆ getPosition()

◆ getSpeed()

◆ getStageType()

◆ getVehicle()

◆ getVehicleType()

◆ getWaitingSeconds()

◆ isWaiting4Vehicle()

◆ isWaitingFor()

◆ operator=()

◆ proceed()

◆ removeStage()

◆ replaceVehicleType()

◆ routeOutput()

◆ setDeparted()

◆ setSpeed()

◆ tripInfoOutput()

Field Documentation

◆ myParameter

◆ myPlan

◆ myStep

◆ myVType

◆ myWriteEvents

◆ ROADSIDE_OFFSET