SUMO - Simulation of Urban MObility
Public Member Functions | Private Attributes
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...
 
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::Parameterised ( )

Constructor.

Definition at line 42 of file Parameterised.cpp.

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

Constructor.

Parameters
[in]mapArgPre-given parameter

Definition at line 48 of file Parameterised.cpp.

Parameterised::~Parameterised ( )

Destructor.

Definition at line 45 of file Parameterised.cpp.

Member Function Documentation

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

Adds a parameter.

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

Definition at line 54 of file Parameterised.cpp.

References myMap.

Referenced by SUMORouteHandler::addParam(), NLHandler::addParam(), PCLoaderOSM::addPOI(), PCLoaderOSM::addPolygon(), NBTrafficLightDefinition::compute(), NIImporter_OpenStreetMap::insertEdge(), NIImporter_OpenDrive::loadNetwork(), MSStateHandler::myStartElement(), NIImporter_MATSim::EdgesHandler::myStartElement(), NIImporter_OpenStreetMap::EdgesHandler::myStartElement(), TraCIServerAPI_Edge::processSet(), TraCIServerAPI_TLS::processSet(), TraCIServerAPI_Polygon::processSet(), TraCIServerAPI_POI::processSet(), and TraCIServerAPI_Lane::processSet().

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

References myMap.

void Parameterised::addParameter ( const Parameterised &  p)

Adds all given parameter.

Parameters
[in]pThe keys/values to insert

Definition at line 68 of file Parameterised.cpp.

References myMap.

void Parameterised::clearParameter ( )

Clears the parameter map.

Definition at line 92 of file Parameterised.cpp.

References myMap.

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

Returns the inner key/value map.

Returns
the inner map

Definition at line 111 of file Parameterised.h.

References myMap, and writeParams().

Referenced by NBTrafficLightDefinition::compute(), GUIPerson::getParameterWindow(), GUIMEVehicle::getTypeParameterWindow(), GUIVehicle::getTypeParameterWindow(), TraCIServerAPI_TLS::processGet(), ROPerson::saveAsXML(), and PointOfInterest::writeXML().

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

References myMap.

Referenced by MSTLLogicControl::WAUTSwitchProcedure_Stretch::adaptLogic(), MSDevice_Battery::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), MSDevice::equippedByDefaultAssignmentOptions(), MSSOTLTrafficLightLogic::getDecayConstant(), MSTLLogicControl::WAUTSwitchProcedure::getGSPValue(), MSSOTLTrafficLightLogic::getInputSensorsLength(), MSSOTLRequestPolicy::getMinDecisionalPhaseDuration(), MSSOTLRequestTrafficLightLogic::getMinDecisionalPhaseDuration(), MSSOTLTrafficLightLogic::getMode(), MSSOTLTrafficLightLogic::getOutputSensorsLength(), MSSOTLTrafficLightLogic::getSpeedThreshold(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::getStretchAreaNo(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::getStretchBereichDef(), MSSOTLTrafficLightLogic::getThreshold(), MSTriggeredRerouter::getWeight(), PushButtonLogic::init(), MSSOTLPhasePolicy::init(), SigmoidLogic::init(), MSSOTLTrafficLightLogic::init(), MSSwarmTrafficLightLogic::init(), MSSOTLTrafficLightLogic::isDecayThresholdActivated(), MSSOTLTrafficLightLogic::isPushButtonPressed(), MSActuatedTrafficLightLogic::MSActuatedTrafficLightLogic(), MSDelayBasedTrafficLightLogic::MSDelayBasedTrafficLightLogic(), MSSOTLPolicy::MSSOTLPolicy(), MSSOTLPolicy5DFamilyStimulus::MSSOTLPolicy5DFamilyStimulus(), MSSwarmTrafficLightLogic::MSSwarmTrafficLightLogic(), TraCIServerAPI_Edge::processGet(), TraCIServerAPI_TLS::processGet(), TraCIServerAPI_Polygon::processGet(), TraCIServerAPI_VehicleType::processGet(), TraCIServerAPI_Route::processGet(), TraCIServerAPI_POI::processGet(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Person::processGet(), TraCIServerAPI_Lane::processGet(), MSSOTLPolicyDesirability::readParameter(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::stretchLogic(), TraCIServerAPI_Vehicle::vtdMap(), and NWWriter_DlrNavteq::writeLinksUnsplitted().

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

Returns whether the parameter is known.

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

Definition at line 76 of file Parameterised.cpp.

References myMap.

Referenced by MSDevice_Example::buildVehicleDevices(), MSDevice::equippedByDefaultAssignmentOptions(), NWWriter_DlrNavteq::getBrunnelType(), and MSTriggeredRerouter::getWeight().

void Parameterised::writeParams ( OutputDevice &  out) const

Definition at line 97 of file Parameterised.cpp.

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

Referenced by getMap(), ROVehicle::saveAsXML(), MSVehicle::saveState(), SUMOVTypeParameter::write(), MSDevice_Vehroutes::writeOutput(), and SUMO::Polygon::writeXML().

Field Documentation

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

The key->value map.

Definition at line 120 of file Parameterised.h.

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

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