Eclipse SUMO - Simulation of Urban MObility
MSStop Class Reference

#include <MSStop.h>

Collaboration diagram for MSStop:
[legend]

Public Member Functions

std::string getDescription () const
 get a short description for showing in the gui More...
 
double getEndPos (const SUMOVehicle &veh) const
 return halting position for upcoming stop; More...
 
void initPars (const SUMOVehicleParameter::Stop &stopPar)
 initialize attributes from the given stop parameters More...
 
 MSStop (const SUMOVehicleParameter::Stop &par)
 
void write (OutputDevice &dev) const
 Write the current stop configuration (used for state saving) More...
 

Data Fields

MSStoppingPlacebusstop = nullptr
 (Optional) bus stop if one is assigned to the stop More...
 
MSStoppingPlacechargingStation = nullptr
 (Optional) charging station if one is assigned to the stop More...
 
bool collision = false
 Whether this stop was triggered by a collision. More...
 
MSStoppingPlacecontainerstop = nullptr
 (Optional) container stop if one is assigned to the stop More...
 
bool containerTriggered = false
 whether an arriving container lets the vehicle continue More...
 
SUMOTime duration = -1
 The stopping duration. More...
 
MSRouteIterator edge
 The edge in the route to stop at. More...
 
SUMOTime endBoarding = SUMOTime_MAX
 the maximum time at which persons may board this vehicle More...
 
bool joinTriggered = false
 whether coupling another vehicle (train) the vehicle continue More...
 
const MSLanelane = nullptr
 The lane to stop at (microsim only) More...
 
int numExpectedContainer = 0
 The number of still expected containers. More...
 
int numExpectedPerson = 0
 The number of still expected persons. More...
 
MSStoppingPlaceoverheadWireSegment = nullptr
 (Optional) overhead wire segment if one is assigned to the stop More...
 
MSParkingAreaparkingarea = nullptr
 (Optional) parkingArea if one is assigned to the stop More...
 
const SUMOVehicleParameter::Stop pars
 The stop parameter. More...
 
bool reached = false
 Information whether the stop has been reached. More...
 
const MESegmentsegment = nullptr
 The segment to stop at (mesosim only) More...
 
SUMOTime timeToBoardNextPerson = 0
 The time at which the vehicle is able to board another person. More...
 
SUMOTime timeToLoadNextContainer = 0
 The time at which the vehicle is able to load another container. More...
 
bool triggered = false
 whether an arriving person lets the vehicle continue More...
 

Private Member Functions

MSStopoperator= (const MSStop &src)=delete
 Invalidated assignment operator. More...
 

Detailed Description

Definition at line 44 of file MSStop.h.

Constructor & Destructor Documentation

◆ MSStop()

MSStop::MSStop ( const SUMOVehicleParameter::Stop par)
inline

Definition at line 46 of file MSStop.h.

Member Function Documentation

◆ getDescription()

std::string MSStop::getDescription ( ) const

get a short description for showing in the gui

Definition at line 50 of file MSStop.cpp.

References busstop, chargingStation, containerstop, SUMOVehicleParameter::Stop::endPos, Named::getID(), lane, overheadWireSegment, parkingarea, pars, and toString().

◆ getEndPos()

double MSStop::getEndPos ( const SUMOVehicle veh) const

return halting position for upcoming stop;

Definition at line 33 of file MSStop.cpp.

References busstop, chargingStation, containerstop, SUMOVehicleParameter::Stop::endPos, MSParkingArea::getLastFreePos(), MSStoppingPlace::getLastFreePos(), overheadWireSegment, parkingarea, and pars.

Referenced by MSBaseVehicle::addStop(), MSBaseVehicle::getStopEdges(), MSLane::insertVehicle(), and MSVehicle::planMoveInternal().

Here is the caller graph for this function:

◆ initPars()

◆ operator=()

MSStop& MSStop::operator= ( const MSStop src)
privatedelete

Invalidated assignment operator.

◆ write()

Field Documentation

◆ busstop

MSStoppingPlace* MSStop::busstop = nullptr

(Optional) bus stop if one is assigned to the stop

Definition at line 54 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), getDescription(), getEndPos(), LIBSUMO_NAMESPACE::Vehicle::getStopState(), initPars(), MSVehicle::processNextStop(), and write().

◆ chargingStation

MSStoppingPlace* MSStop::chargingStation = nullptr

(Optional) charging station if one is assigned to the stop

Definition at line 60 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), getDescription(), getEndPos(), LIBSUMO_NAMESPACE::Vehicle::getStopState(), initPars(), MSVehicle::processNextStop(), and write().

◆ collision

bool MSStop::collision = false

Whether this stop was triggered by a collision.

Definition at line 85 of file MSStop.h.

Referenced by MSBaseVehicle::addStop().

◆ containerstop

MSStoppingPlace* MSStop::containerstop = nullptr

(Optional) container stop if one is assigned to the stop

Definition at line 56 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), getDescription(), getEndPos(), LIBSUMO_NAMESPACE::Vehicle::getStopState(), initPars(), MSVehicle::processNextStop(), and write().

◆ containerTriggered

bool MSStop::containerTriggered = false

whether an arriving container lets the vehicle continue

Definition at line 71 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), MSIdling_Stop::idle(), initPars(), and MSVehicle::processNextStop().

◆ duration

SUMOTime MSStop::duration = -1

◆ edge

◆ endBoarding

SUMOTime MSStop::endBoarding = SUMOTime_MAX

the maximum time at which persons may board this vehicle

Definition at line 87 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), MSDevice_Taxi::notifyMove(), and MSVehicle::processNextStop().

◆ joinTriggered

bool MSStop::joinTriggered = false

whether coupling another vehicle (train) the vehicle continue

Definition at line 73 of file MSStop.h.

Referenced by initPars(), and MSVehicle::processNextStop().

◆ lane

◆ numExpectedContainer

int MSStop::numExpectedContainer = 0

The number of still expected containers.

Definition at line 79 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), and initPars().

◆ numExpectedPerson

int MSStop::numExpectedPerson = 0

The number of still expected persons.

Definition at line 77 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), and initPars().

◆ overheadWireSegment

MSStoppingPlace* MSStop::overheadWireSegment = nullptr

(Optional) overhead wire segment if one is assigned to the stop

Todo:
Check that this should really be a stopping place instance

Definition at line 63 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), getDescription(), getEndPos(), and initPars().

◆ parkingarea

◆ pars

◆ reached

◆ segment

const MESegment* MSStop::segment = nullptr

The segment to stop at (mesosim only)

Definition at line 52 of file MSStop.h.

Referenced by MSBaseVehicle::addStop(), and MEVehicle::processStop().

◆ timeToBoardNextPerson

SUMOTime MSStop::timeToBoardNextPerson = 0

The time at which the vehicle is able to board another person.

Definition at line 81 of file MSStop.h.

Referenced by MSVehicle::boardTransportables().

◆ timeToLoadNextContainer

SUMOTime MSStop::timeToLoadNextContainer = 0

The time at which the vehicle is able to load another container.

Definition at line 83 of file MSStop.h.

Referenced by MSVehicle::boardTransportables().

◆ triggered

bool MSStop::triggered = false

whether an arriving person lets the vehicle continue

Definition at line 69 of file MSStop.h.

Referenced by MSVehicle::boardTransportables(), MSIdling_Stop::idle(), initPars(), and MSVehicle::processNextStop().


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