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

List container value type. More...

#include <DataTypes.h>

Inheritance diagram for RobotRaconteur::RRList< T >:
RobotRaconteur::RRValue

Public Types

typedef boost::intrusive_ptr< T > value_type
typedef std::list< boost::intrusive_ptr< T > >::pointer pointer
typedef std::list< boost::intrusive_ptr< T > >::const_pointer const_pointer
typedef std::list< boost::intrusive_ptr< T > >::reference reference
typedef std::list< boost::intrusive_ptr< T > >::const_reference const_reference
typedef std::list< boost::intrusive_ptr< T > >::size_type size_type
typedef std::list< boost::intrusive_ptr< T > >::difference_type difference_type
typedef std::list< boost::intrusive_ptr< T > >::iterator iterator
typedef std::list< boost::intrusive_ptr< T > >::const_iterator const_iterator
typedef std::list< boost::intrusive_ptr< T > >::reverse_iterator reverse_iterator
typedef std::list< boost::intrusive_ptr< T > >::const_reverse_iterator const_reverse_iterator

Public Member Functions

iterator begin ()
 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 end () const
 returns an iterator to the end
reverse_iterator rbegin ()
 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
const_iterator cbegin () const
 returns an iterator to the beginning
const_iterator cend () const
 returns an iterator to the end
const_reverse_iterator const crbegin ()
 returns a reverse iterator to the beginning
const_reverse_iterator const crend ()
 returns a reverse iterator to the end
bool empty () const
 checks whether the container is empty
virtual size_type size () const
 returns the number of elements
size_type max_size () const
 returns the maximum possible number of elements
reference front ()
 access the first element
const_reference front () const
 access the first element
reference back ()
 access the last element
const_reference back () const
 access the last element
void push_front (const boost::intrusive_ptr< T > &x)
 inserts an element at the beginning
void push_back (const boost::intrusive_ptr< T > &x)
 adds an element to the end
void pop_front ()
 removes the first element
void pop_back ()
 removes the last element
iterator insert (const_iterator p, const boost::intrusive_ptr< T > &x)
 inserts element
iterator erase (const_iterator p)
 erases element
iterator erase (const_iterator first, const_iterator last)
 erases element
void clear ()
 clears the contents
void remove (const boost::intrusive_ptr< T > &value)
 removes elements equal to value
std::list< boost::intrusive_ptr< T > > & GetStorageContainer ()
 Get the underlying storage container.

Detailed Description

template<typename T>
class RobotRaconteur::RRList< T >

List container value type.

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

Template Parameters
TStored value type. Must extend RRValue

Member Typedef Documentation

◆ const_iterator

template<typename T>
typedef std::list<boost::intrusive_ptr<T>>::const_iterator RobotRaconteur::RRList< T >::const_iterator

◆ const_pointer

template<typename T>
typedef std::list<boost::intrusive_ptr<T>>::const_pointer RobotRaconteur::RRList< T >::const_pointer

◆ const_reference

template<typename T>
typedef std::list<boost::intrusive_ptr<T>>::const_reference RobotRaconteur::RRList< T >::const_reference

◆ const_reverse_iterator

template<typename T>
typedef std::list<boost::intrusive_ptr<T>>::const_reverse_iterator RobotRaconteur::RRList< T >::const_reverse_iterator

◆ difference_type

template<typename T>
typedef std::list<boost::intrusive_ptr<T>>::difference_type RobotRaconteur::RRList< T >::difference_type

◆ iterator

template<typename T>
typedef std::list<boost::intrusive_ptr<T>>::iterator RobotRaconteur::RRList< T >::iterator

iterator

◆ pointer

template<typename T>
typedef std::list<boost::intrusive_ptr<T>>::pointer RobotRaconteur::RRList< T >::pointer

pointer

◆ reference

template<typename T>
typedef std::list<boost::intrusive_ptr<T>>::reference RobotRaconteur::RRList< T >::reference

reference

◆ reverse_iterator

template<typename T>
typedef std::list<boost::intrusive_ptr<T>>::reverse_iterator RobotRaconteur::RRList< T >::reverse_iterator

◆ size_type

template<typename T>
typedef std::list<boost::intrusive_ptr<T>>::size_type RobotRaconteur::RRList< T >::size_type

◆ value_type

template<typename T>
typedef boost::intrusive_ptr<T> RobotRaconteur::RRList< T >::value_type

Member Function Documentation

◆ GetStorageContainer()

template<typename T>
std::list< boost::intrusive_ptr< T > > & RobotRaconteur::RRList< T >::GetStorageContainer ( )
inline

Get the underlying storage container.

WARNING: this may change, use with caution!

Returns
std::list<RR_INTRUSIVE_PTR<T> >&

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