#include <conn_output_endpoint.hpp>

Inheritance diagram for hpcl_rtt::ConnOutputEndpoint< T >:

Public Member Functions
	ConnOutputEndpoint (ConnectionBasePtr port)
virtual bool	data_sample (typename ChannelElement< T >::param_t sample)
virtual void	disconnect (bool forward)
bool	inputReady ()
virtual bool	signal ()
virtual bool	write (typename ChannelElement< T >::param_t sample)
	~ConnOutputEndpoint ()
Private Attributes
ConnectionBasePtr	port

Detailed Description

template<typename T>
class hpcl_rtt::ConnOutputEndpoint< T >

This is a channel element that represents the output endpoint of a connection, i.e. the part that is connected to the InputPort. In the RTT, connections are always created from input towards output. So this class is typically first created of the channel element chain and attached to the input port. Then we build further towards the outputport. Imagine a spider attaching a thread at one wall and moving along to the other side of the wall.

Definition at line 18 of file conn_output_endpoint.hpp.

Constructor & Destructor Documentation

template<typename T>

hpcl_rtt::ConnOutputEndpoint< T >::ConnOutputEndpoint ( ConnectionBasePtr port ) [inline]

Creates the connection end that represents the output and attach it to the input.

Parameters:

port	The start point.
output_id	Each connection must be identified by an ID that represents the other end. This id is passed to the input port port.

Returns:

Definition at line 30 of file conn_output_endpoint.hpp.

template<typename T>

hpcl_rtt::ConnOutputEndpoint< T >::~ConnOutputEndpoint ( ) [inline]

Definition at line 36 of file conn_output_endpoint.hpp.

Member Function Documentation

template<typename T>

virtual bool hpcl_rtt::ConnOutputEndpoint< T >::data_sample ( typename ChannelElement< T >::param_t sample ) [inline, virtual]

Definition at line 88 of file conn_output_endpoint.hpp.

template<typename T>

virtual void hpcl_rtt::ConnOutputEndpoint< T >::disconnect ( bool forward ) [inline, virtual]

Performs a disconnection of this channel's endpoints. If forward is true, then the disconnection is initiated by the input endpoint. Otherwise, it has been initiated by the output endpoint.

Reimplemented from hpcl_rtt::ChannelElementBase.

Definition at line 62 of file conn_output_endpoint.hpp.

template<typename T>

bool hpcl_rtt::ConnOutputEndpoint< T >::inputReady ( ) [inline, virtual]

Called by the connection factory to check that the connection is properly set up. It is called when the channel is complete, so we can register ourselves on the port side now

Before that, the channel might not be complete and therefore having the input port read on it would lead to crashes

Reimplemented from hpcl_rtt::ChannelElementBase.

Definition at line 47 of file conn_output_endpoint.hpp.

template<typename T>

virtual bool hpcl_rtt::ConnOutputEndpoint< T >::signal ( ) [inline, virtual]

Signals that there is new data available on this channel By default, the channel element forwards the call to its output

Returns:: false if an error occured that requires the channel to be invalidated. In no ways it indicates that the sample has been received by the other side of the channel.

Reimplemented from hpcl_rtt::ChannelElementBase.

Definition at line 75 of file conn_output_endpoint.hpp.

template<typename T>

virtual bool hpcl_rtt::ConnOutputEndpoint< T >::write ( typename ChannelElement< T >::param_t sample ) [inline, virtual]