RTT::internal::ChannelDataElement< T > Class Template Reference

#include <ChannelDataElement.hpp>

Inheritance diagram for RTT::internal::ChannelDataElement< T >:

Public Types
typedef base::ChannelElement < T >::param_t	param_t
typedef base::ChannelElement < T >::param_t	param_t
typedef base::ChannelElement < T >::reference_t	reference_t
typedef base::ChannelElement < T >::reference_t	reference_t
Public Member Functions
	ChannelDataElement (typename base::DataObjectInterface< T >::shared_ptr sample)
	ChannelDataElement (typename base::DataObjectInterface< T >::shared_ptr sample)
virtual void	clear ()
virtual void	clear ()
virtual bool	data_sample (param_t sample)
virtual bool	data_sample (param_t sample)
virtual FlowStatus	read (reference_t sample, bool copy_old_data)
virtual FlowStatus	read (reference_t sample, bool copy_old_data)
virtual bool	write (param_t sample)
virtual bool	write (param_t sample)
Private Attributes
base::DataObjectInterface< T > ::shared_ptr	data
bool	mread
bool	written

Detailed Description

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

A connection element that stores a single data sample

Definition at line 50 of file install/include/rtt/internal/ChannelDataElement.hpp.

Member Typedef Documentation

template<typename T>

typedef base::ChannelElement<T>::param_t RTT::internal::ChannelDataElement< T >::param_t

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

Definition at line 56 of file rtt/internal/ChannelDataElement.hpp.

template<typename T>

typedef base::ChannelElement<T>::param_t RTT::internal::ChannelDataElement< T >::param_t

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

Definition at line 56 of file install/include/rtt/internal/ChannelDataElement.hpp.

template<typename T>

typedef base::ChannelElement<T>::reference_t RTT::internal::ChannelDataElement< T >::reference_t

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

Definition at line 57 of file rtt/internal/ChannelDataElement.hpp.

template<typename T>

typedef base::ChannelElement<T>::reference_t RTT::internal::ChannelDataElement< T >::reference_t

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

Definition at line 57 of file install/include/rtt/internal/ChannelDataElement.hpp.

Constructor & Destructor Documentation

template<typename T>

RTT::internal::ChannelDataElement< T >::ChannelDataElement ( typename base::DataObjectInterface< T >::shared_ptr sample ) [inline]

Definition at line 59 of file install/include/rtt/internal/ChannelDataElement.hpp.

template<typename T>

RTT::internal::ChannelDataElement< T >::ChannelDataElement ( typename base::DataObjectInterface< T >::shared_ptr sample ) [inline]

Definition at line 59 of file rtt/internal/ChannelDataElement.hpp.

Member Function Documentation

template<typename T>

virtual void RTT::internal::ChannelDataElement< T >::clear ( ) [inline, virtual]

Resets the stored sample. After clear() has been called, read() returns false

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 97 of file rtt/internal/ChannelDataElement.hpp.

template<typename T>

virtual void RTT::internal::ChannelDataElement< T >::clear ( ) [inline, virtual]

Resets the stored sample. After clear() has been called, read() returns false

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 97 of file install/include/rtt/internal/ChannelDataElement.hpp.

template<typename T>

virtual bool RTT::internal::ChannelDataElement< T >::data_sample ( param_t sample ) [inline, virtual]

Provides a data sample to initialize this connection. This is used before the first write() in order to inform this connection of the size of the data. As such enough storage space can be allocated before the actual writing begins.

Returns:: false if an error occured that requires the channel to be invalidated.

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

Definition at line 104 of file rtt/internal/ChannelDataElement.hpp.

template<typename T>

virtual bool RTT::internal::ChannelDataElement< T >::data_sample ( param_t sample ) [inline, virtual]

Provides a data sample to initialize this connection. This is used before the first write() in order to inform this connection of the size of the data. As such enough storage space can be allocated before the actual writing begins.