RTT::internal::ConnInputEndpoint< T > Class Template Reference

#include <ConnInputEndPoint.hpp>

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

Public Types
typedef base::MultipleOutputsChannelElement< T >	Base
typedef boost::intrusive_ptr< ConnInputEndpoint< T > >	shared_ptr
Public Types inherited from RTT::base::MultipleOutputsChannelElement< T >
typedef ChannelElement< T >::param_t	param_t
typedef ChannelElement< T >::reference_t	reference_t
typedef boost::intrusive_ptr< MultipleInputsChannelElement< T > >	shared_ptr
typedef ChannelElement< T >::value_t	value_t
Public Types inherited from RTT::base::MultipleOutputsChannelElementBase
typedef std::list< Output >	Outputs
typedef boost::intrusive_ptr< MultipleOutputsChannelElementBase >	shared_ptr
Public Types inherited from RTT::base::ChannelElementBase
typedef boost::intrusive_ptr< ChannelElementBase >	shared_ptr
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 Member Functions
	ConnInputEndpoint (OutputPort< T > *port)
virtual bool	disconnect (const base::ChannelElementBase::shared_ptr &channel, bool forward)
std::string	getElementName () const
virtual base::ChannelElementBase::shared_ptr	getInputEndPoint ()
virtual base::PortInterface *	getPort () const
virtual base::ChannelElement< T >::shared_ptr	getSharedBuffer ()
base::ChannelElement< T >::shared_ptr	getWriteEndpoint ()
virtual bool	inputReady (base::ChannelElementBase::shared_ptr const &)
	~ConnInputEndpoint ()
Public Member Functions inherited from RTT::base::MultipleOutputsChannelElement< T >
virtual WriteStatus	data_sample (param_t sample, bool reset=true)
virtual WriteStatus	write (param_t sample)
Public Member Functions inherited from RTT::base::MultipleOutputsChannelElementBase
virtual bool	channelReady (ChannelElementBase::shared_ptr const &caller, ConnPolicy const &policy, internal::ConnID *conn_id=0)
virtual bool	connected ()
	MultipleOutputsChannelElementBase ()
virtual bool	signal ()
Public Member Functions inherited from RTT::base::ChannelElementBase
	ChannelElementBase ()
virtual void	clear ()
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 const ConnPolicy *	getConnPolicy () const
shared_ptr	getInput ()
virtual std::string	getLocalURI () const
shared_ptr	getOutput ()
virtual shared_ptr	getOutputEndPoint ()
virtual std::string	getRemoteURI () const
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	signalFrom (ChannelElementBase *)
virtual	~ChannelElementBase ()
Public Member Functions inherited from RTT::base::ChannelElement< T >
virtual value_t	data_sample ()
shared_ptr	getInput ()
shared_ptr	getOutput ()
virtual FlowStatus	read (reference_t sample, bool copy_old_data=true)

Private Attributes
OutputPort< T > *	port

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::MultipleOutputsChannelElementBase
virtual bool	addOutput (ChannelElementBase::shared_ptr const &output, bool mandatory=true)
void	removeDisconnectedOutputs ()
virtual void	removeOutput (ChannelElementBase::shared_ptr const &output)
Protected Member Functions inherited from RTT::base::ChannelElementBase
virtual bool	addInput (shared_ptr const &input)
void	deref ()
void	ref ()
virtual void	removeInput (shared_ptr const &input)
Protected Attributes inherited from RTT::base::MultipleOutputsChannelElementBase
Outputs	outputs
RTT::os::SharedMutex	outputs_lock
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::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 52 of file ConnInputEndPoint.hpp.

Member Typedef Documentation

template<typename T>

typedef base::MultipleOutputsChannelElement<T> RTT::internal::ConnInputEndpoint< T >::Base

Definition at line 58 of file ConnInputEndPoint.hpp.

template<typename T>

typedef boost::intrusive_ptr<ConnInputEndpoint<T> > RTT::internal::ConnInputEndpoint< T >::shared_ptr

Definition at line 59 of file ConnInputEndPoint.hpp.

Constructor & Destructor Documentation

template<typename T>

RTT::internal::ConnInputEndpoint< T >::ConnInputEndpoint ( OutputPort< T > *  port )

inline

Definition at line 61 of file ConnInputEndPoint.hpp.

template<typename T>

RTT::internal::ConnInputEndpoint< T >::~ConnInputEndpoint ( )

inline

Definition at line 64 of file ConnInputEndPoint.hpp.

Member Function Documentation

template<typename T>

virtual bool RTT::internal::ConnInputEndpoint< T >::disconnect ( const base::ChannelElementBase::shared_ptr &  channel, bool  forward  )

inlinevirtual

Overridden implementation of ChannelElementBase::disconnect(forward, channel).

Reimplemented from RTT::base::MultipleOutputsChannelElementBase.

Definition at line 73 of file ConnInputEndPoint.hpp.

template<typename T>

std::string RTT::internal::ConnInputEndpoint< T >::getElementName ( ) const

inlinevirtual

Returns the class name of this element. This is primary useful for special case handling in the connection tracking.

Returns

The name of the class of the ChannelElement

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 124 of file ConnInputEndPoint.hpp.

template<typename T>

virtual base::ChannelElementBase::shared_ptr RTT::internal::ConnInputEndpoint< T >::getInputEndPoint ( )

inlinevirtual

Returns the first input channel element of this connection. Will return the channel element the furthest away from the input port, or this if none.

Returns

getInput() ? getInput()->getInputEndPoint() : this

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 104 of file ConnInputEndPoint.hpp.

template<typename T>

virtual base::PortInterface* RTT::internal::ConnInputEndpoint< T >::getPort ( ) const

inlinevirtual

Gets the port this channel element is connected to.

Returns

null if no port is connected to this element, the port (or a proxy representing the port) otherwise.

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 100 of file ConnInputEndPoint.hpp.

template<typename T>

virtual base::ChannelElement<T>::shared_ptr RTT::internal::ConnInputEndpoint< T >::getSharedBuffer ( )

inlinevirtual

Definition at line 109 of file ConnInputEndPoint.hpp.

template<typename T>

base::ChannelElement<T>::shared_ptr RTT::internal::ConnInputEndpoint< T >::getWriteEndpoint ( )

inline

Definition at line 114 of file ConnInputEndPoint.hpp.

template<typename T>

virtual bool RTT::internal::ConnInputEndpoint< T >::inputReady ( base::ChannelElementBase::shared_ptr const &  caller )

inlinevirtual

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 RTT::base::ChannelElementBase.

Definition at line 67 of file ConnInputEndPoint.hpp.

Member Data Documentation

template<typename T>

OutputPort<T>* RTT::internal::ConnInputEndpoint< T >::port

private

Definition at line 55 of file ConnInputEndPoint.hpp.

---

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

• ConnInputEndPoint.hpp