SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MSTransportable::Stage Class Referenceabstract

#include <MSTransportable.h>

Inheritance diagram for MSTransportable::Stage:
MSContainer::MSContainerStage_Driving MSContainer::MSContainerStage_Tranship MSContainer::MSContainerStage_Waiting MSPerson::MSPersonStage_Driving MSPerson::MSPersonStage_Waiting MSPerson::MSPersonStage_Walking

Public Member Functions

virtual void beginEventOutput (const MSTransportable &container, SUMOTime t, OutputDevice &os) const =0
 Called for writing the events output (begin of an action) More...
 
virtual void endEventOutput (const MSTransportable &container, SUMOTime t, OutputDevice &os) const =0
 Called for writing the events output (end of an action) More...
 
virtual SUMOReal getAngle (SUMOTime now) const =0
 returns the angle of the transportable More...
 
const MSEdge & getDestination () const
 returns the destination edge More...
 
virtual const MSEdge * getEdge () const =0
 Returns the current edge. More...
 
SUMOReal getEdgeAngle (const MSEdge *e, SUMOReal at) const
 get angle of the edge at a certain position More...
 
virtual SUMOReal getEdgePos (SUMOTime now) const =0
 
Position getEdgePosition (const MSEdge *e, SUMOReal at, SUMOReal offset) const
 get position on edge e at length at with orthogonal offset More...
 
virtual const MSEdge * getFromEdge () const =0
 
Position getLanePosition (const MSLane *lane, SUMOReal at, SUMOReal 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 SUMOReal getSpeed () const =0
 the speed of the transportable More...
 
virtual std::string getStageDescription () const =0
 return string representation of the current stage More...
 
StageType getStageType () const
 
virtual SUMOTime getWaitingTime (SUMOTime now) const =0
 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, MSEdge *previousEdge, const SUMOReal at)=0
 proceeds to the next step More...
 
virtual void routeOutput (OutputDevice &os) const =0
 Called on writing vehroute output. More...
 
void setArrived (SUMOTime now)
 logs end of the step More...
 
void setDeparted (SUMOTime now)
 logs end of the step More...
 
 Stage (const MSEdge &destination, StageType type)
 constructor More...
 
virtual void tripInfoOutput (OutputDevice &os) const =0
 Called on writing tripinfo output. More...
 
virtual ~Stage ()
 destructor More...
 

Protected Attributes

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

Constructor & Destructor Documentation

MSTransportable::Stage::Stage ( const MSEdge &  destination,
StageType  type 
)

constructor

Definition at line 48 of file MSTransportable.cpp.

MSTransportable::Stage::~Stage ( )
virtual

destructor

Definition at line 51 of file MSTransportable.cpp.

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

Invalidated copy constructor.

Member Function Documentation

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

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

Parameters
[in]osThe stream to write the information into
Exceptions
IOErrornot yet implemented

Implemented in MSPerson::MSPersonStage_Waiting, MSContainer::MSContainerStage_Tranship, MSPerson::MSPersonStage_Driving, MSContainer::MSContainerStage_Waiting, MSContainer::MSContainerStage_Driving, and MSPerson::MSPersonStage_Walking.

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

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

Parameters
[in]osThe stream to write the information into
Exceptions
IOErrornot yet implemented

Implemented in MSPerson::MSPersonStage_Waiting, MSContainer::MSContainerStage_Tranship, MSPerson::MSPersonStage_Driving, MSContainer::MSContainerStage_Waiting, MSContainer::MSContainerStage_Driving, and MSPerson::MSPersonStage_Walking.

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

returns the destination edge

Definition at line 54 of file MSTransportable.cpp.

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

get angle of the edge at a certain position

Definition at line 86 of file MSTransportable.cpp.

References MSEdge::getLanes(), and PositionVector::rotationDegreeAtOffset().

Referenced by MSPModel_NonInteracting::PState::getAngle(), and CState::getAngle().

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

get position on edge e at length at with orthogonal offset

Definition at line 76 of file MSTransportable.cpp.

References MSEdge::getLanes().

Position MSTransportable::Stage::getLanePosition ( const MSLane *  lane,
SUMOReal  at,
SUMOReal  offset 
) const
virtual Position MSTransportable::Stage::getPosition ( SUMOTime  now) const
pure virtual
virtual std::string MSTransportable::Stage::getStageDescription ( ) const
pure virtual
StageType MSTransportable::Stage::getStageType ( ) const
inline

Definition at line 88 of file MSTransportable.h.

References myType.

virtual SUMOTime MSTransportable::Stage::getWaitingTime ( SUMOTime  now) const
pure virtual
virtual bool MSTransportable::Stage::isWaiting4Vehicle ( ) const
inlinevirtual

Whether the transportable waits for a vehicle.

Reimplemented in MSPerson::MSPersonStage_Driving, and MSContainer::MSContainerStage_Driving.

Definition at line 108 of file MSTransportable.h.

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

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

Reimplemented in MSPerson::MSPersonStage_Driving, and MSContainer::MSContainerStage_Driving.

Definition at line 71 of file MSTransportable.cpp.

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

Invalidated assignment operator.

virtual void MSTransportable::Stage::proceed ( MSNet *  net,
MSTransportable *  transportable,
SUMOTime  now,
MSEdge *  previousEdge,
const SUMOReal  at 
)
pure virtual
virtual void MSTransportable::Stage::routeOutput ( OutputDevice &  os) const
pure virtual

Called on writing vehroute output.

Parameters
[in]osThe stream to write the information into
Exceptions
IOErrornot yet implemented

Implemented in MSPerson::MSPersonStage_Waiting, MSContainer::MSContainerStage_Tranship, MSPerson::MSPersonStage_Driving, MSContainer::MSContainerStage_Waiting, MSContainer::MSContainerStage_Driving, and MSPerson::MSPersonStage_Walking.

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

logs end of the step

Definition at line 66 of file MSTransportable.cpp.

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

logs end of the step

Definition at line 59 of file MSTransportable.cpp.

virtual void MSTransportable::Stage::tripInfoOutput ( OutputDevice &  os) const
pure virtual

Called on writing tripinfo output.

Parameters
[in]osThe stream to write the information into
Exceptions
IOErrornot yet implemented

Implemented in MSPerson::MSPersonStage_Waiting, MSContainer::MSContainerStage_Tranship, MSPerson::MSPersonStage_Driving, MSContainer::MSContainerStage_Waiting, MSContainer::MSContainerStage_Driving, and MSPerson::MSPersonStage_Walking.

Field Documentation

SUMOTime MSTransportable::Stage::myArrived
protected

the time at which this stage ended

Definition at line 159 of file MSTransportable.h.

SUMOTime MSTransportable::Stage::myDeparted
protected

the time at which this stage started

Definition at line 156 of file MSTransportable.h.

const MSEdge& MSTransportable::Stage::myDestination
protected

the next edge to reach by getting transported

Definition at line 153 of file MSTransportable.h.

Referenced by MSContainer::MSContainerStage_Waiting::MSContainerStage_Waiting(), and MSPerson::MSPersonStage_Waiting::MSPersonStage_Waiting().

StageType MSTransportable::Stage::myType
protected

The type of this stage.

Definition at line 162 of file MSTransportable.h.

Referenced by getStageType().


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