Orocos Real-Time Toolkit
2.9.0
|
ChannelElementBase variant with multiple input and multiple output channels. More...
#include <rtt/base/ChannelElementBase.hpp>
Public Types | |
typedef boost::intrusive_ptr< MultipleInputsMultipleOutputsChannelElementBase > | shared_ptr |
typedef std::list< ChannelElementBase::shared_ptr > | Inputs |
typedef std::list< Output > | Outputs |
Public Member Functions | |
virtual bool | connected () |
Returns true, if this channel element has at least one input AND at least one output. More... | |
virtual bool | disconnect (ChannelElementBase::shared_ptr const &channel, bool forward) |
Overridden implementation of ChannelElementBase::disconnect(forward, channel). More... | |
virtual bool | inputReady (ChannelElementBase::shared_ptr const &caller) |
Overridden implementation of ChannelElementBase::inputReady(). More... | |
virtual void | clear () |
Overridden implementation of ChannelElementBase::clear(). More... | |
virtual void | disconnect (bool forward) |
Performs a disconnection of this channel's endpoints. More... | |
bool | signalFrom (ChannelElementBase *caller) |
Overridden implementation of ChannelElementBase::signalFrom(caller) which remembers the caller who last signalled this channel element. 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 | signal () |
Signals that there is new data available on this channel By default, the channel element forwards the call to its output. More... | |
virtual bool | channelReady (ChannelElementBase::shared_ptr const &caller, ConnPolicy const &policy, internal::ConnID *conn_id=0) |
This is called on the output half of a new connection by the connection factory in order to notify the output side of the new connection and check if it is ready to receive data. 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... | |
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... | |
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 | addInput (ChannelElementBase::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 (ChannelElementBase::shared_ptr const &input) |
Remove an input from the inputs list. 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 | addOutput (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 (shared_ptr const &output) |
Remove an output from the outputs list. More... | |
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... | |
ChannelElementBase variant with multiple input and multiple output channels.
Definition at line 462 of file ChannelElementBase.hpp.
|
inherited |
Definition at line 335 of file ChannelElementBase.hpp.
|
inherited |
Definition at line 403 of file ChannelElementBase.hpp.
typedef boost::intrusive_ptr<MultipleInputsMultipleOutputsChannelElementBase> RTT::base::MultipleInputsMultipleOutputsChannelElementBase::shared_ptr |
Definition at line 465 of file ChannelElementBase.hpp.
|
protectedvirtualinherited |
Sets the new input channel element of this element or adds a channel to the inputs list.
input | the previous element in chain. |
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 234 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::input.
|
protectedvirtualinherited |
Sets the new output channel element of this element or adds a channel to the outputs list.
output | the next element in chain. |
mandatory | whether the added output is mandatory for a write to succeed |
Reimplemented in RTT::base::MultipleOutputsChannelElementBase.
Definition at line 79 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::output, and RTT::base::ChannelElementBase::output_lock.
Referenced by RTT::base::ChannelElementBase::connectTo().
|
protectedvirtualinherited |
Sets the new output channel element of this element or adds a channel to the outputs list.
output | the next element in chain. |
mandatory | whether the added output is mandatory for a write to succeed |
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 335 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::output, RTT::base::MultipleOutputsChannelElementBase::Output::Output(), RTT::base::MultipleOutputsChannelElementBase::outputs, and RTT::base::MultipleOutputsChannelElementBase::outputs_lock.
|
virtualinherited |
This is called on the output half of a new connection by the connection factory in order to notify the output side of the new connection and check if 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 input. The ConnOutputEndPoint then calls back the inputReady() method in reverse direction to notify the output that the connection was successfully established.
Reimplemented in RTT::corba::RemoteChannelElement< T >, RTT::base::MultipleOutputsChannelElementBase, and RTT::internal::ConnOutputEndpoint< T >.
Definition at line 169 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::getInput(), RTT::base::ChannelElementBase::getOutput(), RTT::base::ChannelElementBase::input, RTT::base::ChannelElementBase::inputReady(), and RTT::base::ChannelElementBase::output.
Referenced by RTT::corba::RemoteChannelElement< T >::channelReady().
|
virtualinherited |
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 RTT::base::MultipleOutputsChannelElementBase::outputs, and RTT::base::MultipleOutputsChannelElementBase::outputs_lock.
|
virtualinherited |
Overridden implementation of ChannelElementBase::clear().
Forwards the clear() call to all inputs.
Reimplemented from RTT::base::ChannelElementBase.
Reimplemented in RTT::internal::SharedConnection< T >.
Definition at line 264 of file ChannelInterface.cpp.
|
virtual |
Returns true, if this channel element has at least one input AND at least one output.
Reimplemented from RTT::base::MultipleInputsChannelElementBase.
Definition at line 431 of file ChannelInterface.cpp.
References RTT::base::MultipleInputsChannelElementBase::connected(), and RTT::base::MultipleOutputsChannelElementBase::connected().
|
virtualinherited |
Connects a new input to this element.
input | the previous element in chain. |
Definition at line 96 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::addInput(), and RTT::base::ChannelElementBase::removeInput().
|
virtualinherited |
Connects a new output to this element.
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().
|
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().
|
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(), RTT::base::MultipleOutputsChannelElementBase::disconnect(), RTT::internal::ConnectionManager::eraseConnection(), and RTT::corba::RemoteChannelElement< T >::remoteDisconnect().
|
virtual |
Overridden implementation of ChannelElementBase::disconnect(forward, channel).
Reimplemented from RTT::base::MultipleInputsChannelElementBase.
Definition at line 436 of file ChannelInterface.cpp.
References RTT::base::MultipleInputsChannelElementBase::disconnect(), and RTT::base::MultipleOutputsChannelElementBase::disconnect().
|
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.
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().
|
virtualinherited |
Returns the class name of this element.
This is primary useful for special case handling in the connection tracking.
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.
|
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().
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().
|
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.
Reimplemented in RTT::internal::ConnInputEndpoint< T >.
Definition at line 157 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::getInput(), and RTT::base::ChannelElementBase::input.
|
virtualinherited |
This function return the URI of this element.
The URI must be unique.
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().
|
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().
|
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.
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().
|
virtualinherited |
Gets the port this channel element is connected to.
Reimplemented in RTT::internal::ConnOutputEndpoint< T >, and RTT::internal::ConnInputEndpoint< T >.
Definition at line 203 of file ChannelInterface.cpp.
|
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.
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().
|
virtualinherited |
Overridden implementation of ChannelElementBase::inputReady().
Forwards the inputReady() call to all inputs and only returns true if all inputs returned true.
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 255 of file ChannelInterface.cpp.
|
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.
Reimplemented in RTT::corba::RemoteChannelElement< T >, and RTT::mqueue::MQChannelElement< T >.
Definition at line 211 of file ChannelInterface.cpp.
|
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().
|
inlineinherited |
Return a pointer to the typed variant of this ChannelElementBase.
Definition at line 109 of file ChannelElementBase.hpp.
|
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().
|
protectedinherited |
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, RTT::base::MultipleOutputsChannelElementBase::outputs, RTT::base::MultipleOutputsChannelElementBase::outputs_lock, and RTT::base::MultipleOutputsChannelElementBase::removeOutput().
|
protectedvirtualinherited |
Remove an input from the inputs list.
input | the element to be removed |
Reimplemented from RTT::base::ChannelElementBase.
Reimplemented in RTT::base::MultipleInputsChannelElement< T >.
Definition at line 244 of file ChannelInterface.cpp.
Referenced by RTT::base::MultipleInputsChannelElement< T >::removeInput().
|
protectedvirtualinherited |
Remove an output from the outputs list.
output | the element to be removed, or null to remove unconditionally |
Reimplemented in RTT::base::MultipleOutputsChannelElementBase.
Definition at line 88 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::output_lock.
Referenced by RTT::base::ChannelElementBase::connectTo(), and RTT::base::ChannelElementBase::disconnect().
|
protectedvirtualinherited |
Remove an output from the outputs list.
output | the element to be removed |
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 345 of file ChannelInterface.cpp.
References RTT::base::MultipleOutputsChannelElementBase::outputs.
Referenced by RTT::base::MultipleOutputsChannelElementBase::disconnect(), and RTT::base::MultipleOutputsChannelElementBase::removeDisconnectedOutputs().
|
inlineinherited |
Definition at line 244 of file ChannelElementBase.hpp.
|
inlineinherited |
Definition at line 238 of file ChannelElementBase.hpp.
|
virtualinherited |
Signals that there is new data available on this channel By default, the channel element forwards the call to its output.
Reimplemented in RTT::base::MultipleOutputsChannelElementBase, RTT::internal::ConnOutputEndpoint< T >, RTT::mqueue::MQChannelElement< T >, and RTT::corba::RemoteChannelElement< T >.
Definition at line 195 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::getOutput(), and RTT::base::ChannelElementBase::output.
Referenced by RTT::corba::RemoteChannelElement< T >::remoteSignal(), RTT::corba::RemoteChannelElement< T >::signal(), RTT::base::MultipleOutputsChannelElementBase::signal(), RTT::base::MultipleInputsChannelElementBase::signalFrom(), and RTT::internal::ChannelDataElement< T >::write().
|
virtualinherited |
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, RTT::base::MultipleOutputsChannelElementBase::outputs, RTT::base::MultipleOutputsChannelElementBase::outputs_lock, and RTT::base::ChannelElementBase::signal().
|
virtualinherited |
Overridden implementation of ChannelElementBase::signalFrom(caller) which remembers the caller who last signalled this channel element.
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 316 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::signal().
|
protectedinherited |
Definition at line 76 of file ChannelElementBase.hpp.
Referenced by RTT::base::ChannelElementBase::addInput(), RTT::base::MultipleInputsChannelElementBase::addInput(), RTT::base::ChannelElementBase::channelReady(), RTT::base::ChannelElementBase::clear(), RTT::base::ChannelElementBase::connected(), RTT::base::ChannelElement< T >::data_sample(), RTT::base::MultipleInputsChannelElement< T >::data_sample(), RTT::base::ChannelElementBase::disconnect(), RTT::base::MultipleInputsChannelElementBase::disconnect(), RTT::base::ChannelElementBase::getInput(), RTT::base::ChannelElementBase::getInputEndPoint(), RTT::corba::RemoteChannelElement< T >::inputReady(), RTT::base::ChannelElement< T >::read(), RTT::base::MultipleInputsChannelElement< T >::read(), and RTT::mqueue::MQChannelElement< T >::signal().
|
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().
|
protectedinherited |
Definition at line 338 of file ChannelElementBase.hpp.
|
mutableprotectedinherited |
Definition at line 339 of file ChannelElementBase.hpp.
|
protectedinherited |
Definition at line 77 of file ChannelElementBase.hpp.
Referenced by RTT::base::ChannelElementBase::addOutput(), RTT::base::MultipleOutputsChannelElementBase::addOutput(), RTT::base::ChannelElementBase::channelReady(), RTT::base::ChannelElementBase::connected(), RTT::base::ChannelElement< T >::data_sample(), RTT::base::MultipleOutputsChannelElement< T >::data_sample(), RTT::base::ChannelElementBase::disconnect(), RTT::base::MultipleOutputsChannelElementBase::disconnect(), RTT::base::ChannelElementBase::getOutput(), RTT::base::ChannelElementBase::getOutputEndPoint(), RTT::base::ChannelElementBase::getRemoteURI(), RTT::mqueue::MQChannelElement< T >::inputReady(), RTT::base::MultipleOutputsChannelElementBase::removeDisconnectedOutputs(), RTT::mqueue::MQChannelElement< T >::signal(), RTT::base::ChannelElementBase::signal(), RTT::base::MultipleOutputsChannelElementBase::signal(), RTT::base::ChannelElement< T >::write(), and RTT::base::MultipleOutputsChannelElement< T >::write().
|
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().
|
protectedinherited |
Definition at line 406 of file ChannelElementBase.hpp.
Referenced by RTT::base::MultipleOutputsChannelElementBase::addOutput(), RTT::base::MultipleOutputsChannelElementBase::channelReady(), RTT::base::MultipleOutputsChannelElementBase::connected(), RTT::base::MultipleOutputsChannelElementBase::disconnect(), RTT::base::MultipleOutputsChannelElementBase::removeDisconnectedOutputs(), RTT::base::MultipleOutputsChannelElementBase::removeOutput(), and RTT::base::MultipleOutputsChannelElementBase::signal().
|
mutableprotectedinherited |
Definition at line 407 of file ChannelElementBase.hpp.
Referenced by RTT::base::MultipleOutputsChannelElementBase::addOutput(), RTT::base::MultipleOutputsChannelElementBase::channelReady(), RTT::base::MultipleOutputsChannelElementBase::connected(), RTT::base::MultipleOutputsChannelElementBase::disconnect(), RTT::base::MultipleOutputsChannelElementBase::removeDisconnectedOutputs(), and RTT::base::MultipleOutputsChannelElementBase::signal().