ChannelElementBase variant with multiple output channels. More...

#include <rtt/base/ChannelElementBase.hpp>

Inheritance diagram for RTT::base::MultipleOutputsChannelElementBase:

Classes
struct	Output

Public Types
typedef boost::intrusive_ptr< MultipleOutputsChannelElementBase >	shared_ptr

typedef std::list< Output >	Outputs

Public Member Functions
	MultipleOutputsChannelElementBase ()

virtual bool	connected ()
	Returns true, if this channel element has at least one output, independent of whether is has an input connection or not. More...

virtual bool	signal ()
	Overridden implementation of ChannelElementBase::signal() which forwards the signal to all outputs. More...

virtual bool	channelReady (ChannelElementBase::shared_ptr const &caller, ConnPolicy const &policy, internal::ConnID *conn_id=0)
	Overridden implementation of ChannelElementBase::channelReady() which forwards the signal to all outputs. More...

virtual bool	disconnect (ChannelElementBase::shared_ptr const &channel, bool forward=false)
	Overridden implementation of ChannelElementBase::disconnect(forward, channel). More...

template<typename T >
ChannelElement< T > *	narrow ()
	Return a pointer to the typed variant of this ChannelElementBase. More...

shared_ptr	getInput ()
	Returns the current input channel element. More...

virtual shared_ptr	getInputEndPoint ()
	Returns the first input channel element of this connection. More...

shared_ptr	getOutput ()
	Returns the next channel element in the channel's propagation direction. More...

virtual shared_ptr	getOutputEndPoint ()
	Returns the last output channel element of this connection. More...

virtual bool	connectTo (ChannelElementBase::shared_ptr const &output, bool mandatory=true)
	Connects a new output to this element. More...

virtual bool	connectFrom (ChannelElementBase::shared_ptr const &input)
	Connects a new input to this element. More...

virtual bool	signalFrom (ChannelElementBase *)
	Signals that there is new data available on this channel Forwards to signal() unless overwritten in a derived class. More...

virtual bool	inputReady (ChannelElementBase::shared_ptr const &caller)
	This is called by an input port when it is ready to receive data. More...

virtual void	clear ()
	Clears any data stored by the channel. More...

virtual void	disconnect (bool forward)
	Performs a disconnection of this channel's endpoints. More...

virtual PortInterface *	getPort () const
	Gets the port this channel element is connected to. More...

virtual const ConnPolicy *	getConnPolicy () const
	Get a pointer to the connection policy used to build this channel element, if available. More...

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

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

virtual bool	isRemoteElement () const
	This function may be used to identify, if the current element uses a network transport, to send the data to the next Element in the logical chain. More...

virtual std::string	getRemoteURI () const
	This function returns the URI of the next channel element in the logical chain. More...

virtual std::string	getLocalURI () const
	This function return the URI of this element. More...

virtual std::string	getElementName () const
	Returns the class name of this element. More...

Static Public Member Functions
template<typename T >
static ChannelElement< T > *	narrow (ChannelElementBase *e)
	Return a pointer to the typed instance of a ChannelElementBase. More...

Protected Member Functions
virtual bool	addOutput (ChannelElementBase::shared_ptr const &output, bool mandatory=true)
	Sets the new output channel element of this element or adds a channel to the outputs list. More...

virtual void	removeOutput (ChannelElementBase::shared_ptr const &output)
	Remove an output from the outputs list. More...

void	removeDisconnectedOutputs ()
	Iterate over all output channels and remove the ones that have been marked as disconnected (after a failed write() or data_sample() call). More...

void	ref ()
	Increases the reference count. More...

void	deref ()
	Decreases the reference count, and deletes the object if it is zero. More...

virtual bool	addInput (shared_ptr const &input)
	Sets the new input channel element of this element or adds a channel to the inputs list. More...

virtual void	removeInput (shared_ptr const &input)
	Remove an input from the inputs list. More...

Protected Attributes
Outputs	outputs

RTT::os::SharedMutex	outputs_lock

shared_ptr	input

shared_ptr	output

RTT::os::SharedMutex	input_lock

RTT::os::SharedMutex	output_lock

Detailed Description

ChannelElementBase variant with multiple output channels.

Definition at line 392 of file ChannelElementBase.hpp.

Member Typedef Documentation

typedef std::list<Output> RTT::base::MultipleOutputsChannelElementBase::Outputs

Definition at line 403 of file ChannelElementBase.hpp.

typedef boost::intrusive_ptr<MultipleOutputsChannelElementBase> RTT::base::MultipleOutputsChannelElementBase::shared_ptr

Definition at line 395 of file ChannelElementBase.hpp.

Constructor & Destructor Documentation

MultipleOutputsChannelElementBase::MultipleOutputsChannelElementBase ( )

Definition at line 321 of file ChannelInterface.cpp.

Member Function Documentation

bool ChannelElementBase::addInput ( shared_ptr const & input )

protectedvirtualinherited

Sets the new input channel element of this element or adds a channel to the inputs list.

Parameters

input the previous element in chain.

Returns: true if the input was set or false if this element does not support multiple inputs and the input is already set.

Reimplemented in RTT::base::MultipleInputsChannelElementBase.

Definition at line 106 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::input, and RTT::base::ChannelElementBase::input_lock.

Referenced by RTT::base::ChannelElementBase::connectFrom().

bool MultipleOutputsChannelElementBase::addOutput	(	ChannelElementBase::shared_ptr const &	output,
		bool	mandatory = `true`
	)

protectedvirtual

Sets the new output channel element of this element or adds a channel to the outputs list.

Parameters

output	the next element in chain.
mandatory	whether the added output is mandatory for a write to succeed

Returns: true if the output was set or false if this element does not support multiple outputs and the output is already set.

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 335 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::output, RTT::base::MultipleOutputsChannelElementBase::Output::Output(), outputs, and outputs_lock.

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

virtual

Overridden implementation of ChannelElementBase::channelReady() which forwards the signal to all outputs.

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 365 of file ChannelInterface.cpp.

References outputs, and outputs_lock.

void ChannelElementBase::clear ( )

virtualinherited

Clears any data stored by the channel.

It means that ChannelElement::read() will return false afterwards (provided that no new data has been written on the meantime of course)

By default, the channel element forwards the calls to its input

Reimplemented in RTT::base::MultipleInputsChannelElementBase, RTT::internal::SharedConnection< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.

Definition at line 188 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::getInput(), and RTT::base::ChannelElementBase::input.

Referenced by RTT::internal::ChannelDataElement< T >::clear(), RTT::internal::ChannelBufferElement< T >::clear(), and RTT::internal::SharedConnection< T >::clear().

bool MultipleOutputsChannelElementBase::connected ( )

virtual

Returns true, if this channel element has at least one output, independent of whether is has an input connection or not.

Reimplemented from RTT::base::ChannelElementBase.

Reimplemented in RTT::base::MultipleInputsMultipleOutputsChannelElementBase.

Definition at line 350 of file ChannelInterface.cpp.

References outputs, and outputs_lock.

Referenced by RTT::internal::ConnFactory::buildChannelInput(), RTT::base::MultipleInputsMultipleOutputsChannelElementBase::connected(), and RTT::internal::ConnInputEndpoint< T >::disconnect().

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

virtualinherited

Connects a new input to this element.

Parameters

input the previous element in chain.

Definition at line 96 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::addInput(), and RTT::base::ChannelElementBase::removeInput().

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

virtualinherited

Connects a new output to this element.

Parameters

output	the next element in chain.
mandatory	whether the added output is mandatory for a write operation to succeed

Definition at line 69 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::addOutput(), and RTT::base::ChannelElementBase::removeOutput().

Referenced by RTT::internal::ConnFactory::buildChannelInput(), RTT::internal::ConnFactory::buildChannelOutput(), RTT::internal::ConnFactory::buildSharedConnection(), and RTT::internal::ConnFactory::createAndCheckSharedConnection().

void ChannelElementBase::deref ( )

protectedinherited

Decreases the reference count, and deletes the object if it is zero.

Definition at line 467 of file ChannelInterface.cpp.

References oro_atomic_dec_and_test().

Referenced by RTT::corba::RemoteChannelElement< T >::_remove_ref().

void ChannelElementBase::disconnect ( bool forward )

virtualinherited

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.

Definition at line 130 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::getInput(), RTT::base::ChannelElementBase::getOutput(), RTT::base::ChannelElementBase::input, RTT::base::ChannelElementBase::output, RTT::base::ChannelElementBase::removeInput(), and RTT::base::ChannelElementBase::removeOutput().

Referenced by RTT::corba::RemoteChannelElement< T >::disconnect(), RTT::base::MultipleInputsChannelElementBase::disconnect(), disconnect(), RTT::internal::ConnectionManager::eraseConnection(), and RTT::corba::RemoteChannelElement< T >::remoteDisconnect().

bool MultipleOutputsChannelElementBase::disconnect	(	ChannelElementBase::shared_ptr const &	channel,
		bool	forward = `false`
	)

virtual

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

Reimplemented from RTT::base::ChannelElementBase.

Reimplemented in RTT::base::MultipleInputsMultipleOutputsChannelElementBase, and RTT::internal::ConnInputEndpoint< T >.

Definition at line 374 of file ChannelInterface.cpp.

References RTT::base::MultipleOutputsChannelElementBase::Output::channel, RTT::base::ChannelElementBase::disconnect(), RTT::base::ChannelElementBase::output, outputs, outputs_lock, and removeOutput().

Referenced by RTT::internal::ConnInputEndpoint< T >::disconnect(), RTT::base::MultipleInputsMultipleOutputsChannelElementBase::disconnect(), and RTT::internal::ConnInputEndpoint< T >::inputReady().

const ConnPolicy * ChannelElementBase::getConnPolicy ( ) const

virtualinherited

Get a pointer to the connection policy used to build this channel element, if available.

This method will be overwritten for data and buffer elements.

Returns: null if there is no ConnPolicy associated with this element, a pointer to an instance of ConnPolicy otherwise.

Reimplemented in RTT::internal::ChannelBufferElement< T >, RTT::internal::ChannelDataElement< T >, and RTT::internal::SharedConnectionBase.

Definition at line 207 of file ChannelInterface.cpp.

Referenced by RTT::internal::ConnFactory::buildChannelInput(), and RTT::internal::ConnFactory::buildChannelOutput().

std::string ChannelElementBase::getElementName ( ) const

virtualinherited

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 in RTT::corba::RemoteChannelElement< T >, RTT::mqueue::MQChannelElement< T >, RTT::internal::ConnOutputEndpoint< T >, RTT::internal::ChannelBufferElement< T >, RTT::internal::ConnInputEndpoint< T >, and RTT::internal::ChannelDataElement< T >.

Definition at line 227 of file ChannelInterface.cpp.

ChannelElementBase::shared_ptr ChannelElementBase::getInput ( )

inherited

Returns the current input channel element.

This will only return a valid channel element if another element has received this object as an argument to connectTo().

Returns

Definition at line 57 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::input, and RTT::base::ChannelElementBase::input_lock.

Referenced by RTT::base::ChannelElementBase::channelReady(), RTT::base::ChannelElementBase::clear(), RTT::base::ChannelElementBase::disconnect(), RTT::base::ChannelElement< T >::getInput(), RTT::base::ChannelElementBase::getInputEndPoint(), RTT::mqueue::MQChannelElement< T >::getLocalURI(), and RTT::corba::RemoteChannelElement< T >::getLocalURI().

ChannelElementBase::shared_ptr ChannelElementBase::getInputEndPoint ( )

virtualinherited

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 in RTT::internal::ConnInputEndpoint< T >.

Definition at line 157 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::getInput(), and RTT::base::ChannelElementBase::input.

std::string ChannelElementBase::getLocalURI ( ) const

virtualinherited

This function return the URI of this element.

The URI must be unique.

Returns: URI of this element.

Reimplemented in RTT::corba::RemoteChannelElement< T >, and RTT::mqueue::MQChannelElement< T >.

Definition at line 223 of file ChannelInterface.cpp.

Referenced by RTT::mqueue::MQChannelElement< T >::getLocalURI(), and RTT::corba::RemoteChannelElement< T >::getLocalURI().

ChannelElementBase::shared_ptr ChannelElementBase::getOutput ( )

inherited

Returns the next channel element in the channel's propagation direction.

Definition at line 63 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::output, and RTT::base::ChannelElementBase::output_lock.

Referenced by RTT::base::ChannelElementBase::channelReady(), RTT::base::ChannelElementBase::disconnect(), RTT::base::ChannelElement< T >::getOutput(), RTT::base::ChannelElementBase::getOutputEndPoint(), RTT::mqueue::MQChannelElement< T >::getRemoteURI(), RTT::corba::RemoteChannelElement< T >::getRemoteURI(), and RTT::base::ChannelElementBase::signal().

ChannelElementBase::shared_ptr ChannelElementBase::getOutputEndPoint ( )

virtualinherited

Returns the last output channel element of this connection.

Will return the channel element the furthest away from the output port, or this if none.

Returns: getOutput() ? getOutput()->getOutputEndPoint() : this

Reimplemented in RTT::internal::ConnOutputEndpoint< T >.

Definition at line 163 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::getOutput(), and RTT::base::ChannelElementBase::output.

Referenced by RTT::corba::CDataFlowInterface_i::deregisterChannel().

PortInterface * ChannelElementBase::getPort ( ) const

virtualinherited

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 in RTT::internal::ConnOutputEndpoint< T >, and RTT::internal::ConnInputEndpoint< T >.

Definition at line 203 of file ChannelInterface.cpp.

std::string ChannelElementBase::getRemoteURI ( ) const

virtualinherited

This function returns the URI of the next channel element in the logical chain.

The URI must be unique. E.g: In the local case output->getLocalURI() In the remote case the URI of the remote channel element.

Returns: URI of the next element.

Reimplemented in RTT::corba::RemoteChannelElement< T >, and RTT::mqueue::MQChannelElement< T >.

Definition at line 215 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::output.

Referenced by RTT::mqueue::MQChannelElement< T >::getRemoteURI(), and RTT::corba::RemoteChannelElement< T >::getRemoteURI().

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

virtualinherited

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 in RTT::corba::RemoteChannelElement< T >, RTT::base::MultipleInputsChannelElementBase, RTT::mqueue::MQChannelElement< T >, and RTT::internal::ConnInputEndpoint< T >.

Referenced by RTT::base::ChannelElementBase::channelReady().

bool ChannelElementBase::isRemoteElement ( ) const

virtualinherited

This function may be used to identify, if the current element uses a network transport, to send the data to the next Element in the logical chain.

Returns: true if a network transport is used.

Reimplemented in RTT::corba::RemoteChannelElement< T >, and RTT::mqueue::MQChannelElement< T >.

Definition at line 211 of file ChannelInterface.cpp.

template<typename T >

static ChannelElement<T>* RTT::base::ChannelElementBase::narrow ( ChannelElementBase * e )

inlinestaticinherited

Return a pointer to the typed instance of a ChannelElementBase.

Definition at line 101 of file ChannelElementBase.hpp.

Referenced by RTT::base::MultipleInputsChannelElement< T >::read().

template<typename T >

ChannelElement<T>* RTT::base::ChannelElementBase::narrow ( )

inlineinherited

Return a pointer to the typed variant of this ChannelElementBase.

Definition at line 109 of file ChannelElementBase.hpp.

void ChannelElementBase::ref ( )

protectedinherited

Increases the reference count.

Definition at line 462 of file ChannelInterface.cpp.

References oro_atomic_inc().

Referenced by RTT::corba::RemoteChannelElement< T >::_add_ref(), and RTT::corba::RemoteChannelElement< T >::RemoteChannelElement().

void MultipleOutputsChannelElementBase::removeDisconnectedOutputs ( )

protected

Iterate over all output channels and remove the ones that have been marked as disconnected (after a failed write() or data_sample() call).

Definition at line 419 of file ChannelInterface.cpp.

References RTT::base::MultipleOutputsChannelElementBase::Output::channel, RTT::base::MultipleOutputsChannelElementBase::Output::disconnected, RTT::base::ChannelElementBase::output, outputs, outputs_lock, and removeOutput().

void ChannelElementBase::removeInput ( shared_ptr const & input )

protectedvirtualinherited

Remove an input from the inputs list.

Parameters

input the element to be removed, or null to remove unconditionally

Reimplemented in RTT::base::MultipleInputsChannelElementBase, and RTT::base::MultipleInputsChannelElement< T >.

Definition at line 115 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::input_lock.

Referenced by RTT::base::ChannelElementBase::connectFrom(), RTT::base::ChannelElementBase::disconnect(), and RTT::base::MultipleInputsChannelElementBase::disconnect().

void MultipleOutputsChannelElementBase::removeOutput ( ChannelElementBase::shared_ptr const & output )

protectedvirtual

Remove an output from the outputs list.

Parameters

output the element to be removed

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 345 of file ChannelInterface.cpp.

References outputs.

Referenced by disconnect(), and removeDisconnectedOutputs().

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

inlineinherited

Definition at line 244 of file ChannelElementBase.hpp.

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

inlineinherited

Definition at line 238 of file ChannelElementBase.hpp.

bool MultipleOutputsChannelElementBase::signal ( )

virtual

Overridden implementation of ChannelElementBase::signal() which forwards the signal to all outputs.

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 356 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::output, outputs, outputs_lock, and RTT::base::ChannelElementBase::signal().

virtual bool RTT::base::ChannelElementBase::signalFrom ( ChannelElementBase * )

inlinevirtualinherited

Signals that there is new data available on this channel Forwards to signal() unless overwritten in a derived class.

Reimplemented in RTT::base::MultipleInputsChannelElementBase.

Definition at line 173 of file ChannelElementBase.hpp.

Member Data Documentation

shared_ptr RTT::base::ChannelElementBase::input

protectedinherited

Definition at line 76 of file ChannelElementBase.hpp.

RTT::os::SharedMutex RTT::base::ChannelElementBase::input_lock

mutableprotectedinherited

Definition at line 79 of file ChannelElementBase.hpp.

Referenced by RTT::base::ChannelElementBase::addInput(), RTT::base::ChannelElementBase::connected(), RTT::base::ChannelElementBase::getInput(), and RTT::base::ChannelElementBase::removeInput().

shared_ptr RTT::base::ChannelElementBase::output

protectedinherited

Definition at line 77 of file ChannelElementBase.hpp.

RTT::os::SharedMutex RTT::base::ChannelElementBase::output_lock

mutableprotectedinherited

Definition at line 80 of file ChannelElementBase.hpp.

Referenced by RTT::base::ChannelElementBase::addOutput(), RTT::base::ChannelElementBase::connected(), RTT::base::ChannelElementBase::getOutput(), and RTT::base::ChannelElementBase::removeOutput().

Outputs RTT::base::MultipleOutputsChannelElementBase::outputs

protected

Definition at line 406 of file ChannelElementBase.hpp.

Referenced by addOutput(), channelReady(), connected(), disconnect(), removeDisconnectedOutputs(), removeOutput(), and signal().

RTT::os::SharedMutex RTT::base::MultipleOutputsChannelElementBase::outputs_lock

mutableprotected

Definition at line 407 of file ChannelElementBase.hpp.

Referenced by addOutput(), channelReady(), connected(), disconnect(), removeDisconnectedOutputs(), and signal().

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

rtt/base/ChannelElementBase.hpp
rtt/base/ChannelInterface.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation