NamedObjectCont< T > Class Template Reference

A map of named object pointers. More...

#include <NamedObjectCont.h>

Public Types
typedef std::map< std::string, T >	IDMap
	Definition of the key to pointer map type.

Public Member Functions
bool	add (const std::string &id, T item)
	Adds an item.
IDMap::const_iterator	begin () const
	Returns a reference to the begin iterator for the internal map.
bool	changeID (const std::string &oldId, const std::string &newId)
	change ID of a stored object
void	clear ()
	Removes all items from the container (deletes them, too).
IDMap::const_iterator	end () const
	Returns a reference to the end iterator for the internal map.
T	get (const std::string &id) const
	Retrieves an item.
void	insertIDs (std::vector< std::string > &into) const
	NamedObjectCont ()
	Constructor.
bool	remove (const std::string &id, const bool del=true)
	Removes an item.
int	size () const
	Returns the number of stored items within the container.
virtual	~NamedObjectCont ()
	Destructor.

Private Attributes
IDMap	myMap
	The map from key to object.

Detailed Description

template<class T>
class NamedObjectCont< T >

A map of named object pointers.

An associative storage (map) for objects (pointers to them to be exact), which do have a name.

Definition at line 41 of file NamedObjectCont.h.

Member Typedef Documentation

IDMap

template<class T>

typedef std::map< std::string, T > NamedObjectCont< T >::IDMap

Definition of the key to pointer map type.

Definition at line 44 of file NamedObjectCont.h.

Constructor & Destructor Documentation

NamedObjectCont()

template<class T>

NamedObjectCont< T >::NamedObjectCont ( )

inline

Constructor.

Definition at line 47 of file NamedObjectCont.h.

~NamedObjectCont()

template<class T>

virtual NamedObjectCont< T >::~NamedObjectCont ( )

inlinevirtual

Destructor.

Definition at line 50 of file NamedObjectCont.h.

Member Function Documentation

add()

template<class T>

bool NamedObjectCont< T >::add ( const std::string & id, T item )

inline

Adds an item.

If another item with the same name is already known, false is reported and the item is not added.

Parameters

[in]	id	The id of the item to add
[in]	item	The item to add

Returns

If the item could be added (no item with the same id was within the container before)

Definition at line 66 of file NamedObjectCont.h.

begin()

template<class T>

IDMap::const_iterator NamedObjectCont< T >::begin ( ) const

inline

Returns a reference to the begin iterator for the internal map.

Definition at line 146 of file NamedObjectCont.h.

Referenced by NLBuilder::build(), NWWriter_OpenDrive::mapmatchRoadObjects(), and GUIViewTraffic::onGamingClick().

Here is the caller graph for this function:

changeID()

template<class T>

bool NamedObjectCont< T >::changeID ( const std::string & oldId, const std::string & newId )

inline

change ID of a stored object

Definition at line 132 of file NamedObjectCont.h.

clear()

template<class T>

void NamedObjectCont< T >::clear ( )

inline

Removes all items from the container (deletes them, too).

Definition at line 110 of file NamedObjectCont.h.

end()

template<class T>

IDMap::const_iterator NamedObjectCont< T >::end ( ) const

inline

Returns a reference to the end iterator for the internal map.

Definition at line 151 of file NamedObjectCont.h.

Referenced by NLBuilder::build(), NWWriter_OpenDrive::mapmatchRoadObjects(), and GUIViewTraffic::onGamingClick().

Here is the caller graph for this function:

get()

template<class T>

T NamedObjectCont< T >::get ( const std::string & id ) const

inline

Retrieves an item.

Returns 0 when no item with the given id is stored within the container

Parameters

[in]

id

The id of the item to retrieve

Returns

The item stored under the given id, or 0 if no such item exists

Definition at line 100 of file NamedObjectCont.h.

Referenced by LIBSUMO_NAMESPACE::POI::add(), LIBSUMO_NAMESPACE::Polygon::add(), MSDevice_FCD::buildShapeFilter(), LIBSUMO_NAMESPACE::Polygon::exists(), LIBSUMO_NAMESPACE::InductionLoop::getDetector(), LIBSUMO_NAMESPACE::LaneArea::getDetector(), LIBSUMO_NAMESPACE::MultiEntryExit::getDetector(), LIBSUMO_NAMESPACE::Junction::getJunction(), LIBSUMO_NAMESPACE::InductionLoop::getMEDetector(), LIBSUMO_NAMESPACE::POI::getPoI(), LIBSUMO_NAMESPACE::Polygon::getPolygon(), LIBSUMO_NAMESPACE::RouteProbe::getRouteProbe(), MSActuatedTrafficLightLogic::init(), MSDelayBasedTrafficLightLogic::init(), NEMALogic::init(), MSDevice_SSM::initEdgeFilter(), PCLoaderVisum::load(), PCLoaderDlrNavteq::loadPolyFile(), NLTriggerBuilder::parseAndBuildCalibrator(), LIBSUMO_NAMESPACE::POI::remove(), LIBSUMO_NAMESPACE::Polygon::remove(), MSActuatedTrafficLightLogic::retrieveDetExpression(), NWWriter_OpenDrive::writeNetwork(), NWWriter_OpenDrive::writeRoadObjects(), and NWWriter_OpenDrive::writeSignals().

Here is the caller graph for this function:

insertIDs()

template<class T>

void NamedObjectCont< T >::insertIDs ( std::vector< std::string > & into ) const

inline

Definition at line 125 of file NamedObjectCont.h.

remove()

template<class T>

bool NamedObjectCont< T >::remove ( const std::string & id, const bool del = true )

inline

Removes an item.

Parameters

[in]	id	The id of the item to remove
[in]	del	delete item after removing of container

Returns

If the item could be removed (an item with the id was within the container before)

Definition at line 80 of file NamedObjectCont.h.

size()

template<class T>

int NamedObjectCont< T >::size ( ) const

inline

Returns the number of stored items within the container.

Definition at line 118 of file NamedObjectCont.h.

Referenced by MSDevice_FCD::buildShapeFilter(), main(), and NWWriter_OpenDrive::mapmatchRoadObjects().

Here is the caller graph for this function:

Field Documentation

myMap

template<class T>

IDMap NamedObjectCont< T >::myMap

private

The map from key to object.

Definition at line 158 of file NamedObjectCont.h.

---

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

• NamedObjectCont.h