SUMO - Simulation of Urban MObility
Parameterised Class Reference

An upper class for objects with additional parameters. More...

#include <Parameterised.h>

Inheritance diagram for Parameterised:
Inheritance graph
Collaboration diagram for Parameterised:
Collaboration graph

Public Member Functions

void addParameter (const std::string &key, const std::string &value)
 Adds a parameter. More...
 
void addParameter (const std::map< std::string, std::string > &mapArg)
 Adds all given parameter. More...
 
void addParameter (const Parameterised &p)
 Adds all given parameter. More...
 
void clearParameter ()
 Clears the parameter map. More...
 
double getDouble (const std::string &key, const double defaultValue) const
 Returns the value for a given key converted to a double. More...
 
const std::map< std::string, std::string > & getMap () const
 Returns the inner key/value map. More...
 
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...
 
 Parameterised ()
 Constructor. More...
 
 Parameterised (const std::map< std::string, std::string > &mapArg)
 Constructor. More...
 
void writeParams (OutputDevice &out) const
 
 ~Parameterised ()
 Destructor. More...
 

Private Attributes

std::map< std::string, std::string > myMap
 The key->value map. More...
 

Detailed Description

An upper class for objects with additional parameters.

Definition at line 51 of file Parameterised.h.

Constructor & Destructor Documentation

◆ Parameterised() [1/2]

Parameterised::Parameterised ( )

Constructor.

Definition at line 39 of file Parameterised.cpp.

◆ Parameterised() [2/2]

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

Constructor.

Parameters
[in]mapArgPre-given parameter

Definition at line 45 of file Parameterised.cpp.

◆ ~Parameterised()

Parameterised::~Parameterised ( )

Destructor.

Definition at line 42 of file Parameterised.cpp.

Member Function Documentation

◆ addParameter() [1/3]

◆ addParameter() [2/3]

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

Adds all given parameter.

Parameters
[in]mapArgThe keys/values to insert

Definition at line 57 of file Parameterised.cpp.

References myMap.

◆ addParameter() [3/3]

void Parameterised::addParameter ( const Parameterised p)

Adds all given parameter.

Parameters
[in]pThe keys/values to insert

Definition at line 65 of file Parameterised.cpp.

References myMap.

◆ clearParameter()

void Parameterised::clearParameter ( )

Clears the parameter map.

Definition at line 99 of file Parameterised.cpp.

References myMap.

◆ getDouble()

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

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

References TplConvert::_2double(), and myMap.

Referenced by MSDevice_Battery::buildVehicleDevices().

◆ getMap()

const std::map<std::string, std::string>& Parameterised::getMap ( ) const
inline

◆ getParameter()

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

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

References myMap.

Referenced by MSTLLogicControl::WAUTSwitchProcedure_Stretch::adaptLogic(), MSDevice_Battery::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), MSDevice::equippedByDefaultAssignmentOptions(), MSSOTLTrafficLightLogic::getDecayConstant(), MSDevice_SSM::getDetectionRange(), MSTLLogicControl::WAUTSwitchProcedure::getGSPValue(), MSSOTLTrafficLightLogic::getInputSensorsLength(), MSDevice_SSM::getLoggingFrequency(), MSDevice_SSM::getMeasuresAndThresholds(), MSSOTLRequestPolicy::getMinDecisionalPhaseDuration(), MSSOTLRequestTrafficLightLogic::getMinDecisionalPhaseDuration(), MSSOTLTrafficLightLogic::getMode(), MSDevice_SSM::getOutputFilename(), MSSOTLTrafficLightLogic::getOutputSensorsLength(), TraCI_Polygon::getParameter(), TraCI_VehicleType::getParameter(), TraCI_Route::getParameter(), TraCI_POI::getParameter(), TraCI_Lane::getParameter(), TraCI_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(), MSActuatedTrafficLightLogic::MSActuatedTrafficLightLogic(), MSDelayBasedTrafficLightLogic::MSDelayBasedTrafficLightLogic(), MSSOTLPolicy::MSSOTLPolicy(), MSSOTLPolicy5DFamilyStimulus::MSSOTLPolicy5DFamilyStimulus(), MSSwarmTrafficLightLogic::MSSwarmTrafficLightLogic(), TraCIServerAPI_Edge::processGet(), TraCIServerAPI_TLS::processGet(), TraCIServerAPI_Person::processGet(), MSSOTLPolicyDesirability::readParameter(), MSDevice_SSM::requestsTrajectories(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::stretchLogic(), TraCIServerAPI_Vehicle::vtdMap(), and NWWriter_DlrNavteq::writeLinksUnsplitted().

◆ knowsParameter()

bool Parameterised::knowsParameter ( const std::string &  key) const

◆ writeParams()

Field Documentation

◆ myMap

std::map<std::string, std::string> Parameterised::myMap
private

The key->value map.

Definition at line 128 of file Parameterised.h.

Referenced by addParameter(), clearParameter(), getDouble(), getMap(), getParameter(), knowsParameter(), and writeParams().


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