Eclipse SUMO - Simulation of Urban MObility
MSContainer Class Reference

#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,
  ACCESS = 4, TRIP = 5
}
 

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 MSEdgegetArrivalEdge () 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::StagegetCurrentStage () 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 MSEdgegetDestination () const
 Returns the current destination. More...
 
MSTransportableDevicegetDevice (const std::type_info &type) const
 Returns a device of the given type if it exists or 0. More...
 
const std::vector< MSTransportableDevice * > & getDevices () const
 Returns this vehicle's devices. More...
 
const MSEdgegetEdge () 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 MSEdgegetFromEdge () const
 Returns the departure edge. More...
 
const std::string & getID () const
 returns the id of the transportable More...
 
const MSEdgegetNextDestination () const
 Returns the destination after the current destination. More...
 
MSTransportable::StagegetNextStage (int next) const
 Return the current stage. 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 SUMOVehicleParametergetParameter () const
 
virtual Position getPosition () const
 Return the Network coordinate of the transportable. More...
 
MSVehicleTypegetSingularType ()
 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...
 
std::string getStageSummary (int stageIndex) const
 return textual summary for the given stage More...
 
StageType getStageType (int next) const
 the stage type for the nth next stage More...
 
SUMOVehiclegetVehicle () const
 The vehicle associated with this transportable. More...
 
const MSVehicleTypegetVehicleType () const
 Returns the vehicle's type. More...
 
virtual double getWaitingSeconds () const
 the time this transportable spent waiting in seconds More...
 
bool hasArrived () const
 return whether the person has reached the end of its plan More...
 
bool hasDeparted () const
 return whether the transportable has started it's plan More...
 
bool isWaiting4Vehicle () const
 Whether the transportable waits for a vehicle. More...
 
bool isWaitingFor (const SUMOVehicle *vehicle) const
 Whether the transportable waits for the given vehicle in the current step. 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...
 
void rerouteParkingArea (MSStoppingPlace *orig, MSStoppingPlace *replacement)
 adapt plan when the vehicle reroutes and now stops at replacement instead of orig More...
 
virtual void routeOutput (OutputDevice &os, const bool withRouteLength) 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

std::vector< MSTransportableDevice * > myDevices
 The devices this transportable has. More...
 
const SUMOVehicleParametermyParameter
 the plan of the transportable More...
 
MSTransportablePlanmyPlan
 the plan of the transportable More...
 
MSTransportablePlan::iterator myStep
 the iterator over the route More...
 
MSVehicleTypemyVType
 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...
 
MSContaineroperator= (const MSContainer &)
 Invalidated assignment operator. More...
 

Detailed Description

The class holds a simulated container together with its movement stages

Definition at line 60 of file MSContainer.h.

Member Typedef Documentation

◆ MSTransportablePlan

the structure holding the plan of a transportable

Definition at line 587 of file MSTransportable.h.

Member Enumeration Documentation

◆ StageType

Enumerator
WAITING_FOR_DEPART 
WAITING 
MOVING_WITHOUT_VEHICLE 
DRIVING 
ACCESS 
TRIP 

Definition at line 60 of file MSTransportable.h.

Constructor & Destructor Documentation

◆ MSContainer() [1/2]

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

constructor

Definition at line 302 of file MSContainer.cpp.

◆ ~MSContainer()

MSContainer::~MSContainer ( )
virtual

destructor

Definition at line 307 of file MSContainer.cpp.

◆ MSContainer() [2/2]

MSContainer::MSContainer ( const MSContainer )
private

Invalidated copy constructor.

Member Function Documentation

◆ appendStage()

◆ getAcceleration()

double MSTransportable::getAcceleration ( ) const
inlinevirtualinherited

Returns the vehicle's acceleration.

Returns
The acceleration

Implements SUMOTrafficObject.

Definition at line 569 of file MSTransportable.h.

◆ getAngle()

double MSTransportable::getAngle ( ) const
virtualinherited

◆ getArrivalEdge()

const MSEdge* MSTransportable::getArrivalEdge ( ) const
inlineinherited

returns the final arrival edge

Definition at line 745 of file MSTransportable.h.

References MSTransportable::myPlan.

Referenced by libsumo::Person::appendWaitingStage(), and libsumo::Person::convertTraCIStage().

◆ getArrivalPos()

◆ getBackPositionOnLane()

double MSTransportable::getBackPositionOnLane ( const MSLane lane) const
inlinevirtualinherited

Get the vehicle's back position along the given lane.

Returns
The position of the vehicle (in m from the given lane's begin)

Implements SUMOTrafficObject.

Definition at line 577 of file MSTransportable.h.

References MSTransportable::getEdgePos().

◆ getBoundingBox()

◆ getChosenSpeedFactor()

double MSTransportable::getChosenSpeedFactor ( ) const
inlinevirtualinherited

Implements SUMOTrafficObject.

Definition at line 555 of file MSTransportable.h.

Referenced by GUISUMOViewParent::onUpdSpeedFactor().

◆ getCurrentStage()

◆ getCurrentStageDescription()

std::string MSTransportable::getCurrentStageDescription ( ) const
inlineinherited

◆ getCurrentStageType()

◆ getDesiredDepart()

SUMOTime MSTransportable::getDesiredDepart ( ) const
inherited

Returns the desired departure time.

Definition at line 704 of file MSTransportable.cpp.

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

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

◆ getDestination()

◆ getDevice()

MSTransportableDevice * MSTransportable::getDevice ( const std::type_info &  type) const
inherited

Returns a device of the given type if it exists or 0.

Definition at line 907 of file MSTransportable.cpp.

References MSTransportable::myDevices.

Referenced by MSFCDExport::writeTransportable().

◆ getDevices()

const std::vector<MSTransportableDevice*>& MSTransportable::getDevices ( ) const
inlineinherited

Returns this vehicle's devices.

Returns
This vehicle's devices

Definition at line 788 of file MSTransportable.h.

References MSTransportable::myDevices.

◆ getEdge()

◆ getEdgePos()

◆ getEdges()

ConstMSEdgeVector MSTransportable::getEdges ( int  next) const
inlineinherited

Return the edges of the nth next stage.

Definition at line 689 of file MSTransportable.h.

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

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

◆ getFromEdge()

◆ getID()

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

returns the id of the transportable

Implements SUMOTrafficObject.

Definition at line 699 of file MSTransportable.cpp.

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

Referenced by MSTransportableControl::abortAnyWaitingForVehicle(), MSPModel_Remote::add(), MSPModel_Striping::add(), MSVehicle::addContainer(), MSVehicle::addPerson(), MSTransportable::appendStage(), libsumo::Person::appendWalkingStage(), MSPerson::MSPersonStage_Walking::beginEventOutput(), MSContainer::MSContainerStage_Tranship::beginEventOutput(), MSTransportable::Stage_Waiting::beginEventOutput(), MSTransportable::Stage_Driving::beginEventOutput(), MSTransportableDevice_FCD::buildDevices(), MSTransportableDevice_Routing::buildDevices(), libsumo::Person::convertTraCIStage(), 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(), MSTransportable::getSingularType(), MSPModel_Striping::getVehicleObstacles(), MSEdge::getWaitingVehicle(), MSPedestrianPushButton::isActiveForEdge(), MSPModel_Striping::moveInDirection(), MSPModel_Striping::moveInDirectionOnLane(), libsumo::Person::moveToXY(), MSDevice_Transportable::notifyLeave(), MSEdge::transportable_by_position_sorter::operator()(), MSPerson::MSPersonStage_Driving::proceed(), MSPModel_Striping::PState::PState(), MSPerson::reroute(), MSContainer::MSContainerStage_Driving::routeOutput(), routeOutput(), MSPerson::MSPersonStage_Driving::routeOutput(), MSTransportable::Stage_Waiting::routeOutput(), MSTransportable::Stage_Trip::setArrived(), libsumo::Helper::setRemoteControlled(), tripInfoOutput(), MSPerson::MSPersonStage_Access::tripInfoOutput(), MSPerson::tripInfoOutput(), MSFCDExport::writeTransportable(), MSXMLRawOut::writeTransportable(), and MSDevice_Transportable::~MSDevice_Transportable().

◆ getMaxSpeed()

double MSTransportable::getMaxSpeed ( ) const
virtualinherited

Returns the vehicle's maximum speed.

Returns
The vehicle's maximum speed

Implements SUMOTrafficObject.

Definition at line 930 of file MSTransportable.cpp.

References MSVehicleType::getMaxSpeed(), MSTransportable::getSpeedFactor(), and MSTransportable::getVehicleType().

Referenced by MSTransportable::Stage_Trip::setArrived(), and MSPerson::MSPersonStage_Walking::tripInfoOutput().

◆ getNextDestination()

const MSEdge* MSTransportable::getNextDestination ( ) const
inlineinherited

Returns the destination after the current destination.

Definition at line 622 of file MSTransportable.h.

References MSTransportable::myStep.

◆ getNextStage()

MSTransportable::Stage* MSTransportable::getNextStage ( int  next) const
inlineinherited

◆ getNumRemainingStages()

◆ getNumStages()

◆ getParameter()

◆ getPosition() [1/2]

Position MSTransportable::getPosition ( ) const
virtualinherited

Return the Network coordinate of the transportable.

Reimplemented in GUIContainer, and GUIPerson.

Definition at line 719 of file MSTransportable.cpp.

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

Referenced by MSTransportable::getBoundingBox(), GUIPerson::getGUIPosition(), GUIPerson::getPosition(), GUIContainer::getPosition(), and MSTransportable::getPosition().

◆ getPosition() [2/2]

Position MSTransportable::getPosition ( const double  offset) const
inlinevirtualinherited

Return current position (x/y, cartesian)

If the vehicle is not in the net, Position::INVALID.

Parameters
[in]offsetoptional offset in longitudinal direction
Returns
The current position (in cartesian coordinates)
See also
myLane

Implements SUMOTrafficObject.

Definition at line 581 of file MSTransportable.h.

References MSTransportable::getPosition().

Referenced by MSLink::checkWalkingAreaFoe(), libsumo::Person::moveToXY(), and MSFCDExport::writeTransportable().

◆ getPositionOnLane()

double MSTransportable::getPositionOnLane ( ) const
inlinevirtualinherited

Get the vehicle's position along the lane.

Returns
The position of the vehicle (in m from the lane's begin)

Implements SUMOTrafficObject.

Definition at line 573 of file MSTransportable.h.

References MSTransportable::getEdgePos().

◆ getPreviousSpeed()

double MSTransportable::getPreviousSpeed ( ) const
inlinevirtualinherited

Returns the vehicle's previous speed.

Returns
The vehicle's previous speed

Implements SUMOTrafficObject.

Definition at line 565 of file MSTransportable.h.

References MSTransportable::getSpeed().

◆ getSingularType()

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 804 of file MSTransportable.cpp.

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

Referenced by TraCIServerAPI_Person::processSet().

◆ getSlope()

double MSTransportable::getSlope ( ) const
virtualinherited

Returns the slope of the road at vehicle's position.

Returns
The slope

Implements SUMOTrafficObject.

Definition at line 917 of file MSTransportable.cpp.

References MSTransportable::getEdge(), MSTransportable::getEdgePos(), and MSEdge::getLanes().

◆ getSpeed()

double MSTransportable::getSpeed ( ) const
virtualinherited

◆ getSpeedFactor()

virtual double MSTransportable::getSpeedFactor ( ) const
inlinevirtualinherited

the current speed factor of the transportable (where applicable)

Reimplemented in MSPerson.

Definition at line 652 of file MSTransportable.h.

Referenced by MSPerson::MSPersonStage_Walking::getMaxSpeed(), MSTransportable::getMaxSpeed(), and GUIContainer::getParameterWindow().

◆ getStageSummary()

std::string MSTransportable::getStageSummary ( int  stageIndex) const
inherited

return textual summary for the given stage

Definition at line 833 of file MSTransportable.cpp.

References MSTransportable::myPlan.

Referenced by GUIContainer::GUIContainerPopupMenu::onCmdShowPlan(), and GUIPerson::GUIPersonPopupMenu::onCmdShowPlan().

◆ getStageType()

StageType MSTransportable::getStageType ( int  next) const
inlineinherited

◆ getVClass()

SUMOVehicleClass MSTransportable::getVClass ( ) const
virtualinherited

Returns the vehicle's access class.

Returns
The vehicle's access class

Implements SUMOTrafficObject.

Definition at line 935 of file MSTransportable.cpp.

References MSVehicleType::getVehicleClass(), and MSTransportable::getVehicleType().

Referenced by libsumo::Person::moveToXY().

◆ getVehicle()

SUMOVehicle* MSTransportable::getVehicle ( ) const
inlineinherited

The vehicle associated with this transportable.

Definition at line 726 of file MSTransportable.h.

Referenced by libsumo::Person::getVehicle().

◆ getVehicleType()

◆ getWaitingSeconds()

double MSTransportable::getWaitingSeconds ( ) const
virtualinherited

◆ getWaitingTime()

SUMOTime MSTransportable::getWaitingTime ( ) const
virtualinherited

Implements SUMOTrafficObject.

Definition at line 925 of file MSTransportable.cpp.

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

◆ hasArrived()

bool MSTransportable::hasArrived ( ) const
virtualinherited

return whether the person has reached the end of its plan

Implements SUMOTrafficObject.

Definition at line 841 of file MSTransportable.cpp.

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

Referenced by MSPerson::routeOutput().

◆ hasDeparted()

bool MSTransportable::hasDeparted ( ) const
inherited

return whether the transportable has started it's plan

Definition at line 846 of file MSTransportable.cpp.

References MSTransportable::myPlan.

◆ isStopped()

bool MSTransportable::isStopped ( ) const
inlinevirtualinherited

Returns whether the vehicle is at a stop.

Returns
Whether the has stopped

Implements SUMOTrafficObject.

Definition at line 549 of file MSTransportable.h.

References MSTransportable::getCurrentStageType(), and MSTransportable::WAITING.

◆ isVehicle()

bool MSTransportable::isVehicle ( ) const
inlinevirtualinherited

Get the vehicle's ID.

Returns
The the ID of the vehicle

Implements SUMOTrafficObject.

Definition at line 545 of file MSTransportable.h.

◆ isWaiting4Vehicle()

◆ isWaitingFor()

bool MSTransportable::isWaitingFor ( const SUMOVehicle vehicle) const
inlineinherited

Whether the transportable waits for the given vehicle in the current step.

Definition at line 716 of file MSTransportable.h.

Referenced by MSEdge::getWaitingVehicle().

◆ operator=()

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

Invalidated assignment operator.

◆ proceed()

◆ removeStage()

◆ replaceVehicleType()

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]typeThe new vehicle type
See also
MSTransportable::myVType

Definition at line 795 of file MSTransportable.cpp.

References MSNet::getInstance(), MSNet::getVehicleControl(), MSVehicleType::isVehicleSpecific(), MSTransportable::myVType, and MSVehicleControl::removeVType().

Referenced by MSTransportable::getSingularType(), and libsumo::Person::setType().

◆ rerouteParkingArea()

◆ routeOutput()

void MSContainer::routeOutput ( OutputDevice os,
const bool  withRouteLength 
) const
virtual

Called on writing vehroute output.

Parameters
[in]osThe stream to write the information into
[in]withRouteLengthwhether route length shall be written
Exceptions
IOErrornot yet implemented

Implements MSTransportable.

Definition at line 342 of file MSContainer.cpp.

References OutputDevice::closeTag(), MSTransportable::getDesiredDepart(), MSTransportable::getID(), MSNet::getInstance(), OutputDevice::lf(), MSTransportable::myPlan, MSTransportable::myStep, OutputDevice::openTag(), SUMO_ATTR_DEPART, SUMO_ATTR_ID, SUMO_TAG_CONTAINER, time2string(), and OutputDevice::writeAttr().

◆ setDeparted()

void MSTransportable::setDeparted ( SUMOTime  now)
inherited

logs depart time of the current stage

Definition at line 709 of file MSTransportable.cpp.

◆ setSpeed()

void MSTransportable::setSpeed ( double  speed)
inherited

sets the walking speed (ignored in other stages)

Definition at line 787 of file MSTransportable.cpp.

References MSTransportable::myPlan.

Referenced by libsumo::Person::setSpeed().

◆ tripInfoOutput()

void MSContainer::tripInfoOutput ( OutputDevice os) const
virtual

Called on writing tripinfo output.

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

Implements MSTransportable.

Definition at line 332 of file MSContainer.cpp.

References OutputDevice::closeTag(), MSTransportable::getDesiredDepart(), MSTransportable::getID(), MSTransportable::myPlan, OutputDevice::openTag(), time2string(), and OutputDevice::writeAttr().

Field Documentation

◆ myDevices

std::vector<MSTransportableDevice*> MSTransportable::myDevices
protectedinherited

◆ myParameter

const SUMOVehicleParameter* MSTransportable::myParameter
protectedinherited

◆ myPlan

◆ myStep

◆ myVType

MSVehicleType* MSTransportable::myVType
protectedinherited

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

Definition at line 801 of file MSTransportable.h.

Referenced by MSTransportable::getSingularType(), GUIPerson::getTypeParameterWindow(), GUIContainer::getTypeParameterWindow(), MSTransportable::getVehicleType(), MSTransportable::replaceVehicleType(), and MSTransportable::~MSTransportable().

◆ myWriteEvents

bool MSTransportable::myWriteEvents
protectedinherited

Whether events shall be written.

Definition at line 804 of file MSTransportable.h.

◆ ROADSIDE_OFFSET

const double MSTransportable::ROADSIDE_OFFSET
staticprotectedinherited

the offset for computing positions when standing at an edge

Definition at line 794 of file MSTransportable.h.

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


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