SUMO - Simulation of Urban MObility
MSSOTLPolicyDesirability Class Referenceabstract

This class determines the desirability algorithm of a MSSOTLPolicy when used in combination with a high level policy. More...

#include <MSSOTLPolicyDesirability.h>

Inheritance diagram for MSSOTLPolicyDesirability:
Inheritance graph
Collaboration diagram for MSSOTLPolicyDesirability:
Collaboration graph

Public Member Functions

void clearParameter ()
 Clears the parameter map. More...
 
virtual double computeDesirability (double vehInMeasure, double vehOutMeasure)=0
 Calculates the desirability of the policy. More...
 
virtual double computeDesirability (double vehInMeasure, double vehOutMeasure, double vehInDispersionMeasure, double vehOutDispersionMeasure)=0
 Calculates the desirability of the policy. More...
 
double getDouble (const std::string &key, const double defaultValue) const
 Returns the value for a given key converted to a double. More...
 
std::string getKeyPrefix ()
 
const std::map< std::string, std::string > & getMap () const
 Returns the inner key/value map. More...
 
virtual std::string getMessage ()=0
 
const std::string getParameter (const std::string &key, const std::string &defaultValue="") const
 Returns the value for a given key. More...
 
bool knowsParameter (const std::string &key) const
 Returns whether the parameter is known. More...
 
 MSSOTLPolicyDesirability (std::string keyPrefix, const std::map< std::string, std::string > &parameters)
 
void setKeyPrefix (std::string val)
 
void setParameter (const std::string &key, const std::string &value)
 Sets a parameter. More...
 
void unsetParameter (const std::string &key)
 Removes a parameter. More...
 
void updateParameter (const std::map< std::string, std::string > &mapArg)
 Adds or updates all given parameters from the map. More...
 
void writeParams (OutputDevice &out) const
 
virtual ~MSSOTLPolicyDesirability ()
 

Protected Member Functions

double readParameter (std::string parName, double defValue)
 

Private Attributes

std::string myKeyPrefix
 

Detailed Description

This class determines the desirability algorithm of a MSSOTLPolicy when used in combination with a high level policy.

Definition at line 42 of file MSSOTLPolicyDesirability.h.

Constructor & Destructor Documentation

◆ MSSOTLPolicyDesirability()

MSSOTLPolicyDesirability::MSSOTLPolicyDesirability ( std::string  keyPrefix,
const std::map< std::string, std::string > &  parameters 
)

Definition at line 22 of file MSSOTLPolicyDesirability.cpp.

Referenced by readParameter().

◆ ~MSSOTLPolicyDesirability()

MSSOTLPolicyDesirability::~MSSOTLPolicyDesirability ( )
virtual

Definition at line 28 of file MSSOTLPolicyDesirability.cpp.

Referenced by readParameter().

Member Function Documentation

◆ clearParameter()

void Parameterised::clearParameter ( )
inherited

Clears the parameter map.

Definition at line 97 of file Parameterised.cpp.

References Parameterised::myMap.

◆ computeDesirability() [1/2]

virtual double MSSOTLPolicyDesirability::computeDesirability ( double  vehInMeasure,
double  vehOutMeasure 
)
pure virtual

Calculates the desirability of the policy.

Implemented in MSSOTLPolicy5DStimulus, and MSSOTLPolicy5DFamilyStimulus.

Referenced by MSSOTLPolicy::computeDesirability(), and readParameter().

◆ computeDesirability() [2/2]

virtual double MSSOTLPolicyDesirability::computeDesirability ( double  vehInMeasure,
double  vehOutMeasure,
double  vehInDispersionMeasure,
double  vehOutDispersionMeasure 
)
pure virtual

Calculates the desirability of the policy.

Implemented in MSSOTLPolicy5DStimulus, and MSSOTLPolicy5DFamilyStimulus.

◆ getDouble()

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

Returns the value for a given key converted to a double.

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 87 of file Parameterised.cpp.

References TplConvert::_2double(), and Parameterised::myMap.

Referenced by MSDevice_Battery::buildVehicleDevices().

◆ getKeyPrefix()

◆ getMap()

◆ getMessage()

virtual std::string MSSOTLPolicyDesirability::getMessage ( )
pure virtual

◆ getParameter()

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

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

Definition at line 77 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by MSTLLogicControl::WAUTSwitchProcedure_Stretch::adaptLogic(), NBEdge::addRestrictedLane(), MSDevice_Battery::buildVehicleDevices(), MSDevice_Bluelight::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), MSDevice::equippedByDefaultAssignmentOptions(), MSSOTLTrafficLightLogic::getDecayConstant(), MSDevice_SSM::getDetectionRange(), MSDevice_SSM::getExtraTime(), MSTLLogicControl::WAUTSwitchProcedure::getGSPValue(), MSSOTLTrafficLightLogic::getInputSensorsLength(), MSDevice_SSM::getMeasuresAndThresholds(), MSSOTLRequestPolicy::getMinDecisionalPhaseDuration(), MSSOTLRequestTrafficLightLogic::getMinDecisionalPhaseDuration(), MSSOTLTrafficLightLogic::getMode(), MSDevice_SSM::getOutputFilename(), MSSOTLTrafficLightLogic::getOutputSensorsLength(), libsumo::Edge::getParameter(), libsumo::Polygon::getParameter(), libsumo::Route::getParameter(), libsumo::POI::getParameter(), libsumo::TrafficLight::getParameter(), libsumo::VehicleType::getParameter(), libsumo::Person::getParameter(), libsumo::Lane::getParameter(), libsumo::Vehicle::getParameter(), MSSOTLTrafficLightLogic::getSpeedThreshold(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::getStretchAreaNo(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::getStretchBereichDef(), MSSOTLTrafficLightLogic::getThreshold(), MSTriggeredRerouter::getWeight(), PushButtonLogic::init(), MSSOTLPhasePolicy::init(), SigmoidLogic::init(), MSSOTLTrafficLightLogic::init(), MSSwarmTrafficLightLogic::init(), NIImporter_OpenStreetMap::insertEdge(), MSSOTLTrafficLightLogic::isDecayThresholdActivated(), MSSOTLTrafficLightLogic::isPushButtonPressed(), libsumo::Helper::moveToXYMap(), MSActuatedTrafficLightLogic::MSActuatedTrafficLightLogic(), MSDelayBasedTrafficLightLogic::MSDelayBasedTrafficLightLogic(), MSSOTLPolicy::MSSOTLPolicy(), MSSOTLPolicy5DFamilyStimulus::MSSOTLPolicy5DFamilyStimulus(), MSSwarmTrafficLightLogic::MSSwarmTrafficLightLogic(), readParameter(), MSDevice_SSM::requestsTrajectories(), NBEdgeCont::splitAt(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::stretchLogic(), MSDevice_SSM::useGeoCoords(), and NWWriter_DlrNavteq::writeLinksUnsplitted().

◆ knowsParameter()

◆ readParameter()

◆ setKeyPrefix()

◆ setParameter()

◆ unsetParameter()

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

Removes a parameter.

Parameters
[in]keyThe parameter's name

Definition at line 57 of file Parameterised.cpp.

References Parameterised::myMap.

◆ updateParameter()

void Parameterised::updateParameter ( const std::map< std::string, std::string > &  mapArg)
inherited

Adds or updates all given parameters from the map.

Parameters
[in]mapArgThe keys/values to insert

Definition at line 63 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by NIImporter_SUMO::_loadNetwork(), PCLoaderOSM::addPOI(), PCLoaderOSM::addPolygon(), NLJunctionControlBuilder::closeJunction(), NBTrafficLightDefinition::compute(), and NIImporter_OpenStreetMap::insertEdge().

◆ writeParams()

Field Documentation

◆ myKeyPrefix

std::string MSSOTLPolicyDesirability::myKeyPrefix
private

Definition at line 45 of file MSSOTLPolicyDesirability.h.

Referenced by getKeyPrefix().


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