Orocos Real-Time Toolkit  2.9.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RTT::base::MultipleInputsMultipleOutputsChannelElement< T > Class Template Reference

A typed version of MultipleInputsMultipleOutputsChannelElementBase. More...

#include <rtt/base/ChannelElement.hpp>

Inheritance diagram for RTT::base::MultipleInputsMultipleOutputsChannelElement< T >:
RTT::base::MultipleInputsMultipleOutputsChannelElementBase RTT::base::MultipleInputsChannelElement< T > RTT::base::MultipleOutputsChannelElement< T > RTT::base::MultipleInputsChannelElementBase RTT::base::MultipleOutputsChannelElementBase RTT::base::MultipleInputsChannelElementBase RTT::base::ChannelElement< T > RTT::base::MultipleOutputsChannelElementBase RTT::base::ChannelElement< T > RTT::base::ChannelElementBase RTT::base::ChannelElementBase RTT::base::ChannelElementBase RTT::base::ChannelElementBase RTT::base::ChannelElementBase RTT::base::ChannelElementBase RTT::internal::SharedConnection< T >

Public Types

typedef boost::intrusive_ptr< MultipleInputsMultipleOutputsChannelElement< T > > shared_ptr
 
typedef ChannelElement< T >::value_t value_t
 
typedef ChannelElement< T >::param_t param_t
 
typedef ChannelElement< T >::reference_t referene_t
 
typedef std::list< ChannelElementBase::shared_ptrInputs
 
typedef std::list< OutputOutputs
 
typedef ChannelElement< T >::reference_t reference_t
 
typedef ChannelElement< T >::reference_t reference_t
 

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 void disconnect (bool forward)
 Performs a disconnection of this channel's endpoints. More...
 
virtual bool inputReady (ChannelElementBase::shared_ptr const &caller)
 Overridden implementation of ChannelElementBase::inputReady(). More...
 
virtual void clear ()
 Overridden implementation of ChannelElementBase::clear(). 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 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)
 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 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 PortInterfacegetPort () const
 Gets the port this channel element is connected to. More...
 
virtual const ConnPolicygetConnPolicy () 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 value_t data_sample ()
 Overridden implementation of MultipleInputsChannelElementBase::data_sample() that gets a sample from the currently selected input. More...
 
virtual WriteStatus data_sample (param_t sample, bool reset=true)
 Provides a data sample to initialize this connection. More...
 
virtual FlowStatus read (reference_t sample, bool copy_old_data=true)
 Reads a sample from the connection. More...
 
shared_ptr getInput ()
 
shared_ptr getOutput ()
 
virtual WriteStatus write (param_t sample)
 Writes a new sample on this connection. More...
 
virtual WriteStatus data_sample (param_t sample, bool reset=true)
 Provides a data sample to initialize this connection. More...
 
virtual WriteStatus write (param_t sample)
 Writes a new sample on this connection. 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 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 (shared_ptr const &output)
 Remove an output from 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...
 
virtual void removeInput (ChannelElementBase::shared_ptr const &input)
 Remove an input from the inputs list. More...
 

Protected Attributes

Inputs inputs
 
RTT::os::SharedMutex inputs_lock
 
shared_ptr input
 
shared_ptr output
 
RTT::os::SharedMutex input_lock
 
RTT::os::SharedMutex output_lock
 
Outputs outputs
 
RTT::os::SharedMutex outputs_lock
 

Detailed Description

template<typename T>
class RTT::base::MultipleInputsMultipleOutputsChannelElement< T >

A typed version of MultipleInputsMultipleOutputsChannelElementBase.

Definition at line 332 of file ChannelElement.hpp.

Member Typedef Documentation

Definition at line 335 of file ChannelElementBase.hpp.

Definition at line 403 of file ChannelElementBase.hpp.

Definition at line 337 of file ChannelElement.hpp.

template<typename T >
typedef ChannelElement<T>::reference_t RTT::base::MultipleInputsChannelElement< T >::reference_t
inherited

Definition at line 137 of file ChannelElement.hpp.

template<typename T >
typedef ChannelElement<T>::reference_t RTT::base::MultipleOutputsChannelElement< T >::reference_t
inherited

Definition at line 259 of file ChannelElement.hpp.

Definition at line 338 of file ChannelElement.hpp.

Definition at line 335 of file ChannelElement.hpp.

Definition at line 336 of file ChannelElement.hpp.

Member Function Documentation

bool MultipleInputsChannelElementBase::addInput ( ChannelElementBase::shared_ptr const &  input)
protectedvirtualinherited

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

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

Definition at line 234 of file ChannelInterface.cpp.

References RTT::base::ChannelElementBase::input.

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

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

Parameters
outputthe next element in chain.
mandatorywhether 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 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().

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

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

Parameters
outputthe next element in chain.
mandatorywhether 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(), RTT::base::MultipleOutputsChannelElementBase::outputs, and RTT::base::MultipleOutputsChannelElementBase::outputs_lock.

bool ChannelElementBase::channelReady ( ChannelElementBase::shared_ptr const &  caller,
ConnPolicy const &  policy,
internal::ConnID conn_id = 0 
)
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.

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

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().

bool MultipleOutputsChannelElementBase::channelReady ( ChannelElementBase::shared_ptr const &  caller,
ConnPolicy const &  policy,
internal::ConnID conn_id = 0 
)
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.

void MultipleInputsChannelElementBase::clear ( )
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.

bool MultipleInputsMultipleOutputsChannelElementBase::connected ( )
virtualinherited

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().

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

Connects a new input to this element.

Parameters
inputthe 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
outputthe next element in chain.
mandatorywhether 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().

template<typename T>
virtual WriteStatus RTT::base::ChannelElement< T >::data_sample ( param_t  sample,
bool  reset = true 
)
inlinevirtualinherited

Provides a data sample to initialize this connection.

This is used before the first write() in order to inform this connection of the size of the data. As such enough storage space can be allocated before the actual writing begins.

Returns
false if an error occured that requires the channel to be invalidated.

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

Definition at line 84 of file ChannelElement.hpp.

References RTT::base::ChannelElement< T >::data_sample(), RTT::base::ChannelElement< T >::getOutput(), RTT::base::ChannelElementBase::output, and RTT::WriteSuccess.

Referenced by RTT::base::ChannelElement< T >::data_sample(), RTT::base::MultipleInputsChannelElement< T >::data_sample(), RTT::internal::SharedConnection< T >::data_sample(), RTT::base::MultipleOutputsChannelElement< T >::data_sample(), and RTT::mqueue::MQChannelElement< T >::inputReady().

template<typename T >
virtual value_t RTT::base::MultipleInputsChannelElement< T >::data_sample ( )
inlinevirtualinherited

Overridden implementation of MultipleInputsChannelElementBase::data_sample() that gets a sample from the currently selected input.

Reimplemented from RTT::base::ChannelElement< T >.

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

Definition at line 146 of file ChannelElement.hpp.

References RTT::base::ChannelElement< T >::data_sample(), and RTT::base::ChannelElementBase::input.

Referenced by RTT::internal::SharedConnection< T >::data_sample().

template<typename T >
virtual WriteStatus RTT::base::MultipleOutputsChannelElement< T >::data_sample ( param_t  sample,
bool  reset = true 
)
inlinevirtualinherited

Provides a data sample to initialize this connection.

This is used before the first write() in order to inform this connection of the size of the data. As such enough storage space can be allocated before the actual writing begins.

Returns
false if an error occured that requires the channel to be invalidated.

Reimplemented from RTT::base::ChannelElement< T >.

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

Definition at line 261 of file ChannelElement.hpp.

References RTT::base::ChannelElement< T >::data_sample(), RTT::NotConnected, RTT::base::ChannelElementBase::output, and RTT::WriteSuccess.

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
bool MultipleInputsMultipleOutputsChannelElementBase::disconnect ( ChannelElementBase::shared_ptr const &  channel,
bool  forward 
)
virtualinherited

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().

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.

template<typename T>
shared_ptr RTT::base::ChannelElement< T >::getInput ( )
inlineinherited
ChannelElementBase::shared_ptr ChannelElementBase::getInput ( )
inherited
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().

template<typename T>
shared_ptr RTT::base::ChannelElement< T >::getOutput ( )
inlineinherited
ChannelElementBase::shared_ptr ChannelElementBase::getOutput ( )
inherited
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().

bool MultipleInputsChannelElementBase::inputReady ( ChannelElementBase::shared_ptr const &  caller)
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.

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.

template<typename T >
virtual FlowStatus RTT::base::MultipleInputsChannelElement< T >::read ( reference_t  sample,
bool  copy_old_data = true 
)
inlinevirtualinherited

Reads a sample from the connection.

sample is a reference which will get updated if a sample is available. The method returns true if a sample was available, and false otherwise. If false is returned, then sample is not modified by the method

Reimplemented from RTT::base::ChannelElement< T >.

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

Definition at line 161 of file ChannelElement.hpp.

References RTT::base::ChannelElementBase::input, RTT::base::ChannelElementBase::narrow(), RTT::NewData, RTT::NoData, and RTT::base::ChannelElement< T >::read().

void ChannelElementBase::ref ( )
protectedinherited
void MultipleOutputsChannelElementBase::removeDisconnectedOutputs ( )
protectedinherited
template<typename T >
virtual void RTT::base::MultipleInputsChannelElement< T >::removeInput ( ChannelElementBase::shared_ptr const &  input)
inlineprotectedvirtualinherited

Remove an input from the inputs list.

Parameters
inputthe element to be removed

Reimplemented from RTT::base::MultipleInputsChannelElementBase.

Definition at line 240 of file ChannelElement.hpp.

References RTT::base::MultipleInputsChannelElementBase::removeInput().

void MultipleInputsChannelElementBase::removeInput ( ChannelElementBase::shared_ptr const &  input)
protectedvirtualinherited

Remove an input from the inputs list.

Parameters
inputthe 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().

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

Remove an output from the outputs list.

Parameters
outputthe 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().

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

Remove an output from the outputs list.

Parameters
outputthe 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().

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 ChannelElementBase::signal ( )
virtualinherited

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 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().

bool MultipleOutputsChannelElementBase::signal ( )
virtualinherited
bool MultipleInputsChannelElementBase::signalFrom ( ChannelElementBase caller)
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().

template<typename T>
virtual WriteStatus RTT::base::ChannelElement< T >::write ( param_t  sample)
inlinevirtualinherited
template<typename T >
virtual WriteStatus RTT::base::MultipleOutputsChannelElement< T >::write ( param_t  sample)
inlinevirtualinherited

Writes a new sample on this connection.

sample is the sample to write. Writes the sample to all connected channels

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

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

Definition at line 297 of file ChannelElement.hpp.

References RTT::NotConnected, RTT::base::ChannelElementBase::output, RTT::base::ChannelElement< T >::write(), and RTT::WriteSuccess.

Member Data Documentation

shared_ptr RTT::base::ChannelElementBase::input
protectedinherited
RTT::os::SharedMutex RTT::base::ChannelElementBase::input_lock
mutableprotectedinherited
Inputs RTT::base::MultipleInputsChannelElementBase::inputs
protectedinherited

Definition at line 338 of file ChannelElementBase.hpp.

RTT::os::SharedMutex RTT::base::MultipleInputsChannelElementBase::inputs_lock
mutableprotectedinherited

Definition at line 339 of file ChannelElementBase.hpp.

shared_ptr RTT::base::ChannelElementBase::output
protectedinherited
RTT::os::SharedMutex RTT::base::ChannelElementBase::output_lock
mutableprotectedinherited
Outputs RTT::base::MultipleOutputsChannelElementBase::outputs
protectedinherited
RTT::os::SharedMutex RTT::base::MultipleOutputsChannelElementBase::outputs_lock
mutableprotectedinherited

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