micros_rtt::ChannelDataElement< T > Class Template Reference

#include <channel_data_element.hpp>

Inheritance diagram for micros_rtt::ChannelDataElement< T >:

List of all members.

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

---

Detailed Description

template<typename T>
class micros_rtt::ChannelDataElement< T >

A connection element that stores a single data sample

Definition at line 30 of file channel_data_element.hpp.

---

Member Typedef Documentation

template<typename T>

typedef ChannelElement<T>::param_t micros_rtt::ChannelDataElement< T >::param_t

Reimplemented from micros_rtt::ChannelElement< T >.

Definition at line 36 of file channel_data_element.hpp.

template<typename T>

typedef ChannelElement<T>::reference_t micros_rtt::ChannelDataElement< T >::reference_t

Reimplemented from micros_rtt::ChannelElement< T >.

Definition at line 37 of file channel_data_element.hpp.

---

Constructor & Destructor Documentation

template<typename T>

micros_rtt::ChannelDataElement< T >::ChannelDataElement

(

typename DataObjectLockFree< T >::shared_ptr

sample

)

[inline]

Definition at line 39 of file channel_data_element.hpp.

---

Member Function Documentation

template<typename T>

virtual void micros_rtt::ChannelDataElement< T >::clear

(

)

[inline, virtual]

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

Reimplemented from micros_rtt::ChannelElementBase.

Definition at line 77 of file channel_data_element.hpp.

template<typename T>

virtual bool micros_rtt::ChannelDataElement< T >::data_sample

(

param_t

sample

)

[inline, virtual]

Definition at line 84 of file channel_data_element.hpp.

template<typename T>

virtual T micros_rtt::ChannelDataElement< T >::data_sample

(

)

[inline, virtual]

Reimplemented from micros_rtt::ChannelElement< T >.

Definition at line 90 of file channel_data_element.hpp.

template<typename T>

virtual FlowStatus micros_rtt::ChannelDataElement< T >::read	(	reference_t	sample,
		bool	copy_old_data
	)		[inline, virtual]

Reads the last sample given to write()

Returns:

false if no sample has ever been written, true otherwise

Definition at line 56 of file channel_data_element.hpp.

template<typename T>

virtual bool micros_rtt::ChannelDataElement< T >::write

(

param_t

sample

)

[inline, virtual]

Update the data sample stored in this element. It always returns true.

Definition at line 44 of file channel_data_element.hpp.

---

Member Data Documentation

template<typename T>

DataObjectLockFree<T>::shared_ptr micros_rtt::ChannelDataElement< T >::data [private]

Definition at line 33 of file channel_data_element.hpp.

template<typename T>

bool micros_rtt::ChannelDataElement< T >::mread [private]

Definition at line 32 of file channel_data_element.hpp.

template<typename T>

bool micros_rtt::ChannelDataElement< T >::written [private]

Definition at line 32 of file channel_data_element.hpp.

---

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

• channel_data_element.hpp