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

pod array value type More...

#include <DataTypes.h>

Inheritance diagram for RobotRaconteur::RRPodArray< T >:
RobotRaconteur::RRPodBaseArray RobotRaconteur::RRValue

Public Types

typedef T value_type
typedef std::vector< T >::pointer pointer
typedef std::vector< T >::const_pointer const_pointer
typedef std::vector< T >::reference reference
typedef std::vector< T >::const_reference const_reference
typedef std::vector< T >::size_type size_type
typedef std::vector< T >::iterator iterator
typedef std::vector< T >::const_iterator const_iterator
typedef std::vector< T >::reverse_iterator reverse_iterator
typedef std::vector< T >::const_reverse_iterator const_reverse_iterator

Public Member Functions

iterator begin ()
 returns an iterator to the beginning
const_iterator begin () const
 retuns 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 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
reference operator[] (size_type i)
 access the specified element
const_reference operator[] (size_type i) const
 access the specified element
reference at (size_type i)
 access the specified element with bounds checking
const_reference at (size_type i) const
 access the specified element with bounds checking
T * data ()
 direct access to the underlying array
const T * data () const
 direct access to the underlying array
std::vector< T > & GetStorageContainer ()
 Get the underlying storage container.

Detailed Description

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

pod array value type

This class stores a pod array. Pod arrays should always be allocated using AllocateEmptyRRPodArray()

T must be a pod type that has been generated as part of the thunk source.

RRPodArray must be stored in RR_INTRUSIVE_PTR. It will be deleted automatically when the reference count goes to zero.

Template Parameters
TThe type of the array elements

Member Typedef Documentation

◆ const_iterator

template<typename T>
typedef std::vector<T>::const_iterator RobotRaconteur::RRPodArray< T >::const_iterator

◆ const_pointer

template<typename T>
typedef std::vector<T>::const_pointer RobotRaconteur::RRPodArray< T >::const_pointer

◆ const_reference

template<typename T>
typedef std::vector<T>::const_reference RobotRaconteur::RRPodArray< T >::const_reference

◆ const_reverse_iterator

template<typename T>
typedef std::vector<T>::const_reverse_iterator RobotRaconteur::RRPodArray< T >::const_reverse_iterator

◆ iterator

template<typename T>
typedef std::vector<T>::iterator RobotRaconteur::RRPodArray< T >::iterator

iterator

◆ pointer

template<typename T>
typedef std::vector<T>::pointer RobotRaconteur::RRPodArray< T >::pointer

pointer

◆ reference

template<typename T>
typedef std::vector<T>::reference RobotRaconteur::RRPodArray< T >::reference

reference

◆ reverse_iterator

template<typename T>
typedef std::vector<T>::reverse_iterator RobotRaconteur::RRPodArray< T >::reverse_iterator

◆ size_type

template<typename T>
typedef std::vector<T>::size_type RobotRaconteur::RRPodArray< T >::size_type

◆ value_type

template<typename T>
typedef T RobotRaconteur::RRPodArray< T >::value_type

Member Function Documentation

◆ GetStorageContainer()

template<typename T>
std::vector< T > & RobotRaconteur::RRPodArray< T >::GetStorageContainer ( )
inline

Get the underlying storage container.

WARNING: this may change, use with caution!

Returns
std::vector<T>&

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