Public Types | Public Member Functions | Protected Attributes
RTT::internal::ArrayDataSource< T > Class Template Reference

#include <DataSources.hpp>

Inheritance diagram for RTT::internal::ArrayDataSource< T >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef boost::intrusive_ptr
< ArrayDataSource< T > > 
shared_ptr

Public Member Functions

 ArrayDataSource (std::size_t size=0)
 ArrayDataSource (T const &odata)
virtual ArrayDataSource< T > * clone () const
virtual ArrayDataSource< T > * copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &replace) const
DataSource< T >::result_t get () const
void newArray (std::size_t size)
AssignableDataSource< T >
::const_reference_t 
rvalue () const
void set (typename AssignableDataSource< T >::param_t t)
AssignableDataSource< T >
::reference_t 
set ()
DataSource< T >::result_t value () const
 ~ArrayDataSource ()

Protected Attributes

marray
T::value_type * mdata

Detailed Description

template<typename T>
class RTT::internal::ArrayDataSource< T >

A DataSource that holds a fixed size array, using the types::carray class.

Parameters:
TA carray<U>

Definition at line 324 of file DataSources.hpp.


Member Typedef Documentation

template<typename T>
typedef boost::intrusive_ptr<ArrayDataSource<T> > RTT::internal::ArrayDataSource< T >::shared_ptr

Use this type to store a pointer to an AssignableDataSource.

Reimplemented from RTT::internal::AssignableDataSource< T >.

Definition at line 337 of file DataSources.hpp.


Constructor & Destructor Documentation

template<typename T>
RTT::internal::ArrayDataSource< T >::~ArrayDataSource ( )

Use shared_ptr.

template<typename T>
RTT::internal::ArrayDataSource< T >::ArrayDataSource ( std::size_t  size = 0)

Create and allocate an Array of a fixed size. In case you create an empty/default ArrayDataSource, you can assign it an array size later-on with newArray( size )

template<typename T>
RTT::internal::ArrayDataSource< T >::ArrayDataSource ( T const &  odata)

Creates an ArrayDataSource and initializes the array with the contents of another carray. A deep copy is made from odata.


Member Function Documentation

template<typename T>
virtual ArrayDataSource<T>* RTT::internal::ArrayDataSource< T >::clone ( ) const [virtual]

Return a shallow clone of this DataSource. This method returns a duplicate of this instance which re-uses the DataSources this internal::DataSource holds reference to. The clone() function is thus a non-deep copy.

Implements RTT::internal::AssignableDataSource< T >.

template<typename T>
virtual ArrayDataSource<T>* RTT::internal::ArrayDataSource< T >::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  replace) const [virtual]
template<typename T>
DataSource<T>::result_t RTT::internal::ArrayDataSource< T >::get ( ) const [inline, virtual]

Return the data as type T.

Implements RTT::internal::DataSource< T >.

Definition at line 361 of file DataSources.hpp.

template<typename T>
void RTT::internal::ArrayDataSource< T >::newArray ( std::size_t  size)

Clears the array of this data source and creates a new one. Note that all references to this array will become invalid (types::carray may make shallow copies!) so only use this if you are sure no other object has a reference to the contained array.

template<typename T>
AssignableDataSource<T>::const_reference_t RTT::internal::ArrayDataSource< T >::rvalue ( ) const [inline, virtual]

Get a const reference to the value of this DataSource. You must call evaluate() prior to calling this function in order to get the most recent value of this attribute.

Note:
Getting a reference to an internal data structure is not thread-safe.

Implements RTT::internal::DataSource< T >.

Definition at line 378 of file DataSources.hpp.

template<typename T>
void RTT::internal::ArrayDataSource< T >::set ( typename AssignableDataSource< T >::param_t  t)
template<typename T>
AssignableDataSource<T>::reference_t RTT::internal::ArrayDataSource< T >::set ( ) [inline, virtual]

Get a reference to the value of this DataSource. Getting a reference to an internal data structure is not thread-safe.

Implements RTT::internal::AssignableDataSource< T >.

Definition at line 373 of file DataSources.hpp.

template<typename T>
DataSource<T>::result_t RTT::internal::ArrayDataSource< T >::value ( ) const [inline, virtual]

Return the result of the last evaluate() function. You must call evaluate() prior to calling this function in order to get the most recent value of this attribute.

Implements RTT::internal::DataSource< T >.

Definition at line 366 of file DataSources.hpp.


Member Data Documentation

template<typename T>
T RTT::internal::ArrayDataSource< T >::marray [protected]

Definition at line 329 of file DataSources.hpp.

template<typename T>
T::value_type* RTT::internal::ArrayDataSource< T >::mdata [protected]

Definition at line 328 of file DataSources.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Thu Jan 2 2014 11:35:43