hpcl_rtt::ConnInputEndpoint< T > Class Template Reference

#include <conn_input_endpoint.hpp>

Inheritance diagram for hpcl_rtt::ConnInputEndpoint< T >:

List of all members.

Public Member Functions
	ConnInputEndpoint (ConnectionBasePtr port)
virtual void	disconnect (bool forward)
virtual bool	inputReady ()
virtual FlowStatus	read (typename ChannelElement< T >::reference_t sample)
	~ConnInputEndpoint ()
Private Attributes
ConnectionBasePtr	port

---

Detailed Description

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

This is a channel element that represents the input endpoint of a connection, i.e. the part that is connected to the OutputPort

Definition at line 13 of file conn_input_endpoint.hpp.

---

Constructor & Destructor Documentation

template<typename T >

hpcl_rtt::ConnInputEndpoint< T >::ConnInputEndpoint

(

ConnectionBasePtr

port

)

[inline]

Definition at line 18 of file conn_input_endpoint.hpp.

template<typename T >

hpcl_rtt::ConnInputEndpoint< T >::~ConnInputEndpoint

(

)

[inline]

Definition at line 20 of file conn_input_endpoint.hpp.

---

Member Function Documentation

template<typename T >

virtual void hpcl_rtt::ConnInputEndpoint< 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 38 of file conn_input_endpoint.hpp.

template<typename T >

virtual bool hpcl_rtt::ConnInputEndpoint< T >::inputReady

(

)

[inline, virtual]

This is called by an input port when it is ready to receive data. Each channel element has the responsibility to pass this notification on to the next, in the direction of the output.

Returns:

false if a fatal connection failure was encountered and the channel needs to be destroyed.

Reimplemented from hpcl_rtt::ChannelElementBase.

Definition at line 33 of file conn_input_endpoint.hpp.

template<typename T >

virtual FlowStatus hpcl_rtt::ConnInputEndpoint< T >::read

(

typename ChannelElement< T >::reference_t

sample

)

[inline, virtual]

Reads a new sample from this connection This should never be called, as all connections are supposed to have a data storage element

Definition at line 30 of file conn_input_endpoint.hpp.

---

Member Data Documentation

template<typename T >

ConnectionBasePtr hpcl_rtt::ConnInputEndpoint< T >::port [private]

Definition at line 15 of file conn_input_endpoint.hpp.

---

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

• conn_input_endpoint.hpp