Ignition Rendering

API Reference

6.3.1

Storage map from std::string to template class T. More...

#include <ignition/rendering/Storage.hh>

Public Member Functions
virtual	~Map ()
	Destructor. More...

virtual bool	ContainsKey (const std::string &_key) const =0
	Determine if an elements is mapped to the given key. More...

virtual bool	ContainsValue (ConstTPtr _value) const =0
	Determine if the given element exists in this map. More...

virtual TPtr	Get (const std::string &_key) const =0
	Get the element mapped to the given key. More...

virtual TPtr	GetByIndex (unsigned int _index) const =0
	Get the element at the given index. More...

virtual bool	Put (const std::string &_key, TPtr _value)=0
	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)=0
	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)=0
	Remove the given element. If the given element does not exist no work will be done. More...

virtual void	RemoveAll ()=0
	Remove all elements from this map. More...

virtual unsigned int	Size () const =0
	Get the number of elements in this map. More...

Detailed Description

template<class T>
class ignition::rendering::Map< T >

Storage map from std::string to template class T.

Template Parameters

T	The storage element type

Constructor & Destructor Documentation

◆ ~Map()

virtual ~Map ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ ContainsKey()

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

pure virtual

Determine if an elements is mapped to the given key.

Parameters

[in] _key Key of the element in question

Returns: True if an elements is mapped to the given key

Implemented in BaseMap< T, U >, and BaseMap< Material, T >.

Referenced by Map< Material >::~Map().

◆ ContainsValue()

virtual bool ContainsValue ( ConstTPtr _value ) const

pure virtual

Determine if the given element exists in this map.

Parameters

[in] _value Element in question

Returns: True if the given element exists in this map

Implemented in BaseMap< T, U >, and BaseMap< Material, T >.

Referenced by Map< Material >::~Map().

◆ Get()

virtual TPtr Get ( const std::string & _key ) const

pure virtual

Get the element mapped to the given key.

Parameters

[in] _key Key of the element in question

Returns: The element mapped to the given key

Implemented in BaseMap< T, U >, and BaseMap< Material, T >.

Referenced by Map< Material >::~Map().

◆ GetByIndex()

virtual TPtr GetByIndex ( unsigned int _index ) const

pure virtual

Get the element at the given index.

Parameters

[in] _index Index of the element in question

Returns: The element at the given index

Implemented in BaseMap< T, U >, and BaseMap< Material, T >.

Referenced by Map< Material >::~Map(), and Store< Sensor >::~Store().

◆ Put()

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

pure virtual

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

Parameters

[in]	_key	Key of the new element
[in]	_value	Element to be mapped

Returns: True if successful

Implemented in BaseMap< T, U >, and BaseMap< Material, T >.

Referenced by Map< Material >::~Map().

◆ Remove() [1/2]

virtual void Remove ( const std::string & _key )

pure virtual

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

Parameters

[in] _key Key of the element in question

Implemented in BaseMap< T, U >, and BaseMap< Material, T >.

Referenced by Map< Material >::~Map(), and Store< Sensor >::~Store().

◆ Remove() [2/2]

virtual void Remove ( TPtr _value )

pure virtual

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

Parameters

[in] _value Key of the element in question

Implemented in BaseMap< T, U >, and BaseMap< Material, T >.

◆ RemoveAll()

virtual void RemoveAll ( )

pure virtual

Remove all elements from this map.

Implemented in BaseMap< T, U >, and BaseMap< Material, T >.

Referenced by Map< Material >::~Map(), and Store< Sensor >::~Store().

◆ Size()

virtual unsigned int Size ( ) const

pure virtual

Get the number of elements in this map.

Returns: The number of elements in this map

Implemented in BaseMap< T, U >, and BaseMap< Material, T >.

Referenced by Map< Material >::~Map(), and Store< Sensor >::~Store().

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

Storage.hh