Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
MSStage Class Referenceabstract

#include <MSStage.h>

Inheritance diagram for MSStage:
[legend]
Collaboration diagram for MSStage:
[legend]

Public Types

typedef std::map< std::string, std::string > Map
 parameters map
 

Public Member Functions

virtual void abort (MSTransportable *)
 abort this stage (TraCI)
 
void clearParameter ()
 Clears the parameter map.
 
virtual MSStageclone () const =0
 
virtual bool equals (const MSStage &s) const
 
virtual double getAngle (SUMOTime now) const =0
 returns the angle of the transportable
 
virtual double getArrivalPos () const
 
virtual double getArrivalPosLat () const
 
SUMOTime getArrived () const
 get arrival time of stage
 
double getCosts () const
 Returns the costs of the stage.
 
SUMOTime getDeparted () const
 get departure time of stage
 
const MSEdgegetDestination () const
 returns the destination edge
 
MSStoppingPlacegetDestinationStop () const
 returns the destination stop (if any)
 
virtual int getDirection () const
 Return the movement directon on the edge.
 
virtual double getDistance () const =0
 get travel distance in this stage
 
double getDouble (const std::string &key, const double defaultValue) const
 Returns the value for a given key converted to a double.
 
std::vector< double > getDoubles (const std::string &key, std::vector< double > defaultValue=std::vector< double >()) const
 Returns the value for a given key converted to a list of doubles.
 
virtual SUMOTime getDuration () const
 
virtual const MSEdgegetEdge () const
 Returns the current edge.
 
double getEdgeAngle (const MSEdge *e, double at) const
 get angle of the edge at a certain position
 
virtual double getEdgePos (SUMOTime now) const
 
Position getEdgePosition (const MSEdge *e, double at, double offset) const
 get position on edge e at length at with orthogonal offset
 
virtual double getEdgePosLat (SUMOTime now) const
 
virtual ConstMSEdgeVector getEdges () const
 the edges of the current stage
 
virtual const MSEdgegetFromEdge () const
 
const std::string & getGroup () const
 return the id of the group of transportables traveling together
 
virtual const MSLanegetLane () const
 Returns the current lane (if applicable)
 
Position getLanePosition (const MSLane *lane, double at, double offset) const
 get position on lane at length at with orthogonal offset
 
virtual MSStoppingPlacegetOriginStop () const
 returns the origin stop (if any). only needed for MSStageTrip
 
virtual const std::string getParameter (const std::string &key, const std::string defaultValue="") const
 Returns the value for a given key.
 
const Parameterised::MapgetParametersMap () const
 Returns the inner key/value map.
 
std::string getParametersStr (const std::string kvsep="=", const std::string sep="|") const
 Returns the inner key/value map in string format "key1=value1|key2=value2|...|keyN=valueN".
 
virtual Position getPosition (SUMOTime now) const =0
 returns the position of the transportable
 
virtual int getRoutePosition () const
 return index of current edge within route
 
virtual double getSpeed () const
 the speed of the transportable
 
virtual std::string getStageDescription (const bool isPerson) const =0
 return (brief) string representation of the current stage
 
virtual std::string getStageSummary (const bool isPerson) const =0
 return string summary of the current stage
 
MSStageType getStageType () const
 
virtual SUMOTime getTimeLoss (const MSTransportable *transportable) const
 
virtual SUMOTime getTravelTime () const
 
MSStageTripgetTrip () const
 
virtual SUMOVehiclegetVehicle () const
 Current vehicle in which the transportable is driving (or nullptr)
 
virtual SUMOTime getWaitingTime () const
 
virtual SUMOTime getWaitingTime (SUMOTime now) const
 the time this transportable spent waiting
 
bool hasParameter (const std::string &key) const
 Returns whether the parameter is set.
 
virtual void init (MSTransportable *)
 initialization, e.g. for param-related events
 
virtual bool isWaiting4Vehicle () const
 Whether the transportable waits for a vehicle.
 
virtual bool isWaitingFor (const SUMOVehicle *vehicle) const
 Whether the transportable waits for the given vehicle.
 
virtual bool isWalk () const
 Whether the transportable is walking.
 
virtual void loadState (MSTransportable *transportable, std::istringstream &state)
 Reconstructs the current state, standard implementation does nothing.
 
void markSet (int what)
 
void mergeParameters (const Parameterised::Map &mapArg, const std::string separator=" ", bool uniqueValues=true)
 Adds or appends all given parameters from the map.
 
 MSStage (const MSStageType type, const MSEdge *destination, MSStoppingPlace *toStop, const double arrivalPos, const double arrivalPosLat=0.0, const std::string &group="")
 constructor
 
virtual void proceed (MSNet *net, MSTransportable *transportable, SUMOTime now, MSStage *previous)=0
 proceeds to this stage
 
virtual void routeOutput (const bool isPerson, OutputDevice &os, const bool withRouteLength, const MSStage *const previous) const =0
 Called on writing vehroute output.
 
virtual void saveState (std::ostringstream &out)
 Saves the current state into the given stream, standard implementation does nothing.
 
void setArrivalPos (double arrivalPos)
 
virtual const std::string setArrived (MSNet *net, MSTransportable *transportable, SUMOTime now, const bool vehicleArrived)
 logs end of the step
 
void setCosts (double costs)
 Sets the costs of the stage.
 
void setDeparted (SUMOTime now)
 logs end of the step
 
void setDestination (const MSEdge *newDestination, MSStoppingPlace *newDestStop)
 
virtual void setParameter (const std::string &key, const std::string &value)
 Sets a parameter.
 
void setParameters (const Parameterised &params)
 set the inner key/value map in map<string, string> format
 
void setParametersStr (const std::string &paramsString, const std::string kvsep="=", const std::string sep="|")
 set the inner key/value map in string format "key1=value1|key2=value2|...|keyN=valueN"
 
virtual void setSpeed (double)
 sets the walking speed (ignored in other stages)
 
void setTrip (MSStageTrip *trip)
 
virtual void tripInfoOutput (OutputDevice &os, const MSTransportable *const transportable) const =0
 Called on writing tripinfo output.
 
void unsetParameter (const std::string &key)
 Removes a parameter.
 
void updateParameters (const Parameterised::Map &mapArg)
 Adds or updates all given parameters from the map.
 
bool wasSet (int what) const
 
void writeParams (OutputDevice &device) const
 write Params in the given outputdevice
 
virtual ~MSStage ()
 destructor
 

Static Public Member Functions

static bool areAttributesValid (const std::string &value, bool report=false, const std::string kvsep="=", const std::string sep="|")
 check if given string can be parsed to an attributes map "key1=value1|key2=value2|...|keyN=valueN" (used in generic datas)
 
static bool areParametersValid (const std::string &value, bool report=false, const std::string kvsep="=", const std::string sep="|")
 check if given string can be parsed to a parameters map "key1=value1|key2=value2|...|keyN=valueN"
 

Protected Attributes

double myArrivalPos
 the longitudinal position at which we want to arrive
 
double myArrivalPosLat
 the lateral position at which we want to arrive
 
SUMOTime myArrived
 the time at which this stage ended
 
double myCosts
 The assigned or calculated costs.
 
SUMOTime myDeparted
 the time at which this stage started
 
const MSEdgemyDestination
 the next edge to reach by getting transported
 
MSStoppingPlacemyDestinationStop
 the stop to reach by getting transported (if any)
 
const std::string myGroup
 The id of the group of transportables traveling together.
 
int myParametersSet
 Information on which parameter were set (mainly for vehroute output)
 
MSStageTripmyTrip = nullptr
 
MSStageType myType
 The type of this stage.
 

Static Protected Attributes

static const double ROADSIDE_OFFSET
 the offset for computing positions when standing at an edge
 

Private Member Functions

 MSStage (const MSStage &)
 Invalidated copy constructor.
 
MSStageoperator= (const MSStage &)=delete
 Invalidated assignment operator.
 

Static Private Member Functions

static bool isParameterValid (const std::string &value, const std::string &kvsep, const std::string &sep)
 check if given string can be parsed to a parameter of type "key=value"
 

Private Attributes

Parameterised::Map myMap
 The key->value map.
 

Detailed Description

The "abstract" class for a single stage of a movement Contains the destination of the current movement step

Definition at line 69 of file MSStage.h.

Member Typedef Documentation

◆ Map

typedef std::map<std::string, std::string> Parameterised::Map
inherited

parameters map

Definition at line 45 of file Parameterised.h.

Constructor & Destructor Documentation

◆ MSStage() [1/2]

MSStage::MSStage ( const MSStageType  type,
const MSEdge destination,
MSStoppingPlace toStop,
const double  arrivalPos,
const double  arrivalPosLat = 0.0,
const std::string &  group = "" 
)

constructor

Definition at line 47 of file MSStage.cpp.

◆ ~MSStage()

MSStage::~MSStage ( )
virtual

destructor

Definition at line 61 of file MSStage.cpp.

◆ MSStage() [2/2]

MSStage::MSStage ( const MSStage )
private

Invalidated copy constructor.

Member Function Documentation

◆ abort()

virtual void MSStage::abort ( MSTransportable )
inlinevirtual

abort this stage (TraCI)

Reimplemented in MSStageWaiting, MSStageWalking, and MSStageDriving.

Definition at line 146 of file MSStage.h.

Referenced by GUIPerson::GUIPersonPopupMenu::onCmdRemoveObject().

Here is the caller graph for this function:

◆ areAttributesValid()

bool Parameterised::areAttributesValid ( const std::string &  value,
bool  report = false,
const std::string  kvsep = "=",
const std::string  sep = "|" 
)
staticinherited

check if given string can be parsed to an attributes map "key1=value1|key2=value2|...|keyN=valueN" (used in generic datas)

Definition at line 219 of file Parameterised.cpp.

References StringTokenizer::getVector(), Parameterised::isParameterValid(), TL, and WRITE_WARNINGF.

Referenced by GNEFrameAttributeModules::GenericDataAttributes::areAttributesValid(), GNEEdgeData::isValid(), GNEEdgeRelData::isValid(), and GNETAZRelData::isValid().

Here is the caller graph for this function:

◆ areParametersValid()

bool Parameterised::areParametersValid ( const std::string &  value,
bool  report = false,
const std::string  kvsep = "=",
const std::string  sep = "|" 
)
staticinherited

◆ clearParameter()

void Parameterised::clearParameter ( )
inherited

Clears the parameter map.

Definition at line 139 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by NLHandler::beginEdgeParsing(), and GNESingleParametersDialog::onCmdAccept().

Here is the caller graph for this function:

◆ clone()

virtual MSStage * MSStage::clone ( ) const
pure virtual

◆ equals()

virtual bool MSStage::equals ( const MSStage s) const
inlinevirtual

Reimplemented in MSStageDriving, MSStageMoving, and MSStageWalking.

Definition at line 276 of file MSStage.h.

References myArrivalPos, myArrivalPosLat, myDestination, myDestinationStop, myGroup, and myType.

Referenced by MSStageDriving::equals(), and MSStageMoving::equals().

Here is the caller graph for this function:

◆ getAngle()

virtual double MSStage::getAngle ( SUMOTime  now) const
pure virtual

returns the angle of the transportable

Implemented in MSPerson::MSPersonStage_Access, MSStageDriving, MSStageMoving, MSStageTrip, and MSStageWaiting.

◆ getArrivalPos()

◆ getArrivalPosLat()

virtual double MSStage::getArrivalPosLat ( ) const
inlinevirtual

Definition at line 98 of file MSStage.h.

References myArrivalPosLat.

Referenced by MSPerson::checkAccess().

Here is the caller graph for this function:

◆ getArrived()

SUMOTime MSStage::getArrived ( ) const

get arrival time of stage

Definition at line 133 of file MSStage.cpp.

References myArrived.

Referenced by LIBSUMO_NAMESPACE::Person::getStage().

Here is the caller graph for this function:

◆ getCosts()

double MSStage::getCosts ( ) const
inline

Returns the costs of the stage.

Returns
The stage's costs (normally the time needed to pass it)

Definition at line 256 of file MSStage.h.

References myCosts.

Referenced by MSStageDriving::routeOutput(), MSStageTranship::routeOutput(), MSStageTrip::routeOutput(), and MSStageWalking::routeOutput().

Here is the caller graph for this function:

◆ getDeparted()

SUMOTime MSStage::getDeparted ( ) const

get departure time of stage

Definition at line 128 of file MSStage.cpp.

References myDeparted.

Referenced by LIBSUMO_NAMESPACE::Person::getStage().

Here is the caller graph for this function:

◆ getDestination()

◆ getDestinationStop()

◆ getDirection()

int MSStage::getDirection ( ) const
virtual

Return the movement directon on the edge.

Reimplemented in MSStageDriving, and MSStageMoving.

Definition at line 95 of file MSStage.cpp.

References MSPModel::UNDEFINED_DIRECTION.

◆ getDistance()

virtual double MSStage::getDistance ( ) const
pure virtual

get travel distance in this stage

Implemented in MSPerson::MSPersonStage_Access, MSStageDriving, MSStageTranship, MSStageTrip, MSStageWaiting, and MSStageWalking.

Referenced by LIBSUMO_NAMESPACE::Person::getStage().

Here is the caller graph for this function:

◆ getDouble()

double Parameterised::getDouble ( const std::string &  key,
const double  defaultValue 
) const
inherited

◆ getDoubles()

std::vector< double > Parameterised::getDoubles ( const std::string &  key,
std::vector< double >  defaultValue = std::vector<double>() 
) const
inherited

Returns the value for a given key converted to a list of doubles.

Parameters
[in]keyThe key to ask for
[in]defaultValueThe default value to return if no value is stored under the key
Returns
The value stored under the key

Definition at line 118 of file Parameterised.cpp.

References StringTokenizer::getVector(), Parameterised::myMap, TL, StringUtils::toDouble(), WRITE_WARNING, and WRITE_WARNINGF.

Referenced by EnergyParams::EnergyParams().

Here is the caller graph for this function:

◆ getDuration()

SUMOTime MSStage::getDuration ( ) const
virtual

Reimplemented in MSStageDriving, MSStageTrip, and MSStageWaiting.

Definition at line 139 of file MSStage.cpp.

References myArrived, myDeparted, and SUMOTime_MAX.

Referenced by MSStageWaiting::getDuration(), MSStageWalking::getTimeLoss(), getTravelTime(), and MSStageTranship::tripInfoOutput().

Here is the caller graph for this function:

◆ getEdge()

const MSEdge * MSStage::getEdge ( ) const
virtual

Returns the current edge.

Reimplemented in MSStageDriving, MSStageMoving, and MSStageTrip.

Definition at line 71 of file MSStage.cpp.

References myDestination.

Referenced by MSPModel_JuPedSim::add(), MSStageDriving::loadState(), GUIPerson::GUIPersonPopupMenu::onCmdRemoveObject(), MSStageWalking::proceed(), MSStageDriving::proceed(), MSStageWaiting::proceed(), MSTransportable::proceed(), and MSStageDriving::routeOutput().

Here is the caller graph for this function:

◆ getEdgeAngle()

double MSStage::getEdgeAngle ( const MSEdge e,
double  at 
) const

get angle of the edge at a certain position

Definition at line 183 of file MSStage.cpp.

References MSEdge::getLanes().

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

Here is the caller graph for this function:

◆ getEdgePos()

double MSStage::getEdgePos ( SUMOTime  now) const
virtual

Reimplemented in MSStageDriving, MSStageMoving, and MSStageTrip.

Definition at line 83 of file MSStage.cpp.

References myArrivalPos.

Referenced by MSPerson::checkAccess(), MSEdge::transportable_by_position_sorter::operator()(), MSStageWalking::proceed(), MSStageDriving::proceed(), and MSStageTranship::proceed().

Here is the caller graph for this function:

◆ getEdgePosition()

Position MSStage::getEdgePosition ( const MSEdge e,
double  at,
double  offset 
) const

get position on edge e at length at with orthogonal offset

Definition at line 172 of file MSStage.cpp.

References getLanePosition(), and MSEdge::getLanes().

Referenced by MSStageDriving::getPosition(), MSStageTrip::getPosition(), and MSStageWaiting::getPosition().

Here is the caller graph for this function:

◆ getEdgePosLat()

double MSStage::getEdgePosLat ( SUMOTime  now) const
virtual

Definition at line 89 of file MSStage.cpp.

References myArrivalPosLat.

Referenced by MSPerson::checkAccess(), and MSStageWalking::proceed().

Here is the caller graph for this function:

◆ getEdges()

ConstMSEdgeVector MSStage::getEdges ( ) const
virtual

the edges of the current stage

Reimplemented in MSStageDriving, and MSStageMoving.

Definition at line 113 of file MSStage.cpp.

References getDestination().

Referenced by MSStageWalking::clone(), LIBSUMO_NAMESPACE::Person::getEdges(), LIBSUMO_NAMESPACE::Person::getStage(), MSStageTrip::reroute(), LIBSUMO_NAMESPACE::Person::rerouteTraveltime(), and MSDetectorFileOutput::vehicleApplies().

Here is the caller graph for this function:

◆ getFromEdge()

const MSEdge * MSStage::getFromEdge ( ) const
virtual

Reimplemented in MSStageDriving, and MSStageMoving.

Definition at line 77 of file MSStage.cpp.

References myDestination.

Referenced by MSTransportable::rerouteParkingArea().

Here is the caller graph for this function:

◆ getGroup()

const std::string & MSStage::getGroup ( ) const
inline

return the id of the group of transportables traveling together

Definition at line 132 of file MSStage.h.

References myGroup.

◆ getLane()

virtual const MSLane * MSStage::getLane ( ) const
inlinevirtual

Returns the current lane (if applicable)

Reimplemented in MSStageDriving, and MSStageMoving.

Definition at line 122 of file MSStage.h.

◆ getLanePosition()

Position MSStage::getLanePosition ( const MSLane lane,
double  at,
double  offset 
) const

get position on lane at length at with orthogonal offset

Definition at line 177 of file MSStage.cpp.

References MSLane::getShape(), MSLane::interpolateLanePosToGeometryPos(), and PositionVector::positionAtOffset().

Referenced by MSPModel_NonInteracting::CState::computeDuration(), getEdgePosition(), MSPModel_NonInteracting::PState::getPosition(), and MSPModel_Striping::PState::getPosition().

Here is the caller graph for this function:

◆ getOriginStop()

virtual MSStoppingPlace * MSStage::getOriginStop ( ) const
inlinevirtual

returns the origin stop (if any). only needed for MSStageTrip

Reimplemented in MSStageDriving, and MSStageTrip.

Definition at line 90 of file MSStage.h.

Referenced by MSPerson::checkAccess(), GUIPerson::getGUIPosition(), MSTransportableControl::loadAnyWaiting(), MSStageDriving::loadState(), MSStageDriving::proceed(), and MSTransportable::proceed().

Here is the caller graph for this function:

◆ getParameter()

const std::string Parameterised::getParameter ( const std::string &  key,
const std::string  defaultValue = "" 
) const
virtualinherited

Returns the value for a given key.

Parameters
[in]keyThe key to ask for
[in]defaultValueThe default value to return if no value is stored under the key
Returns
The value stored under the key

Reimplemented in MSActuatedTrafficLightLogic, MSSimpleTrafficLightLogic, and NEMALogic.

Definition at line 90 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by MSPModel_JuPedSim::add(), NBRailwayTopologyAnalyzer::addBidiEdge(), NBEdge::addRestrictedLane(), FareModul::addStop(), GUIInductLoop::buildDetectorGUIRepresentation(), MSDevice_ElecHybrid::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), ROEdge::cacheParamRestrictions(), SUMOVTypeParameter::cacheParamRestrictions(), MSVehicleType::check(), MSRailSignal::constraintsAllow(), GUINet::createTLWrapper(), GNEEdge::drawEdgeName(), GNEConnection::drawEdgeValues(), GNEGenericData::drawFilteredAttribute(), GUIEdge::drawGL(), EnergyParams::EnergyParams(), MSDevice_SSM::filterByConflictType(), LIBSUMO_NAMESPACE::TrafficLight::findConstraintsDeadLocks(), LIBSUMO_NAMESPACE::Simulation::findIntermodalRoute(), GUIVehicle::getColorValue(), GNEEdgeData::getColorValue(), GNEEdgeRelData::getColorValue(), GNETAZRelData::getColorValue(), GNELane::getColorValue(), GUIEdge::getColorValue(), GUILane::getColorValue(), MSDevice_SSM::getDetectionRange(), MSDevice_SSM::getExtraTime(), LIBSUMO_NAMESPACE::TrafficLight::getFutureTripIds(), MSTLLogicControl::WAUTSwitchProcedure::getGSPTime(), RORoutable::getMaxSpeed(), MSDevice_SSM::getMDRAC_PRT(), MSDevice_SSM::getMeasuresAndThresholds(), MSSOTLRequestPolicy::getMinDecisionalPhaseDuration(), GUIBaseVehicle::getOptionalName(), GUITrafficLightLogicWrapper::getOptionalName(), MSDevice_SSM::getOutputFilename(), MSSimpleTrafficLightLogic::getParameter(), NEMALogic::getParameter(), LIBSUMO_NAMESPACE::Simulation::getParameter(), MSBaseVehicle::getPrefixedParameter(), GUIBaseVehicle::getScaleValue(), LIBSUMO_NAMESPACE::Vehicle::getStopParameter(), SUMOTrafficObject::getStringParam(), MSRailSignalConstraint::getVeh(), LIBSUMO_NAMESPACE::TrafficLight::getVehicleByTripId(), MSStoppingPlaceRerouter::getWeight(), MSRailSignal::hasInsertionConstraint(), MSRailSignalControl::haveDeadlock(), MSLink::ignoreFoe(), MSSOTLPhasePolicy::init(), MSStageDriving::init(), PushButtonLogic::init(), SigmoidLogic::init(), SUMOVTypeParameter::initRailVisualizationParameters(), NIImporter_OpenStreetMap::insertNodeChecking(), MSAbstractLaneChangeModel::laneChangeOutput(), NWWriter_OpenDrive::mapmatchRoadObjects(), Parameterised::mergeParameters(), MSSimpleTrafficLightLogic::MSSimpleTrafficLightLogic(), MSSOTLPolicy::MSSOTLPolicy(), MSSOTLPolicy5DFamilyStimulus::MSSOTLPolicy5DFamilyStimulus(), MSDevice_GLOSA::notifyEnter(), MSRailSignalConstraint_Predecessor::PassedTracker::notifyEnter(), GNEVType::overwriteVType(), NWWriter_OpenDrive::parseTrafficSign(), NBTrafficLightDefinition::railSignalUncontrolled(), MSDevice_Battery::readParameterValue(), MSDevice_SSM::requestsTrajectories(), MSDevice_Bluelight::resetVehicle(), GNEEdgeData::setColor(), GNEEdgeRelData::setColor(), NBTrafficLightLogicCont::setOpenDriveSignalParameters(), NBEdge::setOrigID(), MSVehicle::slowDownForSchedule(), NBEdgeCont::splitAt(), LIBSUMO_NAMESPACE::TrafficLight::swapParameters(), LIBSUMO_NAMESPACE::TrafficLight::updateConstraints(), MSDevice_SSM::useGeoCoords(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::WAUTSwitchProcedure_Stretch(), MSDevice_SSM::writeLanesPositions(), NWWriter_DlrNavteq::writeLinksUnsplitted(), MSDevice_SSM::writePositions(), NWWriter_OpenDrive::writeRoadObjectPOI(), NWWriter_OpenDrive::writeRoadObjectPoly(), NWWriter_OpenDrive::writeRoadObjects(), and NWWriter_OpenDrive::writeSignals().

◆ getParametersMap()

const Parameterised::Map & Parameterised::getParametersMap ( ) const
inherited

Returns the inner key/value map.

Definition at line 145 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by NIImporter_SUMO::_loadNetwork(), NBNode::addCrossing(), NBEdge::addLane(), NBEdge::append(), LIBSUMO_NAMESPACE::TrafficLight::buildConstraint(), GUIParameterTableWindow::closeBuilding(), NLHandler::closeEdge(), NBTrafficLightDefinition::compute(), GNEGenericData::drawAttribute(), GNEGenericData::drawFilteredAttribute(), NLDetectorBuilder::endE3Detector(), GNEAccess::getACParametersMap(), GNECalibrator::getACParametersMap(), GNEDetector::getACParametersMap(), GNEMultiEntryExitDetector::getACParametersMap(), GNEOverheadWire::getACParametersMap(), GNEParkingSpace::getACParametersMap(), GNERerouter::getACParametersMap(), GNERouteProbe::getACParametersMap(), GNEStoppingPlace::getACParametersMap(), GNETAZ::getACParametersMap(), GNEVaporizer::getACParametersMap(), GNEVariableSpeedSign::getACParametersMap(), GNEDataInterval::getACParametersMap(), GNEDataSet::getACParametersMap(), GNEGenericData::getACParametersMap(), GNEContainer::getACParametersMap(), GNEPerson::getACParametersMap(), GNEPersonTrip::getACParametersMap(), GNERide::getACParametersMap(), GNERoute::getACParametersMap(), GNEStop::getACParametersMap(), GNEStopPlan::getACParametersMap(), GNETranship::getACParametersMap(), GNETransport::getACParametersMap(), GNEVehicle::getACParametersMap(), GNEVType::getACParametersMap(), GNEWalk::getACParametersMap(), GNEConnection::getACParametersMap(), GNECrossing::getACParametersMap(), GNEEdge::getACParametersMap(), GNEEdgeType::getACParametersMap(), GNEJunction::getACParametersMap(), GNELane::getACParametersMap(), GNELaneType::getACParametersMap(), GNEPOI::getACParametersMap(), GNEPoly::getACParametersMap(), MSRailSignalConstraint_Predecessor::getDescription(), NWWriter_OpenDrive::getDividerType(), GUILane::getParameterWindow(), GNESingleParametersDialog::GNESingleParametersDialog(), MSRailCrossing::init(), MSActuatedTrafficLightLogic::init(), MSDevice_Taxi::initDispatch(), MSPModel_JuPedSim::initialize(), MSBaseVehicle::initTransientModelParams(), NIImporter_OpenStreetMap::insertEdge(), NIImporter_OpenStreetMap::insertNodeChecking(), GNEEdgeData::isGenericDataVisible(), GNEEdgeRelData::isGenericDataVisible(), GNETAZRelData::isGenericDataVisible(), GNEGenericData::isVisibleInspectDeleteSelect(), NBEdge::NBEdge(), NBLoadedSUMOTLDef::NBLoadedSUMOTLDef(), NBTrafficLightLogic::NBTrafficLightLogic(), GUIParameterTableWindow::numParams(), GNESingleParametersDialog::onCmdReset(), GNEVType::overwriteVType(), TraCIServerAPI_TrafficLight::processGet(), Parameterised::setParameters(), LIBSUMO_NAMESPACE::TrafficLight::swapConstraints(), GNEEdgeData::writeGenericData(), GNEEdgeRelData::writeGenericData(), and GNETAZRelData::writeGenericData().

◆ getParametersStr()

std::string Parameterised::getParametersStr ( const std::string  kvsep = "=",
const std::string  sep = "|" 
) const
inherited

◆ getPosition()

virtual Position MSStage::getPosition ( SUMOTime  now) const
pure virtual

returns the position of the transportable

Implemented in MSPerson::MSPersonStage_Access, MSStageDriving, MSStageMoving, MSStageTrip, and MSStageWaiting.

◆ getRoutePosition()

virtual int MSStage::getRoutePosition ( ) const
inlinevirtual

return index of current edge within route

Reimplemented in MSStageWalking.

Definition at line 196 of file MSStage.h.

Referenced by MSPModel_Striping::getNextLane().

Here is the caller graph for this function:

◆ getSpeed()

double MSStage::getSpeed ( ) const
virtual

the speed of the transportable

Reimplemented in MSPerson::MSPersonStage_Access, MSStageDriving, and MSStageMoving.

Definition at line 107 of file MSStage.cpp.

◆ getStageDescription()

virtual std::string MSStage::getStageDescription ( const bool  isPerson) const
pure virtual

return (brief) string representation of the current stage

Implemented in MSPerson::MSPersonStage_Access, MSStageDriving, MSStageTranship, MSStageTrip, MSStageWaiting, and MSStageWalking.

Referenced by LIBSUMO_NAMESPACE::Person::getStage().

Here is the caller graph for this function:

◆ getStageSummary()

virtual std::string MSStage::getStageSummary ( const bool  isPerson) const
pure virtual

return string summary of the current stage

Implemented in MSPerson::MSPersonStage_Access, MSStageDriving, MSStageTranship, MSStageTrip, MSStageWaiting, and MSStageWalking.

◆ getStageType()

MSStageType MSStage::getStageType ( ) const
inline

Definition at line 127 of file MSStage.h.

References myType.

Referenced by MSRouteHandler::addFlowTransportable(), MSPerson::checkAccess(), LIBSUMO_NAMESPACE::Person::getStage(), MSStageDriving::loadState(), MSStageWalking::proceed(), MSStageDriving::proceed(), MSTransportable::proceed(), MSTransportable::rerouteParkingArea(), MSStageDriving::routeOutput(), and MSStageTrip::routeOutput().

Here is the caller graph for this function:

◆ getTimeLoss()

SUMOTime MSStage::getTimeLoss ( const MSTransportable transportable) const
virtual

Reimplemented in MSStageDriving, and MSStageWalking.

Definition at line 155 of file MSStage.cpp.

◆ getTravelTime()

SUMOTime MSStage::getTravelTime ( ) const
virtual

Reimplemented in MSStageDriving, MSStageTrip, and MSStageWaiting.

Definition at line 145 of file MSStage.cpp.

References getDuration().

◆ getTrip()

MSStageTrip * MSStage::getTrip ( ) const
inline

Definition at line 268 of file MSStage.h.

References myTrip.

Referenced by MSPerson::checkAccess(), and MSTransportable::reroute().

Here is the caller graph for this function:

◆ getVehicle()

virtual SUMOVehicle * MSStage::getVehicle ( ) const
inlinevirtual

Current vehicle in which the transportable is driving (or nullptr)

Reimplemented in MSStageDriving.

Definition at line 182 of file MSStage.h.

Referenced by GUIPerson::getGUIPosition(), and GUIPerson::getVehicleID().

Here is the caller graph for this function:

◆ getWaitingTime() [1/2]

SUMOTime MSStage::getWaitingTime ( ) const
virtual

Reimplemented in MSStageDriving.

Definition at line 150 of file MSStage.cpp.

◆ getWaitingTime() [2/2]

SUMOTime MSStage::getWaitingTime ( SUMOTime  now) const
virtual

the time this transportable spent waiting

Reimplemented in MSStageDriving, and MSStageMoving.

Definition at line 101 of file MSStage.cpp.

◆ hasParameter()

bool Parameterised::hasParameter ( const std::string &  key) const
inherited

Returns whether the parameter is set.

Parameters
[in]keyThe key to ask for
Returns
Whether the key is known

Definition at line 84 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by MSStageWalking::activateEntryReminders(), NBEdge::append(), MSVehicleType::build(), GUIInductLoop::buildDetectorGUIRepresentation(), MSDevice_ElecHybrid::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), GUINet::createTLWrapper(), EnergyParams::EnergyParams(), MSDevice_SSM::filterByConflictType(), NWWriter_DlrNavteq::getBrunnelType(), GNEEdgeData::getColorValue(), GNEEdgeRelData::getColorValue(), GNETAZRelData::getColorValue(), GNELane::getColorValue(), GUILane::getColorValue(), MSDevice_SSM::getDetectionRange(), MSDevice_SSM::getExtraTime(), MSDevice_SSM::getMDRAC_PRT(), MSDevice_SSM::getMeasuresAndThresholds(), MSDevice_SSM::getOutputFilename(), LIBSUMO_NAMESPACE::Simulation::getParameter(), MSStoppingPlaceRerouter::getWeight(), MSStageDriving::init(), SUMOVTypeParameter::initRailVisualizationParameters(), MSEdge::insertVehicle(), NWWriter_OpenDrive::mapmatchRoadObjects(), Parameterised::mergeParameters(), MSActuatedTrafficLightLogic::MSActuatedTrafficLightLogic(), MSSimpleTrafficLightLogic::MSSimpleTrafficLightLogic(), GNEVType::overwriteVType(), NWWriter_OpenDrive::parseTrafficSign(), NBTrafficLightDefinition::railSignalUncontrolled(), MSDevice_Battery::readParameterValue(), MSDevice_SSM::requestsTrajectories(), NBTrafficLightLogicCont::setOpenDriveSignalParameters(), MSVehicle::slowDownForSchedule(), MSDevice_SSM::useGeoCoords(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::WAUTSwitchProcedure_Stretch(), MSDevice_SSM::writeLanesPositions(), MSDevice_SSM::writePositions(), NWWriter_OpenDrive::writeRoadObjectPoly(), NWWriter_OpenDrive::writeRoadObjects(), and NWWriter_OpenDrive::writeSignals().

Here is the caller graph for this function:

◆ init()

virtual void MSStage::init ( MSTransportable )
inlinevirtual

initialization, e.g. for param-related events

Reimplemented in MSStageDriving.

Definition at line 79 of file MSStage.h.

◆ isParameterValid()

bool Parameterised::isParameterValid ( const std::string &  value,
const std::string &  kvsep,
const std::string &  sep 
)
staticprivateinherited

check if given string can be parsed to a parameter of type "key=value"

Definition at line 254 of file Parameterised.cpp.

References StringTokenizer::getVector(), and SUMOXMLDefinitions::isValidParameterKey().

Referenced by Parameterised::areAttributesValid(), and Parameterised::areParametersValid().

Here is the caller graph for this function:

◆ isWaiting4Vehicle()

virtual bool MSStage::isWaiting4Vehicle ( ) const
inlinevirtual

Whether the transportable waits for a vehicle.

Reimplemented in MSStageDriving.

Definition at line 172 of file MSStage.h.

◆ isWaitingFor()

bool MSStage::isWaitingFor ( const SUMOVehicle vehicle) const
virtual

Whether the transportable waits for the given vehicle.

Reimplemented in MSStageDriving.

Definition at line 167 of file MSStage.cpp.

◆ isWalk()

virtual bool MSStage::isWalk ( ) const
inlinevirtual

Whether the transportable is walking.

Reimplemented in MSStageTrip, and MSStageWalking.

Definition at line 177 of file MSStage.h.

◆ loadState()

virtual void MSStage::loadState ( MSTransportable transportable,
std::istringstream &  state 
)
inlinevirtual

Reconstructs the current state, standard implementation does nothing.

Reimplemented in MSStageDriving, MSStageWaiting, and MSStageWalking.

Definition at line 239 of file MSStage.h.

References UNUSED_PARAMETER.

◆ markSet()

void MSStage::markSet ( int  what)
inline

Definition at line 248 of file MSStage.h.

References myParametersSet.

◆ mergeParameters()

void Parameterised::mergeParameters ( const Parameterised::Map mapArg,
const std::string  separator = " ",
bool  uniqueValues = true 
)
inherited

Adds or appends all given parameters from the map.

Parameters
[in]mapArgThe keys/values to insert

Definition at line 65 of file Parameterised.cpp.

References Parameterised::getParameter(), Parameterised::hasParameter(), and Parameterised::setParameter().

Referenced by NBEdge::append().

Here is the caller graph for this function:

◆ operator=()

MSStage & MSStage::operator= ( const MSStage )
privatedelete

Invalidated assignment operator.

◆ proceed()

virtual void MSStage::proceed ( MSNet net,
MSTransportable transportable,
SUMOTime  now,
MSStage previous 
)
pure virtual

◆ routeOutput()

virtual void MSStage::routeOutput ( const bool  isPerson,
OutputDevice os,
const bool  withRouteLength,
const MSStage *const  previous 
) const
pure virtual

Called on writing vehroute output.

Parameters
[in]isPersonWhether we are writing person or container info
[in]osThe stream to write the information into
[in]withRouteLengthwhether route length shall be written
[in]previousThe previous stage for additional info such as from edge
Exceptions
IOErrornot yet implemented

Implemented in MSStageDriving, MSStageTranship, MSStageTrip, MSStageWaiting, MSStageWalking, and MSPerson::MSPersonStage_Access.

Referenced by MSTransportable::routeOutput(), and MSTransportable::saveState().

Here is the caller graph for this function:

◆ saveState()

virtual void MSStage::saveState ( std::ostringstream &  out)
inlinevirtual

Saves the current state into the given stream, standard implementation does nothing.

Reimplemented in MSStageDriving, MSStageWaiting, and MSStageWalking.

Definition at line 233 of file MSStage.h.

References UNUSED_PARAMETER.

◆ setArrivalPos()

void MSStage::setArrivalPos ( double  arrivalPos)
inline

Definition at line 102 of file MSStage.h.

References myArrivalPos.

Referenced by MSStageTrip::reroute(), and MSTransportable::rerouteParkingArea().

Here is the caller graph for this function:

◆ setArrived()

const std::string MSStage::setArrived ( MSNet net,
MSTransportable transportable,
SUMOTime  now,
const bool  vehicleArrived 
)
virtual

logs end of the step

Reimplemented in MSStageDriving, and MSStageTrip.

Definition at line 161 of file MSStage.cpp.

References myArrived.

Referenced by MSTransportable::proceed(), MSStageDriving::setArrived(), and MSStageTrip::setArrived().

Here is the caller graph for this function:

◆ setCosts()

void MSStage::setCosts ( double  costs)
inline

Sets the costs of the stage.

Parameters
[in]costsThe new stage costs

Definition at line 264 of file MSStage.h.

References myCosts.

Referenced by MSStageTrip::reroute().

Here is the caller graph for this function:

◆ setDeparted()

void MSStage::setDeparted ( SUMOTime  now)

logs end of the step

Definition at line 121 of file MSStage.cpp.

References myDeparted.

◆ setDestination()

void MSStage::setDestination ( const MSEdge newDestination,
MSStoppingPlace newDestStop 
)

Definition at line 189 of file MSStage.cpp.

References MSStoppingPlace::getBeginLanePosition(), MSStoppingPlace::getEndLanePosition(), myArrivalPos, myDestination, and myDestinationStop.

Referenced by MSTransportable::rerouteParkingArea().

Here is the caller graph for this function:

◆ setParameter()

void Parameterised::setParameter ( const std::string &  key,
const std::string &  value 
)
virtualinherited

Sets a parameter.

Parameters
[in]keyThe parameter's name
[in]valueThe parameter's value

Reimplemented in MSRailCrossing, MSActuatedTrafficLightLogic, MSRailSignal, MSSimpleTrafficLightLogic, and NEMALogic.

Definition at line 45 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by NBRailwayTopologyAnalyzer::addBidiEdge(), NLHandler::addDistrict(), RONetHandler::addParam(), ShapeHandler::addPOI(), NBOwnTLDef::buildNemaPhases(), MSParkingArea::enter(), NIImporter_MATSim::EdgesHandler::insertEdge(), NIImporter_OpenStreetMap::insertEdge(), NIImporter_OpenStreetMap::insertNodeChecking(), MSLane::isInsertionSuccess(), NBNodeCont::joinNodeCluster(), NBEdge::Lane::Lane(), NWWriter_OpenDrive::mapmatchRoadObjects(), Parameterised::mergeParameters(), MSStateHandler::myStartElement(), NIXMLConnectionsHandler::myStartElement(), NIXMLNodesHandler::myStartElement(), NIXMLTrafficLightsHandler::myStartElement(), ShapeHandler::myStartElement(), MSDevice_Bluelight::notifyMove(), GNESingleParametersDialog::onCmdAccept(), NBRailwayTopologyAnalyzer::reverseEdges(), GNEVType::setAttribute(), NBEdge::setJunctionPriority(), NIImporter_OpenDrive::setLaneAttributes(), MSRailCrossing::setParameter(), MSActuatedTrafficLightLogic::setParameter(), MSRailSignal::setParameter(), MSSimpleTrafficLightLogic::setParameter(), NEMALogic::setParameter(), LIBSUMO_NAMESPACE::Simulation::setParameter(), Parameterised::setParametersStr(), LIBSUMO_NAMESPACE::Vehicle::setStopParameter(), LIBSUMO_NAMESPACE::TrafficLight::swapParameters(), Parameterised::updateParameters(), NWWriter_OpenDrive::writeNetwork(), and NIImporter_OpenDrive::writeRoadObjects().

Here is the caller graph for this function:

◆ setParameters()

void Parameterised::setParameters ( const Parameterised params)
inherited

set the inner key/value map in map<string, string> format

Definition at line 167 of file Parameterised.cpp.

References Parameterised::getParametersMap(), and Parameterised::myMap.

Referenced by MSStageDriving::clone(), MSStageTranship::clone(), MSStageTrip::clone(), MSStageWaiting::clone(), MSStageWalking::clone(), and MSStageTrip::reroute().

Here is the caller graph for this function:

◆ setParametersStr()

void Parameterised::setParametersStr ( const std::string &  paramsString,
const std::string  kvsep = "=",
const std::string  sep = "|" 
)
inherited

set the inner key/value map in string format "key1=value1|key2=value2|...|keyN=valueN"

Parameters
[in]paramsStringA serialized key-value map
[in]kvsepThe separater between key and value
[in]sepThe separater between map entries

Definition at line 173 of file Parameterised.cpp.

References StringTokenizer::getVector(), Parameterised::myMap, and Parameterised::setParameter().

Referenced by MSDevice_Taxi::initDispatch(), GNEAccess::setAttribute(), GNEBusStop::setAttribute(), GNECalibrator::setAttribute(), GNECalibratorFlow::setAttribute(), GNEChargingStation::setAttribute(), GNEContainerStop::setAttribute(), GNEMultiEntryExitDetector::setAttribute(), GNEOverheadWire::setAttribute(), GNEParkingArea::setAttribute(), GNEParkingSpace::setAttribute(), GNERerouter::setAttribute(), GNERouteProbe::setAttribute(), GNETAZ::setAttribute(), GNETAZSourceSink::setAttribute(), GNETractionSubstation::setAttribute(), GNEVaporizer::setAttribute(), GNEVariableSpeedSign::setAttribute(), GNEEdgeData::setAttribute(), GNEEdgeRelData::setAttribute(), GNETAZRelData::setAttribute(), GNEContainer::setAttribute(), GNEPerson::setAttribute(), GNERoute::setAttribute(), GNEStop::setAttribute(), GNEVehicle::setAttribute(), GNEVType::setAttribute(), GNEConnection::setAttribute(), GNEEdge::setAttribute(), GNEEdgeType::setAttribute(), GNEJunction::setAttribute(), GNELane::setAttribute(), GNELaneType::setAttribute(), GNEPOI::setAttribute(), GNEPoly::setAttribute(), and GNEDetector::setDetectorAttribute().

Here is the caller graph for this function:

◆ setSpeed()

virtual void MSStage::setSpeed ( double  )
inlinevirtual

sets the walking speed (ignored in other stages)

Reimplemented in MSStageWalking.

Definition at line 149 of file MSStage.h.

◆ setTrip()

void MSStage::setTrip ( MSStageTrip trip)
inline

Definition at line 272 of file MSStage.h.

References myTrip.

Referenced by MSPerson::checkAccess(), and MSStageTrip::reroute().

Here is the caller graph for this function:

◆ tripInfoOutput()

virtual void MSStage::tripInfoOutput ( OutputDevice os,
const MSTransportable *const  transportable 
) 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_Access, MSStageDriving, MSStageTranship, MSStageTrip, MSStageWaiting, and MSStageWalking.

◆ unsetParameter()

void Parameterised::unsetParameter ( const std::string &  key)
inherited

Removes a parameter.

Parameters
[in]keyThe parameter's name

Definition at line 51 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by NIImporter_OpenStreetMap::insertEdge(), MSLane::isInsertionSuccess(), GNEVType::setAttribute(), and LIBSUMO_NAMESPACE::TrafficLight::swapParameters().

Here is the caller graph for this function:

◆ updateParameters()

void Parameterised::updateParameters ( const Parameterised::Map mapArg)
inherited

◆ wasSet()

bool MSStage::wasSet ( int  what) const
inline

Definition at line 244 of file MSStage.h.

References myParametersSet.

Referenced by MSStageTrip::reroute(), MSStageTrip::routeOutput(), and MSStageWalking::routeOutput().

Here is the caller graph for this function:

◆ writeParams()

void Parameterised::writeParams ( OutputDevice device) const
inherited

write Params in the given outputdevice

Definition at line 188 of file Parameterised.cpp.

References OutputDevice::closeTag(), StringUtils::escapeXML(), Parameterised::myMap, OutputDevice::openTag(), SUMO_ATTR_KEY, SUMO_ATTR_VALUE, SUMO_TAG_PARAM, and OutputDevice::writeAttr().

Referenced by MSStageWaiting::routeOutput(), MSTransportable::routeOutput(), ROPerson::saveAsXML(), ROVehicle::saveAsXML(), MEVehicle::saveState(), MSVehicle::saveState(), MSStop::write(), SUMOVTypeParameter::write(), SUMOVehicleParameter::Stop::write(), NBPTStop::write(), MSRailSignalConstraint_Predecessor::write(), GNEBusStop::writeAdditional(), GNECalibrator::writeAdditional(), GNECalibratorFlow::writeAdditional(), GNEChargingStation::writeAdditional(), GNEContainerStop::writeAdditional(), GNEEntryExitDetector::writeAdditional(), GNEInductionLoopDetector::writeAdditional(), GNEInstantInductionLoopDetector::writeAdditional(), GNELaneAreaDetector::writeAdditional(), GNEMultiEntryExitDetector::writeAdditional(), GNEOverheadWire::writeAdditional(), GNEParkingArea::writeAdditional(), GNEParkingSpace::writeAdditional(), GNERerouter::writeAdditional(), GNERouteProbe::writeAdditional(), GNETAZ::writeAdditional(), GNETractionSubstation::writeAdditional(), GNEVaporizer::writeAdditional(), GNEVariableSpeedSign::writeAdditional(), NWWriter_SUMO::writeConnection(), GNEContainer::writeDemandElement(), GNEPerson::writeDemandElement(), GNERoute::writeDemandElement(), GNEVehicle::writeDemandElement(), NWWriter_SUMO::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), NWWriter_SUMO::writeJunction(), NWWriter_SUMO::writeLane(), NWWriter_XML::writeNodes(), MSDevice_Vehroutes::writeOutput(), NWWriter_SUMO::writeTrafficLight(), SUMOPolygon::writeXML(), and PointOfInterest::writeXML().

Here is the caller graph for this function:

Field Documentation

◆ myArrivalPos

◆ myArrivalPosLat

double MSStage::myArrivalPosLat
protected

the lateral position at which we want to arrive

Definition at line 296 of file MSStage.h.

Referenced by MSStageDriving::clone(), equals(), getArrivalPosLat(), getEdgePosLat(), and MSStageDriving::setArrived().

◆ myArrived

◆ myCosts

double MSStage::myCosts
protected

The assigned or calculated costs.

Definition at line 311 of file MSStage.h.

Referenced by getCosts(), and setCosts().

◆ myDeparted

◆ myDestination

◆ myDestinationStop

◆ myGroup

const std::string MSStage::myGroup
protected

◆ myMap

◆ myParametersSet

int MSStage::myParametersSet
protected

Information on which parameter were set (mainly for vehroute output)

Definition at line 314 of file MSStage.h.

Referenced by markSet(), and wasSet().

◆ myTrip

MSStageTrip* MSStage::myTrip = nullptr
protected

Definition at line 316 of file MSStage.h.

Referenced by getTrip(), and setTrip().

◆ myType

◆ ROADSIDE_OFFSET

const double MSStage::ROADSIDE_OFFSET
staticprotected

the offset for computing positions when standing at an edge

Definition at line 319 of file MSStage.h.

Referenced by MSStageDriving::getPosition(), MSStageTrip::getPosition(), and MSStageWaiting::getPosition().


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