#include <ChannelDataElement.hpp>

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

Public Types
typedef base::ChannelElement< T >::param_t	param_t

typedef base::ChannelElement< T >::reference_t	reference_t

typedef base::ChannelElement< T >::value_t	value_t

Public Types inherited from RTT::base::ChannelElement< T >
typedef boost::call_traits< T >::param_type	param_t

typedef boost::call_traits< T >::reference	reference_t

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

typedef T	value_t

Public Types inherited from RTT::base::ChannelElementBase
typedef boost::intrusive_ptr< ChannelElementBase >	shared_ptr

Public Member Functions
	ChannelDataElement (typename base::DataObjectInterface< T >::shared_ptr sample, const ConnPolicy &policy=ConnPolicy())

virtual void	clear ()

virtual WriteStatus	data_sample (param_t sample, bool reset=true)

virtual value_t	data_sample ()

virtual const ConnPolicy *	getConnPolicy () const

virtual std::string	getElementName () const

virtual FlowStatus	read (reference_t sample, bool copy_old_data)

virtual WriteStatus	write (param_t sample)

Public Member Functions inherited from RTT::base::ChannelElement< T >
shared_ptr	getInput ()

shared_ptr	getOutput ()

Public Member Functions inherited from RTT::base::ChannelElementBase
	ChannelElementBase ()

virtual bool	channelReady (ChannelElementBase::shared_ptr const &caller, ConnPolicy const &policy, internal::ConnID *conn_id=0)

virtual bool	connected ()

virtual bool	connectFrom (ChannelElementBase::shared_ptr const &input)

virtual bool	connectTo (ChannelElementBase::shared_ptr const &output, bool mandatory=true)

virtual void	disconnect (bool forward)

virtual bool	disconnect (ChannelElementBase::shared_ptr const &channel, bool forward)

shared_ptr	getInput ()

virtual shared_ptr	getInputEndPoint ()

virtual std::string	getLocalURI () const

shared_ptr	getOutput ()

virtual shared_ptr	getOutputEndPoint ()

virtual PortInterface *	getPort () const

virtual std::string	getRemoteURI () const

virtual bool	inputReady (ChannelElementBase::shared_ptr const &caller)

virtual bool	isRemoteElement () const

template<typename T >
ChannelElement< T > *	narrow ()

RTT_DEPRECATED void	setInput (const ChannelElementBase::shared_ptr &input)

RTT_DEPRECATED void	setOutput (const ChannelElementBase::shared_ptr &output)

virtual bool	signal ()

virtual bool	signalFrom (ChannelElementBase *)

virtual	~ChannelElementBase ()

Private Attributes
base::DataObjectInterface< T >::shared_ptr	data

const ConnPolicy	policy

Additional Inherited Members
Static Public Member Functions inherited from RTT::base::ChannelElementBase
template<typename T >
static ChannelElement< T > *	narrow (ChannelElementBase *e)

Protected Member Functions inherited from RTT::base::ChannelElementBase
virtual bool	addInput (shared_ptr const &input)

virtual bool	addOutput (shared_ptr const &output, bool mandatory=true)

void	deref ()

void	ref ()

virtual void	removeInput (shared_ptr const &input)

virtual void	removeOutput (shared_ptr const &output)

Protected Attributes inherited from RTT::base::ChannelElementBase
shared_ptr	input

RTT::os::SharedMutex	input_lock

shared_ptr	output

RTT::os::SharedMutex	output_lock

Detailed Description

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

A connection element that stores a single data sample

Definition at line 51 of file ChannelDataElement.hpp.

Member Typedef Documentation

template<typename T>

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

Definition at line 58 of file ChannelDataElement.hpp.

template<typename T>

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

Definition at line 59 of file ChannelDataElement.hpp.

template<typename T>

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

Definition at line 57 of file ChannelDataElement.hpp.

Constructor & Destructor Documentation

template<typename T>

RTT::internal::ChannelDataElement< T >::ChannelDataElement	(	typename base::DataObjectInterface< T >::shared_ptr	sample,
		const ConnPolicy &	policy = `ConnPolicy()`
	)

inline

Definition at line 61 of file ChannelDataElement.hpp.

Member Function Documentation

template<typename T>

virtual void RTT::internal::ChannelDataElement< T >::clear ( )

inlinevirtual

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

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 84 of file ChannelDataElement.hpp.

template<typename T>

virtual WriteStatus RTT::internal::ChannelDataElement< T >::data_sample	(	param_t	sample,
		bool	reset = `true`
	)

inlinevirtual

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.