Public Types | Public Member Functions | Private Attributes
RTT::base::DataObjectUnSync< T > Class Template Reference

A class which provides unprotected (not thread-safe) access to one typed element of data. More...

#include <DataObjectUnSync.hpp>

Inheritance diagram for RTT::base::DataObjectUnSync< T >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef T DataType

Public Member Functions

virtual void data_sample (const DataType &sample)
virtual T data_sample () const
 DataObjectUnSync (const T &initial_value=T())
virtual void Get (DataType &pull) const
virtual DataType Get () const
virtual void Set (const DataType &push)

Private Attributes

data

Detailed Description

template<class T>
class RTT::base::DataObjectUnSync< T >

A class which provides unprotected (not thread-safe) access to one typed element of data.

Definition at line 55 of file DataObjectUnSync.hpp.


Member Typedef Documentation

template<class T >
typedef T RTT::base::DataObjectUnSync< T >::DataType

The type of the data.

Reimplemented from RTT::base::DataObjectInterface< T >.

Definition at line 74 of file DataObjectUnSync.hpp.


Constructor & Destructor Documentation

template<class T >
RTT::base::DataObjectUnSync< T >::DataObjectUnSync ( const T &  initial_value = T()) [inline]

Construct a DataObjectUnSync by name.

Parameters:
_nameThe name of this DataObject.

Definition at line 68 of file DataObjectUnSync.hpp.


Member Function Documentation

template<class T >
virtual void RTT::base::DataObjectUnSync< T >::data_sample ( const DataType sample) [inline, virtual]

Provides a data sample to initialize this data object. As such enough storage space can be allocated before the actual writing begins.

Parameters:
sample

Implements RTT::base::DataObjectInterface< T >.

Definition at line 82 of file DataObjectUnSync.hpp.

template<class T >
virtual T RTT::base::DataObjectUnSync< T >::data_sample ( ) const [inline, virtual]

Definition at line 86 of file DataObjectUnSync.hpp.

template<class T >
virtual void RTT::base::DataObjectUnSync< T >::Get ( DataType pull) const [inline, virtual]

Get a copy of the Data of this data object.

Parameters:
pullA copy of the data.

Implements RTT::base::DataObjectInterface< T >.

Definition at line 76 of file DataObjectUnSync.hpp.

template<class T >
virtual DataType RTT::base::DataObjectUnSync< T >::Get ( ) const [inline, virtual]

Get a copy of the data of this data object.

Returns:
A copy of the data.

Implements RTT::base::DataObjectInterface< T >.

Definition at line 78 of file DataObjectUnSync.hpp.

template<class T >
virtual void RTT::base::DataObjectUnSync< T >::Set ( const DataType push) [inline, virtual]

Set the data to a certain value.

Parameters:
pushThe data which must be set.

Implements RTT::base::DataObjectInterface< T >.

Definition at line 80 of file DataObjectUnSync.hpp.


Member Data Documentation

template<class T >
T RTT::base::DataObjectUnSync< T >::data [private]

One element of Data.

Definition at line 61 of file DataObjectUnSync.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