Ignition Rendering

API Reference

6.3.1

#include <BaseStorage.hh>

Public Member Functions

 BaseMap ()
 
virtual ~BaseMap ()
 
virtual bool ContainsKey (const std::string &_key) const
 Determine if an elements is mapped to the given key. More...
 
virtual bool ContainsValue (ConstTPtr _value) const
 Determine if the given element exists in this map. More...
 
virtual UPtr Derived (const std::string &_key) const
 
virtual UPtr DerivedByIndex (unsigned int _index) const
 
virtual TPtr Get (const std::string &_key) const
 Get the element mapped to the given key. More...
 
virtual TPtr GetByIndex (unsigned int _index) const
 Get the element at the given index. More...
 
virtual bool Put (const std::string &_key, TPtr _value)
 Map to given element to the given key. If the given key is already in use, no work will be done. More...
 
virtual void Remove (const std::string &_key)
 Remove the element mapped to the given key. If the specified element does not exists, no work will be done. More...
 
virtual void Remove (TPtr _value)
 Remove the given element. If the given element does not exist no work will be done. More...
 
virtual void RemoveAll ()
 Remove all elements from this map. More...
 
virtual unsigned int Size () const
 Get the number of elements in this map. More...
 
- Public Member Functions inherited from Map< T >
virtual ~Map ()
 Destructor. More...
 

Protected Member Functions

virtual bool IsValidIter (ConstUIter _iter) const
 

Protected Attributes

UMap map
 

Constructor & Destructor Documentation

◆ BaseMap()

BaseMap ( )

◆ ~BaseMap()

~BaseMap ( )
virtual

Member Function Documentation

◆ ContainsKey()

bool ContainsKey ( const std::string _key) const
virtual

Determine if an elements is mapped to the given key.

Parameters
[in]_keyKey of the element in question
Returns
True if an elements is mapped to the given key

Implements Map< T >.

Referenced by BaseMap< Material, T >::Put().

◆ ContainsValue()

bool ContainsValue ( ConstTPtr  _value) const
virtual

Determine if the given element exists in this map.

Parameters
[in]_valueElement in question
Returns
True if the given element exists in this map

Implements Map< T >.

◆ Derived()

BaseMap< T, U >::UPtr Derived ( const std::string _key) const
virtual

◆ DerivedByIndex()

BaseMap< T, U >::UPtr DerivedByIndex ( unsigned int  _index) const
virtual

◆ Get()

BaseMap< T, U >::TPtr Get ( const std::string _key) const
virtual

Get the element mapped to the given key.

Parameters
[in]_keyKey of the element in question
Returns
The element mapped to the given key

Implements Map< T >.

◆ GetByIndex()

BaseMap< T, U >::TPtr GetByIndex ( unsigned int  _index) const
virtual

Get the element at the given index.

Parameters
[in]_indexIndex of the element in question
Returns
The element at the given index

Implements Map< T >.

◆ IsValidIter()

◆ Put()

bool Put ( const std::string _key,
TPtr  _value 
)
virtual

Map to given element to the given key. If the given key is already in use, no work will be done.

Parameters
[in]_keyKey of the new element
[in]_valueElement to be mapped
Returns
True if successful

Implements Map< T >.

◆ Remove() [1/2]

void Remove ( const std::string _key)
virtual

Remove the element mapped to the given key. If the specified element does not exists, no work will be done.

Parameters
[in]_keyKey of the element in question

Implements Map< T >.

◆ Remove() [2/2]

void Remove ( TPtr  _value)
virtual

Remove the given element. If the given element does not exist no work will be done.

Parameters
[in]_valueKey of the element in question

Implements Map< T >.

◆ RemoveAll()

void RemoveAll ( )
virtual

Remove all elements from this map.

Implements Map< T >.

◆ Size()

unsigned int Size ( ) const
virtual

Get the number of elements in this map.

Returns
The number of elements in this map

Implements Map< T >.

Referenced by BaseStore< Sensor, T >::ConstIterByIndex(), BaseMap< Material, T >::DerivedByIndex(), and BaseStore< Sensor, T >::DestroyAll().

Member Data Documentation

◆ map


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