#include <MSTransportable.h>

Inheritance diagram for MSTransportable:

Collaboration diagram for MSTransportable:

Data Structures
class	Stage

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

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

Public Member Functions
virtual SUMOReal	getAngle () const
	return the current angle of the transportable 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 SUMOReal	getEdgePos () const
	Return the position on the edge. 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...

const SUMOVehicleParameter &	getParameter () const

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

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

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

const MSVehicleType &	getVehicleType () const

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

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	tripInfoOutput (OutputDevice &os) const
	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...

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 55 of file MSTransportable.h.

Member Typedef Documentation

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

the structure holding the plan of a transportable

Definition at line 196 of file MSTransportable.h.

Member Enumeration Documentation

enum MSTransportable::StageType

Enumerator
DRIVING
WAITING
MOVING_WITHOUT_VEHICLE

Definition at line 57 of file MSTransportable.h.

Constructor & Destructor Documentation

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

constructor

Definition at line 95 of file MSTransportable.cpp.

References myPlan, and myStep.

MSTransportable::~MSTransportable ( )

virtual

destructor

Definition at line 100 of file MSTransportable.cpp.

References myParameter, and myPlan.

MSTransportable::MSTransportable ( const MSTransportable & )

private

Invalidated copy constructor.

Member Function Documentation

SUMOReal MSTransportable::getAngle ( ) const

virtual

return the current angle of the transportable

Reimplemented in GUIContainer.

Definition at line 134 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(), and MSFCDExport::write().

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

inline

Return the current stage.

Definition at line 271 of file MSTransportable.h.

References myStep.

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

std::string MSTransportable::getCurrentStageDescription ( ) const

inline

Returns the current stage description as a string.

Definition at line 266 of file MSTransportable.h.

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

StageType MSTransportable::getCurrentStageType ( ) const

inline

the current stage type of the transportable

Definition at line 261 of file MSTransportable.h.

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

SUMOTime MSTransportable::getDesiredDepart ( ) const

Returns the desired departure time.

Definition at line 114 of file MSTransportable.cpp.

References SUMOVehicleParameter::depart, and myParameter.

Referenced by MSContainerControl::erase(), MSPersonControl::erase(), MSPerson::routeOutput(), and MSContainer::routeOutput().

const MSEdge& MSTransportable::getDestination ( ) const

inline

Returns the current destination.

Definition at line 226 of file MSTransportable.h.

Referenced by GUIContainer::getParameterWindow(), GUIPerson::getParameterWindow(), MSDevice_Container::notifyLeave(), MSDevice_Person::notifyLeave(), MSDevice_Container::notifyMove(), MSDevice_Person::notifyMove(), MSContainer::MSContainerStage_Driving::routeOutput(), MSContainer::MSContainerStage_Waiting::routeOutput(), MSPerson::MSPersonStage_Driving::routeOutput(), and MSPerson::MSPersonStage_Waiting::routeOutput().

const MSEdge* MSTransportable::getEdge ( ) const

inline

Returns the current edge.

Definition at line 236 of file MSTransportable.h.

Referenced by MSPModel_Striping::add(), MSContainer::MSContainerStage_Driving::beginEventOutput(), MSContainer::MSContainerStage_Waiting::beginEventOutput(), MSPerson::MSPersonStage_Driving::beginEventOutput(), MSPerson::MSPersonStage_Waiting::beginEventOutput(), MSContainer::MSContainerStage_Driving::endEventOutput(), MSContainer::MSContainerStage_Waiting::endEventOutput(), MSPerson::MSPersonStage_Driving::endEventOutput(), MSPerson::MSPersonStage_Waiting::endEventOutput(), MSContainer::MSContainerStage_Driving::getEdgePos(), MSPerson::MSPersonStage_Driving::getEdgePos(), GUIContainer::getParameterWindow(), GUIPerson::getParameterWindow(), GUIContainer::getPosition(), MSPerson::MSPersonStage_Walking::moveToNextEdge(), MSContainer::MSContainerStage_Tranship::moveToNextEdge(), and TraCIServerAPI_Person::processGet().

SUMOReal MSTransportable::getEdgePos ( ) const

virtual

Return the position on the edge.

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 124 of file MSTransportable.cpp.

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

Referenced by GUIContainer::getEdgePos(), GUIPerson::getEdgePos(), TraCIServerAPI_Person::processGet(), and MSFCDExport::write().

const MSEdge* MSTransportable::getFromEdge ( ) const

inline

Returns the departure edge.

Definition at line 241 of file MSTransportable.h.

Referenced by GUIContainer::getParameterWindow(), GUIPerson::getParameterWindow(), MSContainer::MSContainerStage_Driving::routeOutput(), and MSPerson::MSPersonStage_Driving::routeOutput().

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

returns the id of the transportable

Definition at line 109 of file MSTransportable.cpp.

References SUMOVehicleParameter::id, and myParameter.

const MSEdge& MSTransportable::getNextDestination ( ) const

inline

Returns the destination after the current destination.

Definition at line 231 of file MSTransportable.h.

References myStep.

const SUMOVehicleParameter& MSTransportable::getParameter ( ) const

inline

Definition at line 211 of file MSTransportable.h.

References myParameter.

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

Position MSTransportable::getPosition ( ) const

virtual

Return the Network coordinate of the transportable.

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 129 of file MSTransportable.cpp.

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

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

SUMOReal MSTransportable::getSpeed ( ) const

virtual

the current speed of the transportable

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 144 of file MSTransportable.cpp.

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

SUMOVehicle* MSTransportable::getVehicle ( ) const

inline

The vehicle associated with this transportable.

Definition at line 300 of file MSTransportable.h.

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

const MSVehicleType& MSTransportable::getVehicleType ( ) const

inline

Definition at line 215 of file MSTransportable.h.

References myVType.

Referenced by MSStoppingPlace::addTransportable(), GUIContainer::drawAction_drawAsImage(), GUIPerson::drawAction_drawAsImage(), GUIContainer::drawAction_drawAsPoly(), GUIPerson::drawAction_drawAsPoly(), GUIPerson::drawAction_drawAsTriangle(), MSPModel_Striping::getNextLaneObstacles(), TraCIServerAPI_Person::processGet(), MSStoppingPlace::removeTransportable(), GUIContainer::setFunctionalColor(), and GUIPerson::setFunctionalColor().

SUMOReal MSTransportable::getWaitingSeconds ( ) const

virtual

the time this transportable spent waiting in seconds

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 139 of file MSTransportable.cpp.

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

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

bool MSTransportable::isWaiting4Vehicle ( ) const

inline

Whether the transportable waits for a vehicle.

Definition at line 295 of file MSTransportable.h.

Referenced by MSPerson::MSPersonStage_Driving::getAngle(), GUIContainer::getCenteringBoundary(), GUIPerson::getCenteringBoundary(), GUIContainer::getColorValue(), GUIPerson::getColorValue(), MSPerson::MSPersonStage_Driving::getEdgePos(), GUIContainer::getPosition(), GUIPerson::getPosition(), MSPerson::MSPersonStage_Driving::getPosition(), MSPerson::MSPersonStage_Driving::getSpeed(), MSContainer::MSContainerStage_Driving::getStageDescription(), MSPerson::MSPersonStage_Driving::getStageDescription(), MSContainer::MSContainerStage_Driving::getWaitingTime(), and MSPerson::MSPersonStage_Driving::getWaitingTime().

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

inline

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

Definition at line 290 of file MSTransportable.h.

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

private

Invalidated assignment operator.

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

pure virtual

Implemented in MSContainer, and MSPerson.

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

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 MSContainer, and MSPerson.

Referenced by MSContainerControl::erase(), and MSPersonControl::erase().

void MSTransportable::setDeparted ( SUMOTime now )

logs depart time of the current stage

Definition at line 119 of file MSTransportable.cpp.

void MSTransportable::tripInfoOutput ( OutputDevice & os ) const

Called on writing tripinfo output.

Parameters

[in] os The stream to write the information into

Exceptions

IOError not yet implemented

Definition at line 150 of file MSTransportable.cpp.

References myPlan.

Referenced by MSContainerControl::erase(), and MSPersonControl::erase().

Field Documentation

const SUMOVehicleParameter* MSTransportable::myParameter

protected

the plan of the transportable

Definition at line 306 of file MSTransportable.h.

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

MSTransportablePlan* MSTransportable::myPlan

protected

the plan of the transportable

Definition at line 316 of file MSTransportable.h.

Referenced by MSTransportable(), MSPerson::proceed(), MSContainer::proceed(), MSPerson::routeOutput(), MSContainer::routeOutput(), tripInfoOutput(), and ~MSTransportable().

MSTransportablePlan::iterator MSTransportable::myStep

protected

the iterator over the route

Definition at line 319 of file MSTransportable.h.

Referenced by getCurrentStage(), getNextDestination(), MSTransportable(), MSPerson::proceed(), and MSContainer::proceed().

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 310 of file MSTransportable.h.

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

bool MSTransportable::myWriteEvents

protected

Whether events shall be written.

Definition at line 313 of file MSTransportable.h.

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

Data Structures

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation