SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Parameterised Class Reference

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

#include <Parameterised.h>

Inheritance diagram for Parameterised:
MSEdge MSLane MSRoute MSTrafficLightLogic NBEdge PointOfInterest SUMO::Polygon SUMOVehicleParameter SUMOVTypeParameter

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...
 
 ~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 46 of file Parameterised.h.

Constructor & Destructor Documentation

Parameterised::Parameterised ( )

Constructor.

Definition at line 41 of file Parameterised.cpp.

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

Constructor.

Parameters
[in]mapArgPre-given parameter

Definition at line 47 of file Parameterised.cpp.

Parameterised::~Parameterised ( )

Destructor.

Definition at line 44 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 53 of file Parameterised.cpp.

References myMap.

Referenced by NLHandler::addParam(), SUMORouteHandler::addParam(), PCLoaderOSM::addPOI(), PCLoaderOSM::addPolygon(), and NIImporter_MATSim::EdgesHandler::myStartElement().

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

References myMap.

void Parameterised::clearParameter ( )

Clears the parameter map.

Definition at line 91 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 106 of file Parameterised.h.

References myMap.

Referenced by PCPolyContainer::save().

const std::string & Parameterised::getParameter ( const std::string &  key,
const std::string &  defaultValue 
) const
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 75 of file Parameterised.cpp.

References myMap.

Referenced by MSDevice_Example::buildVehicleDevices(), and TraCIServerAPI_Vehicle::vtdMap_matchingNearest().

Field Documentation

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

The key->value map.

Definition at line 113 of file Parameterised.h.

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


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