#include <ChannelBufferElement.hpp>

Inheritance diagram for RTT::internal::ChannelBufferElement< 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
	ChannelBufferElement (typename base::BufferInterface< T >::shared_ptr buffer, const ConnPolicy &policy=ConnPolicy())

virtual void	clear ()

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

virtual value_t	data_sample ()

virtual size_t	getBufferFillSize () const

virtual size_t	getBufferSize () const

virtual const ConnPolicy *	getConnPolicy () const

virtual std::string	getElementName () const

virtual size_t	getNumDroppedSamples () const

virtual FlowStatus	read (reference_t sample, bool copy_old_data)

virtual WriteStatus	write (param_t sample)

virtual	~ChannelBufferElement ()

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 ()

Public Member Functions inherited from RTT::internal::ChannelBufferElementBase
virtual	~ChannelBufferElementBase ()

Private Attributes
base::BufferInterface< T >::shared_ptr	buffer

base::ChannelElement< T >::value_t *	last_sample_p

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::ChannelBufferElement< T >

A connection element that can store a fixed number of data samples.

Definition at line 60 of file ChannelBufferElement.hpp.

Member Typedef Documentation

template<typename T>

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

Definition at line 68 of file ChannelBufferElement.hpp.

template<typename T>

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

Definition at line 69 of file ChannelBufferElement.hpp.

template<typename T>

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

Definition at line 67 of file ChannelBufferElement.hpp.

Constructor & Destructor Documentation

template<typename T>

RTT::internal::ChannelBufferElement< T >::ChannelBufferElement	(	typename base::BufferInterface< T >::shared_ptr	buffer,
		const ConnPolicy &	policy = `ConnPolicy()`
	)

inline

Definition at line 71 of file ChannelBufferElement.hpp.

template<typename T>

virtual RTT::internal::ChannelBufferElement< T >::~ChannelBufferElement ( )

inlinevirtual

Definition at line 74 of file ChannelBufferElement.hpp.

Member Function Documentation

template<typename T>

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

inlinevirtual

Removes all elements in the FIFO. After a call to clear(), read() will always return false (provided write() has not been called in the meantime).

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 140 of file ChannelBufferElement.hpp.

template<typename T>

virtual WriteStatus RTT::internal::ChannelBufferElement< 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.