SUMO - Simulation of Urban MObility
MSDevice_ToC Class Reference

The ToC Device controls transition of control between automated and manual driving. More...

#include <MSDevice_ToC.h>

Inheritance diagram for MSDevice_ToC:
Inheritance graph
Collaboration diagram for MSDevice_ToC:
Collaboration graph

Public Types

enum  Notification {
  NOTIFICATION_DEPARTED, NOTIFICATION_JUNCTION, NOTIFICATION_SEGMENT, NOTIFICATION_LANE_CHANGE,
  NOTIFICATION_TELEPORT, NOTIFICATION_PARKING, NOTIFICATION_ARRIVED, NOTIFICATION_VAPORIZED,
  NOTIFICATION_TELEPORT_ARRIVED, NOTIFICATION_PARKING_REROUTE
}
 Definition of a vehicle state. More...
 

Public Member Functions

void addTo (const StoringVisitor &cont) const
 Adds this object to the given container. More...
 
SUMOTime awarenessRecoveryStep (SUMOTime t)
 Continue the awareness recovery for one time step. More...
 
const std::string deviceName () const
 return the name for this type of device More...
 
SUMOTime ensureDriverStateExistence (SUMOTime)
 Ensure existence of DriverState for equipped vehicles. More...
 
virtual void generateOutput () const
 Called on writing tripinfo output. More...
 
const std::string & getDescription () const
 
SUMOVehicle & getHolder () const
 Returns the vehicle that holds this device. More...
 
const std::string & getID () const
 Returns the id. More...
 
const MSLane * getLane () const
 Returns the lane the reminder works on. More...
 
std::string getParameter (const std::string &key) const
 try to retrieve the given parameter from this device. Throw exception for unsupported key More...
 
virtual void loadState (const SUMOSAXAttributes &attrs)
 Loads the state of the device from the given description. More...
 
SUMOTime MRMExecutionStep (SUMOTime t)
 Continue the MRM for one time step. More...
 
virtual void notifyMoveInternal (const SUMOVehicle &veh, const double frontOnLane, const double timeOnLane, const double meanSpeedFrontOnLane, const double meanSpeedVehicleOnLane, const double travelledDistanceFrontOnLane, const double travelledDistanceVehicleOnLane, const double meanLengthOnLane)
 Internal notification about the vehicle moves. More...
 
virtual void saveState (OutputDevice &out) const
 Saves the state of the device. More...
 
void setDescription (const std::string &description)
 
void setID (const std::string &newID)
 resets the id More...
 
void setParameter (const std::string &key, const std::string &value)
 try to set the given parameter for this device. Throw exception for unsupported key More...
 
SUMOTime ToCPreparationStep (SUMOTime t)
 Continue the ToC preparation for one time step. More...
 
SUMOTime triggerDownwardToC (SUMOTime t)
 Trigger execution of a ToC X–>MANUAL ("downwards") More...
 
SUMOTime triggerMRM (SUMOTime t)
 Trigger execution of an MRM. More...
 
SUMOTime triggerUpwardToC (SUMOTime t)
 Trigger execution of a ToC X–>AUTOMATED ("upwards") More...
 
 ~MSDevice_ToC ()
 Destructor. More...
 
Interface methods, to be derived by subclasses
virtual bool notifyEnter (SUMOVehicle &veh, Notification reason, const MSLane *enteredLane)
 Checks whether the reminder is activated by a vehicle entering the lane. More...
 
virtual bool notifyMove (SUMOVehicle &veh, double oldPos, double newPos, double newSpeed)
 Checks whether the reminder still has to be notified about the vehicle moves. More...
 
virtual bool notifyLeave (SUMOVehicle &veh, double lastPos, Notification reason, const MSLane *enteredLane=0)
 Called if the vehicle leaves the reminder's lane. More...
 
void updateDetector (SUMOVehicle &veh, double entryPos, double leavePos, SUMOTime entryTime, SUMOTime currentTime, SUMOTime leaveTime, bool cleanUp)
 

Static Public Member Functions

static void buildVehicleDevices (SUMOVehicle &v, std::vector< MSDevice *> &into)
 Build devices for the given vehicle, if needed. More...
 
static bool checkOptions (OptionsCont &oc)
 check device-specific options More...
 
static void cleanupAll ()
 perform cleanup for all devices More...
 
static bool equippedByParameter (const MSTransportable *t, const std::string &deviceName, bool outputOptionSet)
 Determines whether a transportable should get a certain device. More...
 
static std::mt19937 * getEquipmentRNG ()
 
template<class T >
static std::string getIDSecure (const T *obj, const std::string &fallBack="NULL")
 get an identifier for Named-like object which may be Null More...
 
static void insertOptions (OptionsCont &oc)
 Inserts MSDevice_ToC-options. More...
 

Protected Member Functions

void removeFromVehicleUpdateValues (SUMOVehicle &veh)
 

Static Protected Member Functions

Helper methods for device assignment
static void insertDefaultAssignmentOptions (const std::string &deviceName, const std::string &optionsTopic, OptionsCont &oc)
 Adds common command options that allow to assign devices to vehicles. More...
 
static bool equippedByDefaultAssignmentOptions (const OptionsCont &oc, const std::string &deviceName, SUMOVehicle &v, bool outputOptionSet)
 Determines whether a vehicle should get a certain device. More...
 
Helper methods for parsing parameters
static std::string getStringParam (const SUMOVehicle &v, const OptionsCont &oc, std::string paramName, std::string deflt, bool required)
 
static double getFloatParam (const SUMOVehicle &v, const OptionsCont &oc, std::string paramName, double deflt, bool required)
 
static bool getBoolParam (const SUMOVehicle &v, const OptionsCont &oc, std::string paramName, bool deflt, bool required)
 

Protected Attributes

std::string myDescription
 a description of this moveReminder More...
 
SUMOVehicle & myHolder
 The vehicle that stores the device. More...
 
std::string myID
 The name of the object. More...
 
MSLane *const myLane
 Lane on which the reminder works. More...
 

Private Types

enum  ToCState {
  UNDEFINED = 0, MANUAL = 1, AUTOMATED = 2, PREPARING_TOC = 3,
  MRM = 4, RECOVERING = 5
}
 Enum describing the different regimes for the device,. More...
 

Private Member Functions

void descheduleMRM ()
 Break MRM Process or remove MRM-Trigger command from the event-queue. More...
 
void descheduleRecovery ()
 Remove ongoing awareness recovery process from the event-queue. More...
 
void descheduleToC ()
 Remove scheduled ToC-Trigger command from the event-queue. More...
 
void descheduleToCPreparation ()
 Remove ongoing ToC-Preparation process from the event-queue. More...
 
void initColorScheme ()
 Initialize vehicle colors for different states. More...
 
 MSDevice_ToC (SUMOVehicle &holder, const std::string &id, std::string manualType, std::string automatedType, SUMOTime responseTime, double recoveryRate, double initialAwareness, double mrmDecel, bool useColorScheme)
 Constructor. More...
 
 MSDevice_ToC (const MSDevice_ToC &)
 Invalidated copy constructor. More...
 
MSDevice_ToC & operator= (const MSDevice_ToC &)
 Invalidated assignment operator. More...
 
void requestMRM ()
 Request an MRM to be initiated immediately. No downward ToC will be scheduled. More...
 
void requestToC (SUMOTime timeTillMRM)
 Request a ToC. If the device is in AUTOMATED or MRM state, a driver response time is sampled and the ToC is scheduled. If the response is larger than timeTillMRM, an MRM is scheduled as well. If the device is in MANUAL or UNDEFINED state, it switches to AUTOMATED. The request is ignored if the state is already PREPARING_TOC. More...
 
void setAwareness (double value)
 Set the awareness to the given value. More...
 
void setState (ToCState state)
 Set the ToC device's state. More...
 
void setVehicleColor ()
 
void switchHolderType (const std::string &targetTypeID)
 Switch the device holder's vehicle type. More...
 

Static Private Member Functions

Helpers for parameter parsing
static std::string getManualType (const SUMOVehicle &v, const OptionsCont &oc)
 
static std::string getAutomatedType (const SUMOVehicle &v, const OptionsCont &oc)
 
static double getResponseTime (const SUMOVehicle &v, const OptionsCont &oc)
 
static double getRecoveryRate (const SUMOVehicle &v, const OptionsCont &oc)
 
static double getInitialAwareness (const SUMOVehicle &v, const OptionsCont &oc)
 
static double getMRMDecel (const SUMOVehicle &v, const OptionsCont &oc)
 
static bool useColorScheme (const SUMOVehicle &v, const OptionsCont &oc)
 
static ToCState _2ToCState (const std::string &)
 
static std::string _2string (ToCState state)
 

Private Attributes

MSVehicle * myHolderMS
 The holder vehicle casted to MSVehicle*. More...
 
private state members of the ToC device
std::string myManualTypeID
 vehicle type ID for manual driving More...
 
std::string myAutomatedTypeID
 vehicle type ID for automated driving More...
 
SUMOTime myResponseTime
 
double myRecoveryRate
 
double myInitialAwareness
 
double myMRMDecel
 Deceleration rate applied during MRM. More...
 
double myCurrentAwareness
 
std::map< ToCState, RGBColor > myColorScheme
 Coloring scheme,. More...
 
bool myUseColorScheme
 Whether a coloring scheme shall by applied to indicate the different toc stages,. More...
 
ToCState myState
 Current state of the device. More...
 
Commands sent to the EventControl (used for cleanup)
Note
Must be removed in destructor.
WrappingCommand< MSDevice_ToC > * myTriggerMRMCommand
 
WrappingCommand< MSDevice_ToC > * myTriggerToCCommand
 
WrappingCommand< MSDevice_ToC > * myRecoverAwarenessCommand
 
WrappingCommand< MSDevice_ToC > * myExecuteMRMCommand
 
WrappingCommand< MSDevice_ToC > * myPrepareToCCommand
 

Detailed Description

The ToC Device controls transition of control between automated and manual driving.

Todo:

: Provide logging facilities

: allow manual and automated type to refer to vTypeDistributions

See also
MSDevice

Definition at line 55 of file MSDevice_ToC.h.

Member Enumeration Documentation

◆ Notification

Definition of a vehicle state.

Enumerator
NOTIFICATION_DEPARTED 

The vehicle has departed (was inserted into the network)

NOTIFICATION_JUNCTION 

The vehicle arrived at a junction.

NOTIFICATION_SEGMENT 

The vehicle changes the segment (meso only)

NOTIFICATION_LANE_CHANGE 

The vehicle changes lanes (micro only)

NOTIFICATION_TELEPORT 

The vehicle is being teleported.

NOTIFICATION_PARKING 

The vehicle starts or ends parking.

NOTIFICATION_ARRIVED 

The vehicle arrived at its destination (is deleted)

NOTIFICATION_VAPORIZED 

The vehicle got vaporized.

NOTIFICATION_TELEPORT_ARRIVED 

The vehicle was teleported out of the net.

NOTIFICATION_PARKING_REROUTE 

The vehicle needs another parking area.

Definition at line 89 of file MSMoveReminder.h.

◆ ToCState

enum MSDevice_ToC::ToCState
private

Enum describing the different regimes for the device,.

See also
myState Possible transitions: AUTOMATED -> PREPARING_TOC PREPARING_TOC -> PERFORMING_MRM PREPARING_TOC -> MANUAL PERFORMING_MRM -> MANUAL MANUAL -> AUTOMATED
Enumerator
UNDEFINED 
MANUAL 
AUTOMATED 
PREPARING_TOC 
MRM 
RECOVERING 

Definition at line 84 of file MSDevice_ToC.h.

Constructor & Destructor Documentation

◆ ~MSDevice_ToC()

◆ MSDevice_ToC() [1/2]

MSDevice_ToC::MSDevice_ToC ( SUMOVehicle &  holder,
const std::string &  id,
std::string  manualType,
std::string  automatedType,
SUMOTime  responseTime,
double  recoveryRate,
double  initialAwareness,
double  mrmDecel,
bool  useColorScheme 
)
private

◆ MSDevice_ToC() [2/2]

MSDevice_ToC::MSDevice_ToC ( const MSDevice_ToC &  )
private

Invalidated copy constructor.

Member Function Documentation

◆ _2string()

std::string MSDevice_ToC::_2string ( ToCState  state)
staticprivate

Definition at line 655 of file MSDevice_ToC.cpp.

References AUTOMATED, MANUAL, MRM, PREPARING_TOC, RECOVERING, toString(), UNDEFINED, and WRITE_WARNING.

Referenced by getParameter(), and MSDevice_ToC().

◆ _2ToCState()

MSDevice_ToC::ToCState MSDevice_ToC::_2ToCState ( const std::string &  str)
staticprivate

Definition at line 634 of file MSDevice_ToC.cpp.

References AUTOMATED, MANUAL, MRM, PREPARING_TOC, RECOVERING, UNDEFINED, and WRITE_WARNING.

◆ addTo()

void Named::addTo ( const StoringVisitor &  cont) const
inlineinherited

Adds this object to the given container.

Parameters

Definition at line 114 of file Named.h.

References Named::StoringVisitor::add().

◆ awarenessRecoveryStep()

SUMOTime MSDevice_ToC::awarenessRecoveryStep ( SUMOTime  t)

◆ buildVehicleDevices()

void MSDevice_ToC::buildVehicleDevices ( SUMOVehicle &  v,
std::vector< MSDevice *> &  into 
)
static

Build devices for the given vehicle, if needed.

The options are read and evaluated whether a ToC-device shall be built for the given vehicle.

The built device is stored in the given vector.

Parameters
[in]vThe vehicle for which a device may be built

Definition at line 93 of file MSDevice_ToC.cpp.

References MSDevice::equippedByDefaultAssignmentOptions(), getAutomatedType(), SUMOVehicle::getID(), getInitialAwareness(), getManualType(), getMRMDecel(), OptionsCont::getOptions(), getRecoveryRate(), getResponseTime(), MSDevice_ToC(), TIME2STEPS, and useColorScheme().

Referenced by MSDevice::buildVehicleDevices().

◆ checkOptions()

bool MSDevice::checkOptions ( OptionsCont &  oc)
staticinherited

check device-specific options

Parameters

Definition at line 80 of file MSDevice.cpp.

References MSDevice_Routing::checkOptions().

Referenced by MSFrame::checkOptions().

◆ cleanupAll()

void MSDevice::cleanupAll ( )
staticinherited

perform cleanup for all devices

Definition at line 105 of file MSDevice.cpp.

References MSDevice_FCD::cleanup(), MSDevice_Tripinfo::cleanup(), and MSDevice_Routing::cleanup().

Referenced by MSNet::clearAll(), and MSDevice::getEquipmentRNG().

◆ descheduleMRM()

void MSDevice_ToC::descheduleMRM ( )
private

Break MRM Process or remove MRM-Trigger command from the event-queue.

Definition at line 430 of file MSDevice_ToC.cpp.

References WrappingCommand< T >::deschedule(), myExecuteMRMCommand, and myTriggerMRMCommand.

Referenced by deviceName(), requestMRM(), triggerDownwardToC(), triggerMRM(), and triggerUpwardToC().

◆ descheduleRecovery()

void MSDevice_ToC::descheduleRecovery ( )
private

Remove ongoing awareness recovery process from the event-queue.

Definition at line 462 of file MSDevice_ToC.cpp.

References WrappingCommand< T >::deschedule(), and myRecoverAwarenessCommand.

Referenced by deviceName(), requestMRM(), and triggerUpwardToC().

◆ descheduleToC()

void MSDevice_ToC::descheduleToC ( )
private

Remove scheduled ToC-Trigger command from the event-queue.

Definition at line 445 of file MSDevice_ToC.cpp.

References WrappingCommand< T >::deschedule(), and myTriggerToCCommand.

Referenced by deviceName(), requestMRM(), triggerDownwardToC(), and triggerUpwardToC().

◆ descheduleToCPreparation()

void MSDevice_ToC::descheduleToCPreparation ( )
private

Remove ongoing ToC-Preparation process from the event-queue.

Definition at line 453 of file MSDevice_ToC.cpp.

References WrappingCommand< T >::deschedule(), and myPrepareToCCommand.

Referenced by deviceName(), requestMRM(), ToCPreparationStep(), triggerDownwardToC(), and triggerUpwardToC().

◆ deviceName()

◆ ensureDriverStateExistence()

SUMOTime MSDevice_ToC::ensureDriverStateExistence ( SUMOTime  )

Ensure existence of DriverState for equipped vehicles.

Definition at line 241 of file MSDevice_ToC.cpp.

References MSVehicle::createDriverState(), MSVehicle::getDriverState(), SUMOVehicle::getID(), MSBaseVehicle::hasDevice(), MSDevice::myHolder, myHolderMS, and SIMTIME.

Referenced by deviceName(), and MSDevice_ToC().

◆ equippedByDefaultAssignmentOptions()

bool MSDevice::equippedByDefaultAssignmentOptions ( const OptionsCont &  oc,
const std::string &  deviceName,
SUMOVehicle &  v,
bool  outputOptionSet 
)
staticprotectedinherited

◆ equippedByParameter()

bool MSDevice::equippedByParameter ( const MSTransportable *  t,
const std::string &  deviceName,
bool  outputOptionSet 
)
staticinherited

◆ generateOutput()

virtual void MSDevice::generateOutput ( ) const
inlinevirtualinherited

Called on writing tripinfo output.

The device may write some statistics into the tripinfo output. It is assumed that the written information is a valid xml-snipplet, which will be embedded within the vehicle's information.

The device should use the openTag / closeTag methods of the OutputDevice for correct indentation.

Exceptions
IOErrornot yet implemented

Reimplemented in MSDevice_SSM, MSDevice_Tripinfo, MSDevice_Example, MSDevice_Bluelight, MSDevice_Vehroutes, and MSDevice_Emissions.

Definition at line 134 of file MSDevice.h.

References MSDevice::loadState(), and MSDevice::saveState().

◆ getAutomatedType()

std::string MSDevice_ToC::getAutomatedType ( const SUMOVehicle &  v,
const OptionsCont &  oc 
)
staticprivate

Definition at line 117 of file MSDevice_ToC.cpp.

References DEFAULT_AUTOMATED_TYPE, and MSDevice::getStringParam().

Referenced by buildVehicleDevices().

◆ getBoolParam()

bool MSDevice::getBoolParam ( const SUMOVehicle &  v,
const OptionsCont &  oc,
std::string  paramName,
bool  deflt,
bool  required 
)
staticprotectedinherited

◆ getDescription()

◆ getEquipmentRNG()

static std::mt19937* MSDevice::getEquipmentRNG ( )
inlinestaticinherited

◆ getFloatParam()

◆ getHolder()

SUMOVehicle& MSDevice::getHolder ( ) const
inlineinherited

Returns the vehicle that holds this device.

Returns
The vehicle that holds this device

Definition at line 118 of file MSDevice.h.

References MSDevice::myHolder.

Referenced by MSChargingStation::addChargeValueForOutput().

◆ getID()

const std::string& Named::getID ( ) const
inlineinherited

Returns the id.

Returns
The stored id

Definition at line 69 of file Named.h.

Referenced by NIImporter_SUMO::_loadNetwork(), MSLCM_LC2013::adaptSpeedToPedestrians(), MSVehicle::adaptToLeader(), MSVehicle::adaptToLeaders(), MSPModel_Remote::add(), LaneStoringVisitor::add(), MSPModel_Striping::add(), MSVehicleTransfer::add(), PCPolyContainer::add(), MSDetectorControl::add(), Named::StoringVisitor::add(), ShapeContainer::add(), NLTriggerBuilder::addAccess(), RORouteDef::addAlternative(), MSLane::addApproachingLane(), NBRailwayTopologyAnalyzer::addBidiEdge(), NBRailwayTopologyAnalyzer::addBidiEdgesForStops(), NBLoadedSUMOTLDef::addConnection(), NLHandler::addConnection(), NIXMLConnectionsHandler::addCrossing(), MSPModel_Striping::addCrossingVehs(), RODFDetectorCon::addDetector(), RONet::addEdge(), NBParkingCont::addEdges2Keep(), ROJTREdge::addFollowerProbability(), MSTLLogicControl::TLSLogicVariants::addLogic(), RONet::addNode(), MSRouteHandler::addPersonTrip(), NIImporter_SUMO::addPhase(), GUIEdge::addRerouter(), NBEdge::addRestrictedLane(), RONet::addRouteDef(), NBDistrict::addSink(), NBDistrict::addSource(), NIXMLEdgesHandler::addSplit(), NBTrafficLightLogic::addStep(), ROVehicle::addStop(), MSRouteHandler::addStop(), MSVehicle::addStop(), MSNet::addStoppingPlace(), NBEdge::addStraightConnections(), NIXMLTrafficLightsHandler::addTlConnection(), NIVissimDisturbance::addToNode(), MSVehicle::addTraciStop(), MSVehicle::addTraciStopAtStoppingPlace(), AGActivityTripWriter::addTrip(), NIXMLConnectionsHandler::addWalkingArea(), NBRailwayTopologyAnalyzer::allBroken(), NBEdge::append(), NBEdgeCont::appendRailwayTurnarounds(), NBPTStopCont::assignAndCreatNewPTStopAsNeeded(), NBPTStopCont::assignPTStopToEdgeOfClosestPlatform(), GUITrafficLightLogicWrapper::begin2TrackPhases(), MSTransportable::Stage_Waiting::beginEventOutput(), MSTransportable::Stage_Driving::beginEventOutput(), MSPModel_Striping::blockedAtDist(), MSLink::blockedAtTime(), MSLink::blockedByFoe(), NLEdgeControlBuilder::build(), NIVisumTL::build(), RODFNet::buildApproachList(), MSSOTLE2Sensors::buildContinueSensior(), MSSOTLE2Sensors::buildCountSensorForLane(), MSSOTLE2Sensors::buildCountSensorForOutLane(), NBNode::buildCrossings(), NBNode::buildCrossingsAndWalkingAreas(), NIImporter_VISUM::buildDistrictNode(), NLDetectorBuilder::buildE2Detector(), NIVissimConnection::buildEdgeConnections(), RODFNet::buildEdgeFlowMap(), GNETLSEditorFrame::buildIinternalLanes(), NBEdge::buildInnerEdges(), NGEdge::buildNBEdge(), NIVissimEdge::buildNBEdge(), NBRampsComputer::buildOffRamp(), NBRampsComputer::buildOnRamp(), MELoop::buildSegmentsFor(), MSSOTLE2Sensors::buildSensorForLane(), MSSOTLE2Sensors::buildSensorForOutLane(), NBNode::buildWalkingAreas(), MSBaseVehicle::calculateArrivalParams(), MSSwarmTrafficLightLogic::calculateEtaDiff(), MSSwarmTrafficLightLogic::calculateEtaRatio(), MSSOTLPolicyBasedTrafficLightLogic::canRelease(), MSLaneChanger::changeOpposite(), MELoop::changeSegment(), MSSimpleTrafficLightLogic::changeStepAndDuration(), MSEdge::checkAndRegisterBiDirEdge(), MSLane::checkForPedestrians(), NBEdge::checkGeometry(), NBEdgeCont::checkGrade(), MSVehicleTransfer::checkInsertions(), MSVehicle::checkLinkLeader(), NBEdgeCont::checkOverlap(), MSDevice_Battery::checkParam(), MSE2Collector::checkPositioning(), MSVehicle::checkRewindLinkLanes(), MSSwarmTrafficLightLogic::choosePolicy(), MSDevice_SSM::classifyEncounter(), NBTrafficLightLogic::closeBuilding(), ODDistrictHandler::closeDistrict(), NLHandler::closeEdge(), RORouteHandler::closeRouteDistribution(), RORouteHandler::closeVehicle(), NBTrafficLightDefinition::collectAllLinks(), NBLoadedSUMOTLDef::collectEdges(), NBTrafficLightDefinition::collectEdges(), NBLoadedSUMOTLDef::collectEdgeVectors(), NBLoadedTLDef::collectLinks(), ROJTRRouter::compute(), NBTrafficLightDefinition::compute(), NBEdge::computeAngle(), NBEdge::computeLaneShapes(), NBNode::computeLogic(), NBOwnTLDef::computeLogicAndConts(), NBNode::computeNodeShape(), NBNodeShapeComputer::computeNodeShapeDefault(), NBNodeShapeComputer::computeNodeShapeSmall(), RODFNet::computeRoutesFor(), NBTrafficLightLogicCont::computeSingleLogic(), NBNode::computeSmoothShape(), NBTurningDirectionsComputer::computeTurnDirectionsForNode(), NGNet::connect(), MSSOTLWaveTrafficLightLogic::countVehicles(), MSSOTLE2Sensors::countVehicles(), MSDevice_SSM::createEncounters(), GUINet::createTLWrapper(), NBEdge::debugPrintConnections(), MSDeterministicHiLevelTrafficLightLogic::decideNextPhase(), MSSOTLPolicyBasedTrafficLightLogic::decideNextPhase(), MSSwarmTrafficLightLogic::decideNextPhase(), MSDeterministicHiLevelTrafficLightLogic::decidePolicy(), MSSwarmTrafficLightLogic::decidePolicy(), MSLane::detectCollisionBetween(), MSLane::detectCollisions(), MSLane::detectPedestrianJunctionCollision(), NIVissimDistrictConnection::dict_BuildDistricts(), NBEdge::divideOnEdges(), NBEdge::divideSelectedLanesOnEdges(), MSTransportable::Stage_Waiting::endEventOutput(), MSTransportable::Stage_Driving::endEventOutput(), MSE3Collector::enter(), MSVehicle::enterLaneAtMove(), METriggeredCalibrator::execute(), MSCalibrator::execute(), Command_SaveTLSState::execute(), Command_SaveTLSSwitchStates::execute(), Command_SaveTLSSwitches::execute(), MSVTypeProbe::execute(), MSTrafficLightLogic::SwitchCommand::execute(), MSPModel_Striping::MovePedestrians::execute(), MSVehicle::executeMove(), MSLane::executeMovements(), NBRailwayTopologyAnalyzer::extendBidiEdges(), NBNodeCont::extract(), NBTrafficLightLogicCont::extract(), NBEdgeCont::extract(), NBNodeCont::feasibleCluster(), libsumo::Helper::findCloserLane(), MSDevice_SSM::findFoeConflictLane(), libsumo::Simulation::findIntermodalRoute(), MSDevice_SSM::findSurroundingVehicles(), MSDevice_SSM::flushConflicts(), NBTrafficLightDefinition::forbids(), NBRampsComputer::fulfillsRampConstraints(), NBPTStopCont::generateBidiStops(), NBNodeCont::generateNodeClusters(), RODFDetectorCon::getAggFlowFor(), RODFDetectorCon::getAnyDetectorForEdge(), MSPModel_Striping::getArbitraryPath(), GNEConnection::getAttribute(), MSVehicle::getBackPosition(), MSVehicle::getBackPositionOnLane(), libsumo::Vehicle::getBestLanes(), NBOwnTLDef::getBestPair(), NBRailwayTopologyAnalyzer::getBrokenRailNodes(), MSVehicle::getCenterOnEdge(), MSDevice_Battery::getChargingStationID(), NBEdge::getConnection(), NBEdge::getConnectionRef(), libsumo::TrafficLight::getControlledLinks(), MSLane::getCriticalLeader(), NBEdge::getCrossingAngle(), NBNodeShapeComputer::getDefaultRadius(), RODFNet::getDetectorEdge(), libsumo::Lane::getEdgeID(), MSMeanData::getEdgeID(), NBEdge::getFirstNonPedestrianLane(), MSPModel_Remote::getFirstPedestrianLane(), MSLane::getFollower(), MSLane::getFollowersOnConsecutive(), libsumo::LaneArea::getLaneID(), libsumo::InductionLoop::getLaneID(), libsumo::Vehicle::getLaneID(), MSLane::getLastVehicleInformation(), MSVehicle::getLatOffset(), MSLane::getLeader(), MSLink::getLeaderInfo(), MSLane::getLeaderOnConsecutive(), MSLane::getLeadersOnConsecutive(), MSLink::getLengthBeforeCrossing(), MSLane::getLinkTo(), MSTLLogicControl::TLSLogicVariants::getLogicInstantiatingOff(), MSDeterministicHiLevelTrafficLightLogic::getMeanSpeedForInputLanes(), MSDeterministicHiLevelTrafficLightLogic::getMeanSpeedForOutputLanes(), NIImporter_VISUM::getNamedEdgeContinuating(), MSPerson::getNextEdge(), MSPModel_Striping::getNextLane(), MSLane::getOppositeFollower(), MSLane::getOppositeLeader(), MSLane::getOppositePos(), GUITrafficLightLogicWrapper::getParameterWindow(), GUIInstantInductLoop::MyWrapper::getParameterWindow(), GUIMEInductLoop::MyWrapper::getParameterWindow(), GUIVehicle::getParameterWindow(), GUIE2Collector::MyWrapper::getParameterWindow(), GUIInductLoop::MyWrapper::getParameterWindow(), MSLane::getPartialBehind(), MSSOTLTrafficLightLogic::getPhaseIndexWithMaxCTS(), MSSwarmTrafficLightLogic::getPheromoneForInputLanes(), MSSwarmTrafficLightLogic::getPheromoneForOutputLanes(), GUITrafficLightLogicWrapper::getPopUpMenu(), NLTriggerBuilder::getPosition(), NLDetectorBuilder::getPositionChecking(), NBNode::getPossiblySplittedIncoming(), NBNode::getPossiblySplittedOutgoing(), NIImporter_VISUM::getReversedContinuating(), NBPTStopCont::getReverseStop(), libsumo::Person::getRoadID(), libsumo::Vehicle::getRoadID(), libsumo::Vehicle::getRouteID(), MSContainer::MSContainerStage_Driving::getStageSummary(), MSPerson::MSPersonStage_Walking::getStageSummary(), MSContainer::MSContainerStage_Tranship::getStageSummary(), MSTransportable::Stage_Waiting::getStageSummary(), MSPerson::MSPersonStage_Driving::getStageSummary(), MSPerson::MSPersonStage_Access::getStageSummary(), MSNet::getStoppingPlaceID(), MSDevice_SSM::getUpstreamVehicles(), MSPModel_Striping::getVehicleObstacles(), MSDevice_SSM::getVehiclesOnJunction(), MSTransportable::Stage_Driving::getWaitingDescription(), MSVehicleControl::getWaitingVehicle(), MSLink::getZipperSpeed(), NBNode::guessCrossings(), RODFDetectorCon::guessEmptyFlows(), NBEdgeCont::guessSidewalks(), NBNodeCont::guessTLs(), GUITLLogicPhasesTrackerWindow::GUITLLogicPhasesTrackerWindow(), MSLane::handleCollisionBetween(), NBEdgeCont::ignoreFilterMatch(), MSVehicle::ignoreRed(), MSDeterministicHiLevelTrafficLightLogic::init(), MSRailSignal::init(), MSDelayBasedTrafficLightLogic::init(), MSActuatedTrafficLightLogic::init(), MSTrafficLightLogic::init(), MSSOTLTrafficLightLogic::init(), MSSwarmTrafficLightLogic::init(), NBEdge::init(), MSE2Collector::initAuxiliaries(), NIImporter_SUMO::initTrafficLightLogic(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), NBDistrictCont::insert(), NBTrafficLightLogicCont::insert(), NBNodeCont::insert(), NBEdgeCont::insert(), MSEdge::insertVehicle(), MSLane::integrateNewVehicle(), GNEJunction::invalidateTLS(), NBNode::invalidateTLS(), MSTLLogicControl::isActive(), MSPedestrianPushButton::isActiveForEdge(), MSPedestrianPushButton::isActiveOnAnySideOfTheRoad(), RODFNet::isDestination(), RODFNet::isFalseSource(), MSLane::isInsertionSuccess(), MSJunction::isLeader(), MESegment::isOpen(), RODFNet::isSource(), NIImporter_VISUM::isSplitEdge(), MSSOTLTrafficLightLogic::isThresholdPassed(), MESegment::jamThresholdForSpeed(), NBNodeCont::joinJunctions(), NBNodeShapeComputer::joinSameDirectionEdges(), NBEdgeCont::joinSameNodeConnectingEdges(), MSAbstractLaneChangeModel::laneChangeOutput(), MSE3Collector::leave(), MSE3Collector::leaveFront(), MSDevice_BTreceiver::BTreceiverUpdate::leaveRange(), MSPedestrianPushButton::loadCrossingEdgeMap(), NIImporter_OpenDrive::loadNetwork(), MSPedestrianPushButton::loadPushButtons(), NBEdge::MainDirections::MainDirections(), ODDistrictCont::makeDistricts(), MSE2Collector::makeVehicleInfo(), GNEJunction::markAsModified(), MSSOTLE2Sensors::meanVehiclesSpeed(), METriggeredCalibrator::METriggeredCalibrator(), MSPModel_Striping::moveInDirection(), MSPModel_Striping::moveInDirectionOnLane(), NBRampsComputer::moveRampRight(), MSPModel_Striping::PState::moveToNextLane(), libsumo::Person::moveToXY(), libsumo::Vehicle::moveToXY(), libsumo::Helper::moveToXYMap(), MSCalibrator::MSCalibrator(), MSChargingStation::MSChargingStation(), MSDevice_Battery::MSDevice_Battery(), MSE2Collector::MSE2Collector(), NBLoadedTLDef::myCompute(), NIImporter_SUMO::myEndElement(), NIXMLConnectionsHandler::myStartElement(), NIXMLEdgesHandler::myStartElement(), MSCalibrator::myStartElement(), MSLaneSpeedTrigger::myStartElement(), MSTriggeredRerouter::myStartElement(), NBConnection::NBConnection(), NBRequest::NBRequest(), MSPModel_Striping::nextBlocking(), MSDevice_BTsender::notifyEnter(), MSMeanData::MeanDataValues::notifyEnter(), MSDevice_Bluelight::notifyEnter(), MSDevice_BTreceiver::notifyEnter(), MSDevice_Example::notifyEnter(), MSMeanData_Net::MSLaneMeanDataValues::notifyEnter(), MSDevice_Tripinfo::notifyEnter(), MSTriggeredRerouter::notifyEnter(), MSMeanData::MeanDataValueTracker::notifyEnter(), MSE2Collector::notifyEnter(), MSDevice_SSM::notifyEnter(), MSDevice_Transportable::notifyLeave(), MSDevice_Bluelight::notifyLeave(), MSDevice_Example::notifyLeave(), MSE3Collector::MSE3EntryReminder::notifyLeave(), MSDevice_BTsender::notifyLeave(), MSDevice_BTreceiver::notifyLeave(), MSDevice_Tripinfo::notifyLeave(), MSE3Collector::MSE3LeaveReminder::notifyLeave(), MSE2Collector::notifyLeave(), MSDevice_SSM::notifyLeave(), MSDevice_Bluelight::notifyMove(), MSDevice_Example::notifyMove(), MSE3Collector::MSE3EntryReminder::notifyMove(), MSDevice_BTsender::notifyMove(), MSMeanData::MeanDataValues::notifyMove(), MSDevice_BTreceiver::notifyMove(), MSE3Collector::MSE3LeaveReminder::notifyMove(), MSE2Collector::notifyMove(), MSDevice_SSM::notifyMove(), MSMeanData_Net::MSLaneMeanDataValues::notifyMoveInternal(), GNETLSEditorFrame::TLSFile::onCmdSaveTLSProgram(), GUIViewTraffic::onGamingClick(), GNEViewNet::onLeftBtnPress(), MSLink::opened(), RORouteHandler::openRoute(), NBTurningDirectionsComputer::combination_by_angle_sorter::operator()(), RODFNet::idComp::operator()(), NBNetBuilder::by_id_sorter::operator()(), NBOwnTLDef::edge_by_incoming_priority_sorter::operator()(), NBContHelper::same_connection_edge_sorter::operator()(), NBContHelper::edge_by_angle_to_nodeShapeCentroid_sorter::operator()(), NBNode::nodes_by_id_sorter::operator()(), MSEdge::by_id_sorter::operator()(), MSLane::incoming_lane_priority_sorter::operator()(), MSLane::outgoing_lane_priority_sorter::operator()(), NBRequest::oppositeLeftTurnConflict(), NIImporter_VISUM::parse_EdgePolys(), NIImporter_VISUM::parse_Lanes(), NIImporter_VISUM::parse_LanesConnections(), NIImporter_VISUM::parse_Turns(), NIImporter_VISUM::parse_TurnsToSignalGroups(), NLTriggerBuilder::parseAndBuildCalibrator(), NIXMLConnectionsHandler::parseDeprecatedLaneDefinition(), NIXMLConnectionsHandler::parseLaneBound(), MSRouteHandler::parseWalkPositions(), MSJunction::passedJunction(), NBLoadedSUMOTLDef::patchIfCrossingsAdded(), MSLCM_LC2013::patchSpeed(), MSLCM_SL2015::patchSpeed(), NBLoadedTLDef::SignalGroup::patchTYellow(), MSVehicle::planMove(), MSVehicle::planMoveInternal(), MSLane::planMovements(), MSInternalJunction::postloadInit(), MSRightOfWayJunction::postloadInit(), NBEdge::prepareEdgePriorities(), AGStreet::print(), MSDevice_SSM::processEncounters(), MSVehicle::processLinkAproaches(), MSVehicle::processNextStop(), TraCIServerAPI_Vehicle::processSet(), NBEdgeCont::processSplits(), MEVehicle::processStop(), NIXMLNodesHandler::processTrafficLightDefinitions(), NWWriter_SUMO::prohibitionConnection(), MSDelayBasedTrafficLightLogic::proposeProlongation(), NBNodeCont::pruneClusterFringe(), MSPModel_Striping::PState::PState(), MSOffTrafficLightLogic::rebuildPhase(), NBEdgeCont::recheckLanes(), NBEdge::recheckLanes(), NBEdgeCont::recheckPostProcessConnections(), NIImporter_OpenStreetMap::reconstructLayerElevation(), NBLoadedSUMOTLDef::reconstructLogic(), NBEdgeCont::remapIDs(), NBLoadedTLDef::SignalGroup::remapIncoming(), NBLoadedTLDef::SignalGroup::remapOutgoing(), MSLink::removeApproaching(), GNEJunction::removeConnectionsFrom(), NBNodeCont::removeIsolatedRoads(), MSVehicle::removePassedDriveItems(), MSCalibrator::removePending(), NBNode::removeSelfLoops(), GNEJunction::removeTLSConnections(), NBEdgeCont::removeUnwishedEdges(), NBNodeCont::rename(), NBEdgeCont::rename(), GNENet::renameEdge(), GNENet::renameJunction(), RORouteDef::repairCurrentRoute(), NBConnection::replaceFrom(), GNEJunction::replaceIncomingConnections(), MSVehicle::replaceParkingArea(), MSBaseVehicle::replaceRouteEdges(), NBConnection::replaceTo(), NIImporter_DlrNavteq::TrafficlightsHandler::report(), NIImporter_DlrNavteq::ConnectedLanesHandler::report(), NLEdgeControlBuilder::reportCurrentEdgeOrLane(), MSBaseVehicle::reroute(), MSTriggeredRerouter::rerouteParkingArea(), MSTransportable::rerouteParkingArea(), MSVehicle::rerouteParkingArea(), MSLane::resetManeuverReservation(), MSLane::resetPartialOccupation(), NBEdge::restoreRestrictedLane(), GNEEdge::retrieveGNEConnection(), NIXMLTrafficLightsHandler::retrieveLaneIndex(), RODFNet::revalidateFlows(), NBRailwayTopologyAnalyzer::reverseEdges(), NBPTLineCont::reviseStops(), MSPerson::MSPersonStage_Walking::routeOutput(), MSPerson::MSPersonStage_Driving::routeOutput(), RONet::saveAndRemoveRoutesUntil(), MSDevice_Vehroutes::saveState(), MSDevice::saveState(), MSDevice_Tripinfo::saveState(), MSDevice_Routing::saveState(), MSBaseVehicle::saveState(), MSLane::saveState(), GUIVehicle::selectBlockingFoes(), MSE2Collector::selectLanes(), MSLink::setApproaching(), NBNodeCont::setAsTLControlled(), GNEEdge::setAttribute(), MSChargingStation::setChargeDelay(), MSChargingStation::setChargingPower(), NBEdge::setControllingTLInformation(), NLEdgeControlBuilder::setDefaultStopOffsets(), MSChargingStation::setEfficency(), MSLane::setManeuverReservation(), MSDevice_Battery::setMaximumBatteryCapacity(), NBEdge::setNodeBorder(), NIXMLEdgesHandler::setNodes(), MSLane::setPartialOccupation(), MSDevice_Battery::setPowerMax(), MSLink::setRequestInformation(), MSTLLogicControl::TLSLogicVariants::setStateInstantiatingOnline(), NBEdge::setStopOffsets(), MSDevice_Battery::setStoppingTreshold(), NBLoadedSUMOTLDef::setTLControllingInformation(), NBOwnTLDef::setTLControllingInformation(), NBTrafficLightLogicCont::setTLControllingInformation(), NBLoadedTLDef::setTLControllingInformation(), NBEdge::shiftPositionAtNode(), NBNode::sortEdges(), MSLane::sortManeuverReservations(), NBEdgeCont::splitAt(), IntermodalNetwork< E, L, N, V >::splitEdge(), MSLaneChangerSublane::startChangeSublane(), MSStopOut::stopEnded(), MSStopOut::stopStarted(), MSLane::succLinkSec(), GUITrafficLightLogicWrapper::switchTLSLogic(), MELoop::teleportVehicle(), NGNet::toNB(), METriggeredCalibrator::tryEmit(), MSSOTLTrafficLightLogic::trySwitch(), MSDevice_SSM::update(), MSVehicle::updateBestLanes(), MSLCM_SL2015::updateCFRelated(), MSSOTLTrafficLightLogic::updateCTS(), NLEdgeControlBuilder::updateCurrentLaneStopOffsets(), MSVehicle::updateDriveItems(), GNETLSEditorFrame::TLSJunction::updateJunctionDescription(), MSSwarmTrafficLightLogic::updatePheromoneLevels(), MSSwarmTrafficLightLogic::updateSensitivities(), MSAbstractLaneChangeModel::updateTargetLane(), MSDevice_BTreceiver::BTreceiverUpdate::updateVisibility(), MSPModel_Striping::PState::walk(), MSLCM_LC2013::wantsChange(), MSLCM_SL2015::wantsChange(), MSLCM_SL2015::wantsChangeSublane(), NBParking::write(), MSEmissionExport::write(), MSBatteryExport::write(), MSFCDExport::write(), MSInstantInductLoop::write(), MSLink::writeApproaching(), NBSign::writeAsPOI(), NWWriter_DlrNavteq::writeConnectedLanes(), NWWriter_SUMO::writeConnection(), NWWriter_SUMO::writeDistrict(), MSFullExport::writeEdge(), MSXMLRawOut::writeEdge(), NWWriter_SUMO::writeEdge(), MSMeanData::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), NWWriter_SUMO::writeInternalConnections(), NWWriter_OpenDrive::writeInternalEdge(), writeInterval(), NWWriter_SUMO::writeJunction(), MSQueueExport::writeLane(), MSFullExport::writeLane(), NWWriter_DlrNavteq::writeLinksUnsplitted(), NWWriter_OpenDrive::writeNetwork(), NWWriter_XML::writeNodes(), NWWriter_DlrNavteq::writeNodesUnsplitted(), NWWriter_OpenDrive::writeNormalEdge(), NWWriter_DlrNavteq::writeProhibitedManoeuvres(), NWWriter_SUMO::writeRoundabout(), RODFDetectorCon::writeSpeedTrigger(), NWWriter_DlrNavteq::writeTrafficSignals(), MSFCDExport::writeTransportable(), RODFDetectorCon::writeValidationDetectors(), MSFullExport::writeVehicles(), SUMOPolygon::writeXML(), PointOfInterest::writeXML(), MSRouteProbe::writeXMLOutput(), MSInductLoop::writeXMLOutput(), MSE2Collector::writeXMLOutput(), and RONet::~RONet().

◆ getIDSecure()

◆ getInitialAwareness()

double MSDevice_ToC::getInitialAwareness ( const SUMOVehicle &  v,
const OptionsCont &  oc 
)
staticprivate

Definition at line 132 of file MSDevice_ToC.cpp.

References DEFAULT_INITIAL_AWARENESS, and MSDevice::getFloatParam().

Referenced by buildVehicleDevices().

◆ getLane()

◆ getManualType()

std::string MSDevice_ToC::getManualType ( const SUMOVehicle &  v,
const OptionsCont &  oc 
)
staticprivate

Definition at line 112 of file MSDevice_ToC.cpp.

References DEFAULT_MANUAL_TYPE, and MSDevice::getStringParam().

Referenced by buildVehicleDevices().

◆ getMRMDecel()

double MSDevice_ToC::getMRMDecel ( const SUMOVehicle &  v,
const OptionsCont &  oc 
)
staticprivate

Definition at line 137 of file MSDevice_ToC.cpp.

References DEFAULT_MRM_DECEL, and MSDevice::getFloatParam().

Referenced by buildVehicleDevices().

◆ getParameter()

std::string MSDevice_ToC::getParameter ( const std::string &  key) const
virtual

try to retrieve the given parameter from this device. Throw exception for unsupported key

Reimplemented from MSDevice.

Definition at line 566 of file MSDevice_ToC.cpp.

References _2string(), deviceName(), SUMOVehicle::getID(), myAutomatedTypeID, myCurrentAwareness, MSDevice::myHolder, myInitialAwareness, myManualTypeID, myMRMDecel, myRecoveryRate, myResponseTime, myState, STEPS2TIME, and toString().

Referenced by deviceName().

◆ getRecoveryRate()

double MSDevice_ToC::getRecoveryRate ( const SUMOVehicle &  v,
const OptionsCont &  oc 
)
staticprivate

Definition at line 127 of file MSDevice_ToC.cpp.

References DEFAULT_RECOVERY_RATE, and MSDevice::getFloatParam().

Referenced by buildVehicleDevices().

◆ getResponseTime()

double MSDevice_ToC::getResponseTime ( const SUMOVehicle &  v,
const OptionsCont &  oc 
)
staticprivate

Definition at line 122 of file MSDevice_ToC.cpp.

References DEFAULT_RESPONSE_TIME, and MSDevice::getFloatParam().

Referenced by buildVehicleDevices().

◆ getStringParam()

std::string MSDevice::getStringParam ( const SUMOVehicle &  v,
const OptionsCont &  oc,
std::string  paramName,
std::string  deflt,
bool  required 
)
staticprotectedinherited

◆ initColorScheme()

void MSDevice_ToC::initColorScheme ( )
private

Initialize vehicle colors for different states.

Note
For MANUAL and AUTOMATED, the color of the given types are used, and for the other states hardcoded colors are given.

Definition at line 229 of file MSDevice_ToC.cpp.

References AUTOMATED, MSVehicleType::getColor(), MSNet::getInstance(), MSNet::getVehicleControl(), MSVehicleControl::getVType(), MANUAL, MRM, myAutomatedTypeID, myColorScheme, myManualTypeID, PREPARING_TOC, RECOVERING, and UNDEFINED.

Referenced by deviceName(), and MSDevice_ToC().

◆ insertDefaultAssignmentOptions()

void MSDevice::insertDefaultAssignmentOptions ( const std::string &  deviceName,
const std::string &  optionsTopic,
OptionsCont &  oc 
)
staticprotectedinherited

Adds common command options that allow to assign devices to vehicles.

Parameters
[in]deviceNameThe name of the device type
[in]optionsTopicThe options topic into which the options shall be added

!! describe

!! describe

Definition at line 112 of file MSDevice.cpp.

References OptionsCont::addDescription(), OptionsCont::addSynonyme(), and OptionsCont::doRegister().

Referenced by MSDevice_Battery::insertOptions(), MSDevice_Bluelight::insertOptions(), MSDevice_FCD::insertOptions(), MSDevice_Example::insertOptions(), MSDevice_BTsender::insertOptions(), MSDevice_BTreceiver::insertOptions(), MSDevice_DriverState::insertOptions(), insertOptions(), MSDevice_Emissions::insertOptions(), MSDevice_Routing::insertOptions(), MSDevice_SSM::insertOptions(), and MSDevice::setParameter().

◆ insertOptions()

◆ loadState()

void MSDevice::loadState ( const SUMOSAXAttributes &  attrs)
virtualinherited

Loads the state of the device from the given description.

The default implementation does nothing.

Parameters
[in]attrsXML attributes describing the current state

Reimplemented in MSDevice_Routing, MSDevice_Tripinfo, and MSDevice_Vehroutes.

Definition at line 193 of file MSDevice.cpp.

Referenced by MSDevice::generateOutput().

◆ MRMExecutionStep()

◆ notifyEnter()

virtual bool MSMoveReminder::notifyEnter ( SUMOVehicle &  veh,
Notification  reason,
const MSLane *  enteredLane 
)
inlinevirtualinherited

Checks whether the reminder is activated by a vehicle entering the lane.

Lane change means in this case that the vehicle changes to the lane the reminder is placed at.

Parameters
[in]vehThe entering vehicle.
[in]reasonhow the vehicle enters the lane
Returns
True if vehicle enters the reminder.
See also
Notification

Reimplemented in MSDevice_SSM, MSE2Collector, MSMeanData::MeanDataValueTracker, MSE3Collector::MSE3LeaveReminder, MSDevice_Routing, MSCalibrator::VehicleRemover, MSTriggeredRerouter, MSDevice_Tripinfo, MSMeanData_Net::MSLaneMeanDataValues, MSInductLoop, MSMeanData_Amitran::MSLaneMeanDataValues, MSDevice_BTreceiver, MSDevice_Example, MSDevice_Bluelight, MSDevice_BTsender, MSMeanData::MeanDataValues, MSDevice_Vehroutes, MSRouteProbe, MSE3Collector::MSE3EntryReminder, MSDevice_Transportable, and MSDevice_FCD.

Definition at line 128 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyLeave()

virtual bool MSMoveReminder::notifyLeave ( SUMOVehicle &  veh,
double  lastPos,
Notification  reason,
const MSLane *  enteredLane = 0 
)
inlinevirtualinherited

Called if the vehicle leaves the reminder's lane.

Informs if vehicle leaves reminder lane (due to lane change, removal from the network, or leaving to the next lane). The default is to do nothing.

Parameters
[in]vehThe leaving vehicle.
[in]lastPosPosition on the lane when leaving.
[in]reasonhow the vehicle leaves the lane
See also
Notification
Returns
True if the reminder wants to receive further info.

Reimplemented in MSDevice_SSM, MSE2Collector, MSMeanData::MeanDataValueTracker, MSE3Collector::MSE3LeaveReminder, MSTriggeredRerouter, MSInductLoop, MSDevice_Tripinfo, MSDevice_BTreceiver, MSDevice_BTsender, MSMeanData::MeanDataValues, MSE3Collector::MSE3EntryReminder, MSDevice_Example, MSDevice_Bluelight, MSInstantInductLoop, MSDevice_Vehroutes, MSMeanData_Net::MSLaneMeanDataValues, and MSDevice_Transportable.

Definition at line 174 of file MSMoveReminder.h.

References UNUSED_PARAMETER, and MSMoveReminder::updateDetector().

◆ notifyMove()

virtual bool MSMoveReminder::notifyMove ( SUMOVehicle &  veh,
double  oldPos,
double  newPos,
double  newSpeed 
)
inlinevirtualinherited

Checks whether the reminder still has to be notified about the vehicle moves.

Indicator if the reminders is still active for the passed vehicle/parameters. If false, the vehicle will erase this reminder from it's reminder-container.

Parameters
[in]vehVehicle that asks this reminder.
[in]oldPosPosition before move.
[in]newPosPosition after move with newSpeed.
[in]newSpeedMoving speed.
Returns
True if vehicle hasn't passed the reminder completely.

Reimplemented in MSDevice_SSM, MSE2Collector, MSE3Collector::MSE3LeaveReminder, MSTriggeredRerouter, MSInductLoop, MSDevice_BTreceiver, MSDevice_BTsender, MSMeanData::MeanDataValues, MSDevice_Tripinfo, MSE3Collector::MSE3EntryReminder, MSDevice_Emissions, MSInstantInductLoop, MSDevice_Example, MSDevice_Bluelight, MSDevice_Battery, and MSDevice_Transportable.

Definition at line 149 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyMoveInternal()

virtual void MSMoveReminder::notifyMoveInternal ( const SUMOVehicle &  veh,
const double  frontOnLane,
const double  timeOnLane,
const double  meanSpeedFrontOnLane,
const double  meanSpeedVehicleOnLane,
const double  travelledDistanceFrontOnLane,
const double  travelledDistanceVehicleOnLane,
const double  meanLengthOnLane 
)
inlinevirtualinherited

Internal notification about the vehicle moves.

Note
meso uses this though it never calls notifyMove()

Indicator if the reminders is still active for the passed vehicle/parameters. If false, the vehicle will erase this reminder from it's reminder-container.

Parameters
[in]vehVehicle that asks this reminder.
[in]frontOnLanetime the front of the vehicle spent on the lane.
[in]timeOnLanetime some part of the vehicle spent on the lane.
[in]meanSpeedFrontOnLaneAverage speed for the time that the front is on the lane.
[in]meanSpeedVehicleOnLaneAverage speed for the time that the vehicle is on the lane (with front or back).
[in]travelledDistanceFrontOnLanedistance travelled while overlapping with the lane.
[in]travelledDistanceVehicleOnLanedistance travelled while front was on the lane.
[in]meanLengthOnLanethe average length of the vehicle's part on the lane during the last step (==complete length in meso case)

Reimplemented in MSMeanData::MeanDataValueTracker, MSDevice_Tripinfo, MSDevice_Transportable, MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, and MSMeanData_Emissions::MSLaneMeanDataValues.

Definition at line 206 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

Referenced by MSMeanData::MeanDataValues::notifyMove(), and MSMoveReminder::updateDetector().

◆ operator=()

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

Invalidated assignment operator.

◆ removeFromVehicleUpdateValues()

void MSMoveReminder::removeFromVehicleUpdateValues ( SUMOVehicle &  veh)
protectedinherited

◆ requestMRM()

void MSDevice_ToC::requestMRM ( )
private

Request an MRM to be initiated immediately. No downward ToC will be scheduled.

Note
The initiated MRM process will run forever until a new ToC is requested.

Definition at line 304 of file MSDevice_ToC.cpp.

References descheduleMRM(), descheduleRecovery(), descheduleToC(), descheduleToCPreparation(), and triggerMRM().

Referenced by deviceName(), and setParameter().

◆ requestToC()

void MSDevice_ToC::requestToC ( SUMOTime  timeTillMRM)
private

Request a ToC. If the device is in AUTOMATED or MRM state, a driver response time is sampled and the ToC is scheduled. If the response is larger than timeTillMRM, an MRM is scheduled as well. If the device is in MANUAL or UNDEFINED state, it switches to AUTOMATED. The request is ignored if the state is already PREPARING_TOC.

Definition at line 319 of file MSDevice_ToC.cpp.

References MSEventControl::addEvent(), AUTOMATED, DELTA_T, MSNet::getBeginOfTimestepEvents(), SUMOVehicle::getID(), MSNet::getInstance(), myExecuteMRMCommand, MSDevice::myHolder, myPrepareToCCommand, myResponseTime, myState, myTriggerMRMCommand, myTriggerToCCommand, PREPARING_TOC, setState(), SIMSTEP, SIMTIME, ToCPreparationStep(), triggerDownwardToC(), triggerMRM(), triggerUpwardToC(), and WRITE_WARNING.

Referenced by deviceName(), and setParameter().

◆ saveState()

void MSDevice::saveState ( OutputDevice &  out) const
virtualinherited

Saves the state of the device.

The default implementation writes a warning and does nothing.

Parameters
[in]outThe OutputDevice to write the information into

Reimplemented in MSDevice_Routing, MSDevice_Tripinfo, MSDevice_Vehroutes, and MSDevice_FCD.

Definition at line 187 of file MSDevice.cpp.

References Named::getID(), and WRITE_WARNING.

Referenced by MSDevice::generateOutput().

◆ setAwareness()

void MSDevice_ToC::setAwareness ( double  value)
private

◆ setDescription()

void MSMoveReminder::setDescription ( const std::string &  description)
inlineinherited

◆ setID()

void Named::setID ( const std::string &  newID)
inlineinherited

◆ setParameter()

void MSDevice_ToC::setParameter ( const std::string &  key,
const std::string &  value 
)
virtual

◆ setState()

void MSDevice_ToC::setState ( ToCState  state)
private

Set the ToC device's state.

Definition at line 289 of file MSDevice_ToC.cpp.

References myState, myUseColorScheme, and setVehicleColor().

Referenced by awarenessRecoveryStep(), deviceName(), requestToC(), triggerDownwardToC(), triggerMRM(), and triggerUpwardToC().

◆ setVehicleColor()

void MSDevice_ToC::setVehicleColor ( )
private

◆ switchHolderType()

void MSDevice_ToC::switchHolderType ( const std::string &  targetTypeID)
private

◆ ToCPreparationStep()

SUMOTime MSDevice_ToC::ToCPreparationStep ( SUMOTime  t)

Continue the ToC preparation for one time step.

Definition at line 486 of file MSDevice_ToC.cpp.

References DELTA_T, descheduleToCPreparation(), SUMOVehicle::getID(), MSDevice::myHolder, myState, PREPARING_TOC, and SIMTIME.

Referenced by deviceName(), and requestToC().

◆ triggerDownwardToC()

◆ triggerMRM()

◆ triggerUpwardToC()

SUMOTime MSDevice_ToC::triggerUpwardToC ( SUMOTime  t)

◆ updateDetector()

void MSMoveReminder::updateDetector ( SUMOVehicle &  veh,
double  entryPos,
double  leavePos,
SUMOTime  entryTime,
SUMOTime  currentTime,
SUMOTime  leaveTime,
bool  cleanUp 
)
inherited

◆ useColorScheme()

bool MSDevice_ToC::useColorScheme ( const SUMOVehicle &  v,
const OptionsCont &  oc 
)
staticprivate

Definition at line 142 of file MSDevice_ToC.cpp.

References MSDevice::getBoolParam().

Referenced by buildVehicleDevices(), and deviceName().

Field Documentation

◆ myAutomatedTypeID

std::string MSDevice_ToC::myAutomatedTypeID
private

vehicle type ID for automated driving

Definition at line 204 of file MSDevice_ToC.h.

Referenced by getParameter(), initColorScheme(), MSDevice_ToC(), setParameter(), triggerMRM(), and triggerUpwardToC().

◆ myColorScheme

std::map<ToCState, RGBColor> MSDevice_ToC::myColorScheme
private

Coloring scheme,.

See also
initColorScheme()

Definition at line 220 of file MSDevice_ToC.h.

Referenced by initColorScheme(), setParameter(), and setVehicleColor().

◆ myCurrentAwareness

double MSDevice_ToC::myCurrentAwareness
private

◆ myDescription

std::string MSMoveReminder::myDescription
protectedinherited

a description of this moveReminder

Definition at line 240 of file MSMoveReminder.h.

Referenced by MSMoveReminder::getDescription(), and MSMoveReminder::setDescription().

◆ myExecuteMRMCommand

WrappingCommand<MSDevice_ToC>* MSDevice_ToC::myExecuteMRMCommand
private

Definition at line 239 of file MSDevice_ToC.h.

Referenced by descheduleMRM(), requestToC(), triggerMRM(), and ~MSDevice_ToC().

◆ myHolder

◆ myHolderMS

MSVehicle* MSDevice_ToC::myHolderMS
private

The holder vehicle casted to MSVehicle*.

Definition at line 231 of file MSDevice_ToC.h.

Referenced by ensureDriverStateExistence(), MRMExecutionStep(), MSDevice_ToC(), setAwareness(), and switchHolderType().

◆ myID

◆ myInitialAwareness

double MSDevice_ToC::myInitialAwareness
private

Definition at line 211 of file MSDevice_ToC.h.

Referenced by getParameter(), MSDevice_ToC(), setParameter(), and triggerDownwardToC().

◆ myLane

◆ myManualTypeID

std::string MSDevice_ToC::myManualTypeID
private

vehicle type ID for manual driving

Definition at line 202 of file MSDevice_ToC.h.

Referenced by getParameter(), initColorScheme(), MSDevice_ToC(), setParameter(), and triggerDownwardToC().

◆ myMRMDecel

double MSDevice_ToC::myMRMDecel
private

Deceleration rate applied during MRM.

Definition at line 214 of file MSDevice_ToC.h.

Referenced by getParameter(), MRMExecutionStep(), MSDevice_ToC(), and setParameter().

◆ myPrepareToCCommand

WrappingCommand<MSDevice_ToC>* MSDevice_ToC::myPrepareToCCommand
private

Definition at line 240 of file MSDevice_ToC.h.

Referenced by descheduleToCPreparation(), requestToC(), and ~MSDevice_ToC().

◆ myRecoverAwarenessCommand

WrappingCommand<MSDevice_ToC>* MSDevice_ToC::myRecoverAwarenessCommand
private

◆ myRecoveryRate

double MSDevice_ToC::myRecoveryRate
private

Definition at line 209 of file MSDevice_ToC.h.

Referenced by awarenessRecoveryStep(), getParameter(), MSDevice_ToC(), and setParameter().

◆ myResponseTime

SUMOTime MSDevice_ToC::myResponseTime
private

Definition at line 207 of file MSDevice_ToC.h.

Referenced by getParameter(), MSDevice_ToC(), requestToC(), and setParameter().

◆ myState

ToCState MSDevice_ToC::myState
private

Current state of the device.

Definition at line 226 of file MSDevice_ToC.h.

Referenced by getParameter(), MRMExecutionStep(), MSDevice_ToC(), requestToC(), setParameter(), setState(), setVehicleColor(), and ToCPreparationStep().

◆ myTriggerMRMCommand

WrappingCommand<MSDevice_ToC>* MSDevice_ToC::myTriggerMRMCommand
private

Definition at line 236 of file MSDevice_ToC.h.

Referenced by descheduleMRM(), requestToC(), and ~MSDevice_ToC().

◆ myTriggerToCCommand

WrappingCommand<MSDevice_ToC>* MSDevice_ToC::myTriggerToCCommand
private

Definition at line 237 of file MSDevice_ToC.h.

Referenced by descheduleToC(), requestToC(), and ~MSDevice_ToC().

◆ myUseColorScheme

bool MSDevice_ToC::myUseColorScheme
private

Whether a coloring scheme shall by applied to indicate the different toc stages,.

See also
initColorScheme()

Definition at line 223 of file MSDevice_ToC.h.

Referenced by setState().


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