#include <MSContainer.h>

Inheritance diagram for MSContainer:

Collaboration diagram for MSContainer:

Data Structures
class	MSContainerStage_Driving

class	MSContainerStage_Tranship

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, int next=-1)
	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...

PositionVector	getBoundingBox () const
	return the bounding box of the person 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...

MSVehicleType &	getSingularType ()
	Replaces the current vehicle type with a new one used by this vehicle only. More...

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

virtual double	getSpeedFactor () const
	the current speed factor of the transportable (where applicable) 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...

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

virtual bool	proceed (MSNet *net, SUMOTime time)

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

void	replaceVehicleType (MSVehicleType *type)
	Replaces the current vehicle type by the one given. More...

virtual void	routeOutput (OutputDevice &os) const
	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
	Called on writing tripinfo output. More...

virtual	~MSContainer ()
	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...

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
	MSContainer (const MSContainer &)
	Invalidated copy constructor. More...

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

Detailed Description

The class holds a simulated container together with its movement stages

Definition at line 68 of file MSContainer.h.

Member Typedef Documentation

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

inherited

the structure holding the plan of a transportable

Definition at line 378 of file MSTransportable.h.

Member Enumeration Documentation

enum MSTransportable::StageType

inherited

Enumerator
WAITING_FOR_DEPART
WAITING
MOVING_WITHOUT_VEHICLE
DRIVING

Definition at line 64 of file MSTransportable.h.

Constructor & Destructor Documentation

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

constructor

Definition at line 253 of file MSContainer.cpp.

MSContainer::~MSContainer ( )

virtual

destructor

Definition at line 258 of file MSContainer.cpp.

MSContainer::MSContainer ( const MSContainer & )

private

Invalidated copy constructor.

Member Function Documentation

void MSTransportable::appendStage	(	Stage *	stage,
		int	next = `-1`
	)

inherited

Appends the given stage to the current plan.

Definition at line 441 of file MSTransportable.cpp.

References MSTransportable::getID(), MSTransportable::myPlan, MSTransportable::myStep, and toString().

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

double MSTransportable::getAngle ( ) const

virtualinherited

return the current angle of the transportable

Reimplemented in GUIContainer.

Definition at line 415 of file MSTransportable.cpp.

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

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

const MSEdge* MSTransportable::getArrivalEdge ( ) const

inlineinherited

returns the final arrival edge

Definition at line 526 of file MSTransportable.h.

References MSTransportable::getBoundingBox(), MSTransportable::getSingularType(), MSTransportable::myPlan, and MSTransportable::replaceVehicleType().

Referenced by TraCIServerAPI_Person::processSet().

double MSTransportable::getArrivalPos ( ) const

inlineinherited

returns the final arrival pos

Definition at line 521 of file MSTransportable.h.

References MSTransportable::myPlan.

Referenced by TraCIServerAPI_Person::processSet().

PositionVector MSTransportable::getBoundingBox ( ) const

inherited

return the bounding box of the person

Definition at line 506 of file MSTransportable.cpp.

References PositionVector::append(), MSTransportable::getAngle(), MSVehicleType::getLength(), MSTransportable::getPosition(), MSTransportable::getVehicleType(), PositionVector::move2side(), POSITION_EPS, and PositionVector::reverse().

Referenced by MSTransportable::getArrivalEdge().

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

inlineinherited

Return the current stage.

Definition at line 465 of file MSTransportable.h.

References MSTransportable::myStep.

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

std::string MSTransportable::getCurrentStageDescription ( ) const

inlineinherited

Returns the current stage description as a string.

Definition at line 460 of file MSTransportable.h.

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

StageType MSTransportable::getCurrentStageType ( ) const

inlineinherited

the current stage type of the transportable

Definition at line 448 of file MSTransportable.h.

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

SUMOTime MSTransportable::getDesiredDepart ( ) const

inherited

Returns the desired departure time.

Definition at line 395 of file MSTransportable.cpp.

References SUMOVehicleParameter::depart, and MSTransportable::myParameter.

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

const MSEdge& MSTransportable::getDestination ( ) const

inlineinherited

Returns the current destination.

Definition at line 408 of file MSTransportable.h.

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

const MSEdge* MSTransportable::getEdge ( ) const

inlineinherited

Returns the current edge.

Definition at line 418 of file MSTransportable.h.

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

double MSTransportable::getEdgePos ( ) const

virtualinherited

Return the position on the edge.

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 405 of file MSTransportable.cpp.

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

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

ConstMSEdgeVector MSTransportable::getEdges ( int next ) const

inlineinherited

Return the edges of the nth next stage.

Definition at line 470 of file MSTransportable.h.

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

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

const MSEdge* MSTransportable::getFromEdge ( ) const

inlineinherited

Returns the departure edge.

Definition at line 423 of file MSTransportable.h.

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

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

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

inherited

returns the id of the transportable

Definition at line 390 of file MSTransportable.cpp.

References SUMOVehicleParameter::id, and MSTransportable::myParameter.

Referenced by MSTransportableControl::abortWaitingForVehicle(), MSPModel_Remote::add(), MSPModel_Striping::add(), MSBaseVehicle::addContainer(), MSVehicle::addContainer(), MSBaseVehicle::addPerson(), MSVehicle::addPerson(), MSTransportable::appendStage(), MSPerson::MSPersonStage_Walking::beginEventOutput(), MSContainer::MSContainerStage_Tranship::beginEventOutput(), MSTransportable::Stage_Waiting::beginEventOutput(), MSTransportable::Stage_Driving::beginEventOutput(), MSPerson::MSPersonStage_Walking::endEventOutput(), MSContainer::MSContainerStage_Tranship::endEventOutput(), MSTransportable::Stage_Waiting::endEventOutput(), MSTransportable::Stage_Driving::endEventOutput(), MSTransportableControl::erase(), MSPModel_Striping::MovePedestrians::execute(), MSPModel_Striping::getNeighboringObstacles(), MSPModel_Striping::getNextLane(), MSPModel_Striping::getNextLaneObstacles(), GUIContainer::getParameterWindow(), GUIPerson::getParameterWindow(), MSTransportable::getSingularType(), MSPedestrianPushButton::isActiveForEdge(), MSPModel_Striping::moveInDirection(), MSPModel_Striping::moveInDirectionOnLane(), MSPModel_Striping::PState::moveToNextLane(), MSDevice_Transportable::notifyLeave(), MSPModel_Striping::by_xpos_sorter::operator()(), MSEdge::transportable_by_position_sorter::operator()(), MSContainer::MSContainerStage_Driving::proceed(), MSPerson::MSPersonStage_Driving::proceed(), MSPModel_Striping::PState::PState(), MSContainer::MSContainerStage_Driving::routeOutput(), routeOutput(), MSTransportable::Stage_Waiting::routeOutput(), MSPerson::MSPersonStage_Driving::routeOutput(), MSPerson::routeOutput(), tripInfoOutput(), MSPerson::tripInfoOutput(), MSPModel_Striping::PState::walk(), MSFCDExport::writeTransportable(), and MSXMLRawOut::writeTransportable().

const MSEdge& MSTransportable::getNextDestination ( ) const

inlineinherited

Returns the destination after the current destination.

Definition at line 413 of file MSTransportable.h.

References MSTransportable::myStep.

int MSTransportable::getNumRemainingStages ( ) const

inherited

Return the number of remaining stages (including the current)

Definition at line 431 of file MSTransportable.cpp.

References MSTransportable::myPlan, and MSTransportable::myStep.

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

int MSTransportable::getNumStages ( ) const

inherited

Return the total number stages in this persons plan.

Definition at line 436 of file MSTransportable.cpp.

References MSTransportable::myPlan.

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

const SUMOVehicleParameter& MSTransportable::getParameter ( ) const

inlineinherited

Definition at line 393 of file MSTransportable.h.

References MSTransportable::myParameter.

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

Position MSTransportable::getPosition ( ) const

virtualinherited

Return the Network coordinate of the transportable.

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 410 of file MSTransportable.cpp.

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

Referenced by MSTransportable::getBoundingBox(), MSLink::getLeaderInfo(), TraCIServerAPI_Person::getPosition(), GUIContainer::getPosition(), GUIPerson::getPosition(), TraCIServerAPI_Person::processGet(), and MSFCDExport::writeTransportable().

MSVehicleType & MSTransportable::getSingularType ( )

inherited

Replaces the current vehicle type with a new one used by this vehicle only.

If the currently used vehicle type is already marked as being used by this vehicle only, no new type is created.

Returns: The new modifiable vehicle type

See also: MSTransportable::myVType

Definition at line 495 of file MSTransportable.cpp.

References MSVehicleType::buildSingularType(), MSVehicleType::getID(), MSTransportable::getID(), MSVehicleType::isVehicleSpecific(), MSTransportable::myVType, and MSTransportable::replaceVehicleType().

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

double MSTransportable::getSpeed ( ) const

virtualinherited

the current speed of the transportable

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 425 of file MSTransportable.cpp.

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

virtual double MSTransportable::getSpeedFactor ( ) const

inlinevirtualinherited

the current speed factor of the transportable (where applicable)

Reimplemented in MSPerson.

Definition at line 443 of file MSTransportable.h.

StageType MSTransportable::getStageType ( int next ) const

inlineinherited

the stage type for the nth next stage

Definition at line 453 of file MSTransportable.h.

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

Referenced by TraCIServerAPI_Person::processGet().

SUMOVehicle* MSTransportable::getVehicle ( ) const

inlineinherited

The vehicle associated with this transportable.

Definition at line 507 of file MSTransportable.h.

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

Referenced by TraCIServerAPI_Person::processGet().

const MSVehicleType& MSTransportable::getVehicleType ( ) const

inlineinherited

Definition at line 397 of file MSTransportable.h.

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

double MSTransportable::getWaitingSeconds ( ) const

virtualinherited

the time this transportable spent waiting in seconds

Reimplemented in GUIPerson, and GUIContainer.

Definition at line 420 of file MSTransportable.cpp.

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

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

bool MSTransportable::isWaiting4Vehicle ( ) const

inlineinherited

Whether the transportable waits for a vehicle.

Definition at line 502 of file MSTransportable.h.

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

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

inlineinherited

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

Definition at line 497 of file MSTransportable.h.

MSContainer& MSContainer::operator= ( const MSContainer & )

private

Invalidated assignment operator.

bool MSContainer::proceed	(	MSNet *	net,
		SUMOTime	time
	)

virtual

Implements MSTransportable.

Definition at line 263 of file MSContainer.cpp.

References MSTransportable::Stage::getEdge(), MSTransportable::myPlan, MSTransportable::myStep, MSEdge::removeContainer(), and MSTransportable::Stage::setArrived().

void MSTransportable::removeStage ( int next )

inherited

removes the nth next stage

Definition at line 457 of file MSTransportable.cpp.

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

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

void MSTransportable::replaceVehicleType ( MSVehicleType * type )

inherited

Replaces the current vehicle type by the one given.

If the currently used vehicle type is marked as being used by this vehicle only, it is deleted, first. The new, given type is then assigned to "myVType".

Parameters

[in] type The new vehicle type