Robot Raconteur Core C++ Library
Loading...
Searching...
No Matches
RobotRaconteur::RRMap< K, T > Class Template Reference

Map container value type. More...

#include <DataTypes.h>

Inheritance diagram for RobotRaconteur::RRMap< K, T >:
RobotRaconteur::RRValue

Public Types

typedef std::map< K, boost::intrusive_ptr< T > >::key_type key_type
typedef std::map< K, boost::intrusive_ptr< T > >::mapped_type mapped_type
typedef std::map< K, boost::intrusive_ptr< T > >::value_type value_type
typedef std::map< K, boost::intrusive_ptr< T > >::pointer pointer
typedef std::map< K, boost::intrusive_ptr< T > >::const_pointer const_pointer
typedef std::map< K, boost::intrusive_ptr< T > >::reference reference
typedef std::map< K, boost::intrusive_ptr< T > >::const_reference const_reference
typedef std::map< K, boost::intrusive_ptr< T > >::size_type size_type
typedef std::map< K, boost::intrusive_ptr< T > >::iterator iterator
typedef std::map< K, boost::intrusive_ptr< T > >::const_iterator const_iterator
typedef std::map< K, boost::intrusive_ptr< T > >::reverse_iterator reverse_iterator
typedef std::map< K, boost::intrusive_ptr< T > >::const_reverse_iterator const_reverse_iterator

Public Member Functions

iterator begin ()
 returns an iterator to the beginning
const_iterator cbegin () const
 returns an iterator to the beginning
const_iterator begin () const
 returns an iterator to the beginning
iterator end ()
 returns an iterator to the end
const_iterator cend () const
 returns an iterator to the end
const_iterator end () const
 returns an iterator to the end
reverse_iterator rbegin ()
 returns a reverse iterator to the beginning
const_reverse_iterator crbegin () const
 returns a reverse iterator to the beginning
const_reverse_iterator rbegin () const
 returns a reverse iterator to the beginning
reverse_iterator rend ()
 returns a reverse iterator to the end
const_reverse_iterator crend () const
 returns a reverse iterator to the end
const_reverse_iterator rend () const
 returns a reverse iterator to the end
bool empty () const
 checks whether the container is empty
size_type size () const
 returns the number of elements
size_type max_size () const
 returns the maximum possible number of elements
mapped_typeoperator[] (const key_type &k)
 access or insert the specified element
mapped_typeat (const key_type &k)
 access specified element with bounds checking
const mapped_typeat (const key_type &k) const
 access specified element with bounds checking
std::pair< iterator, bool > insert (const value_type &x)
 inserts elements
iterator insert (const_iterator p, const value_type &x)
 inserts elements
template<class InputIterator>
void insert (InputIterator first, InputIterator last)
 inserts elements
void erase (iterator p)
 erases element
size_type erase (const key_type &x)
 erases element
void erase (iterator first, iterator last)
 erases element
void clear ()
 clears the contents
iterator find (const key_type &x)
 finds element with the specified key
const_iterator find (const key_type &x) const
 finds element with the specified key
size_type count (const key_type &x) const
 returns the number of elemnts matching the specified key
std::map< K, boost::intrusive_ptr< T > > & GetStorageContainer ()
 Get the underlying storage container.

Detailed Description

template<typename K, typename T>
class RobotRaconteur::RRMap< K, T >

Map container value type.

Implementation of map container types for Robot Raconteur. Must be stored using RR_INTRUSIVE_PTR. Use AllocateEmptyRRMap() to allocate. It will be deleted automatically when the reference count goes to zero.

Template Parameters
KMap key type. Must be int32_t or std::string
TStored value type. Must extend RRValue

Member Typedef Documentation

◆ const_iterator

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::const_iterator RobotRaconteur::RRMap< K, T >::const_iterator

◆ const_pointer

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::const_pointer RobotRaconteur::RRMap< K, T >::const_pointer

◆ const_reference

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::const_reference RobotRaconteur::RRMap< K, T >::const_reference

◆ const_reverse_iterator

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::const_reverse_iterator RobotRaconteur::RRMap< K, T >::const_reverse_iterator

◆ iterator

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::iterator RobotRaconteur::RRMap< K, T >::iterator

iterator

◆ key_type

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::key_type RobotRaconteur::RRMap< K, T >::key_type

◆ mapped_type

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::mapped_type RobotRaconteur::RRMap< K, T >::mapped_type

◆ pointer

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::pointer RobotRaconteur::RRMap< K, T >::pointer

pointer

◆ reference

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::reference RobotRaconteur::RRMap< K, T >::reference

reference

◆ reverse_iterator

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::reverse_iterator RobotRaconteur::RRMap< K, T >::reverse_iterator

◆ size_type

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::size_type RobotRaconteur::RRMap< K, T >::size_type

◆ value_type

template<typename K, typename T>
typedef std::map<K,boost::intrusive_ptr<T>>::value_type RobotRaconteur::RRMap< K, T >::value_type

Member Function Documentation

◆ GetStorageContainer()

template<typename K, typename T>
std::map< K, boost::intrusive_ptr< T > > & RobotRaconteur::RRMap< K, T >::GetStorageContainer ( )
inline

Get the underlying storage container.

WARNING: this may change, use with caution!

Returns
std::map<K, RR_INTRUSIVE_PTR<T> >&

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