Orocos Real-Time Toolkit
2.8.3
|
A typed version of ChannelElementBase. More...
#include <rtt/base/ChannelElement.hpp>
Public Types | |
typedef T | value_t |
typedef boost::intrusive_ptr< ChannelElement< T > > | shared_ptr |
typedef boost::call_traits< T >::param_type | param_t |
typedef boost::call_traits< T >::reference | reference_t |
Public Member Functions | |
shared_ptr | getOutput () |
shared_ptr | getInput () |
virtual bool | data_sample (param_t sample) |
Provides a data sample to initialize this connection. More... | |
virtual value_t | data_sample () |
virtual bool | write (param_t sample) |
Writes a new sample on this connection. More... | |
virtual FlowStatus | read (reference_t sample, bool copy_old_data) |
Reads a sample from the connection. More... | |
void | removeInput () |
Removes the input channel (if any). More... | |
ChannelElementBase::shared_ptr | getInputEndPoint () |
Returns the first input channel element of this connection. More... | |
ChannelElementBase::shared_ptr | getOutputEndPoint () |
Returns the last output channel element of this connection. More... | |
void | setOutput (shared_ptr output) |
Sets the output of this channel element to output and sets the input of output to this. 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 | inputReady () |
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 internal::ConnID * | getConnID () const |
Gets the Connection ID of this channel. More... | |
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... | |
Protected Member Functions | |
void | ref () |
Increases the reference count. More... | |
void | deref () |
Decreases the reference count, and deletes the object if it is zero. More... | |
A typed version of ChannelElementBase.
It defines generic methods that are type-specific (like write and read)
Definition at line 54 of file ChannelElement.hpp.
typedef boost::call_traits<T>::param_type RTT::base::ChannelElement< T >::param_t |
Definition at line 59 of file ChannelElement.hpp.
typedef boost::call_traits<T>::reference RTT::base::ChannelElement< T >::reference_t |
Definition at line 60 of file ChannelElement.hpp.
typedef boost::intrusive_ptr< ChannelElement<T> > RTT::base::ChannelElement< T >::shared_ptr |
Definition at line 58 of file ChannelElement.hpp.
typedef T RTT::base::ChannelElement< T >::value_t |
Definition at line 57 of file ChannelElement.hpp.
|
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::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 117 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::getInput().
Referenced by RTT::internal::ChannelDataElement< T >::clear(), and RTT::internal::ChannelBufferElement< T >::clear().
|
inlinevirtual |
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.
Reimplemented in RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 82 of file ChannelElement.hpp.
References RTT::base::ChannelElement< T >::data_sample(), and RTT::base::ChannelElement< T >::getOutput().
Referenced by RTT::base::ChannelElement< T >::data_sample(), RTT::InputPort< T >::getDataSample(), and RTT::mqueue::MQChannelElement< T >::inputReady().
|
inlinevirtual |
Reimplemented in RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 90 of file ChannelElement.hpp.
References RTT::base::ChannelElement< T >::data_sample(), and RTT::base::ChannelElement< T >::getInput().
Referenced by RTT::internal::ChannelDataElement< T >::data_sample(), RTT::internal::ChannelBufferElement< T >::data_sample(), and RTT::corba::RemoteChannelElement< T >::data_sample().
|
protectedinherited |
Decreases the reference count, and deletes the object if it is zero.
Definition at line 165 of file ChannelInterface.cpp.
References oro_atomic_dec_and_test().
Referenced by RTT::corba::RemoteChannelElement< T >::_remove_ref(), and RTT::base::intrusive_ptr_release().
|
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.
Reimplemented in RTT::corba::RemoteChannelElement< T >, RTT::internal::ConnOutputEndpoint< T >, and RTT::internal::ConnInputEndpoint< T >.
Definition at line 76 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::getInput(), and RTT::base::ChannelElementBase::getOutput().
Referenced by RTT::internal::ConnInputEndpoint< T >::disconnect(), RTT::internal::ConnOutputEndpoint< T >::disconnect(), RTT::corba::RemoteChannelElement< T >::disconnect(), and RTT::corba::RemoteChannelElement< T >::remoteDisconnect().
|
virtualinherited |
Gets the Connection ID of this channel.
This is only stored in connection endpoints.
Reimplemented in RTT::internal::ConnOutputEndpoint< T >, and RTT::internal::ConnInputEndpoint< T >.
Definition at line 136 of file ChannelInterface.cpp.
|
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::ChannelBufferElement< T >, RTT::internal::ConnOutputEndpoint< T >, RTT::internal::ChannelDataElement< T >, and RTT::internal::ConnInputEndpoint< T >.
Definition at line 156 of file ChannelInterface.cpp.
|
inline |
Definition at line 68 of file ChannelElement.hpp.
References RTT::base::ChannelElementBase::getInput().
Referenced by RTT::base::ChannelElement< T >::data_sample(), RTT::corba::RemoteChannelElement< T >::inputReady(), RTT::base::ChannelElement< T >::read(), and RTT::mqueue::MQChannelElement< T >::signal().
|
inherited |
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.
Definition at line 97 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::getInput().
|
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 152 of file ChannelInterface.cpp.
Referenced by RTT::mqueue::MQChannelElement< T >::getLocalURI(), and RTT::corba::RemoteChannelElement< T >::getLocalURI().
|
inline |
Definition at line 62 of file ChannelElement.hpp.
References RTT::base::ChannelElementBase::getOutput().
Referenced by RTT::base::ChannelElement< T >::data_sample(), RTT::mqueue::MQChannelElement< T >::data_sample(), RTT::corba::RemoteChannelElement< T >::data_sample(), RTT::mqueue::MQChannelElement< T >::inputReady(), RTT::mqueue::MQChannelElement< T >::signal(), and RTT::base::ChannelElement< T >::write().
|
inherited |
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.
Definition at line 102 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::getOutput().
|
virtualinherited |
Gets the port this channel element is connected to.
Reimplemented in RTT::internal::ConnOutputEndpoint< T >, and RTT::internal::ConnInputEndpoint< T >.
Definition at line 132 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 144 of file ChannelInterface.cpp.
Referenced by RTT::mqueue::MQChannelElement< T >::getRemoteURI(), and RTT::corba::RemoteChannelElement< T >::getRemoteURI().
|
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.
Reimplemented in RTT::corba::RemoteChannelElement< T >, RTT::mqueue::MQChannelElement< T >, RTT::internal::ConnOutputEndpoint< T >, and RTT::internal::ConnInputEndpoint< T >.
Definition at line 108 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::getInput().
Referenced by RTT::internal::ConnOutputEndpoint< T >::inputReady(), and RTT::corba::RemoteChannelElement< T >::inputReady().
|
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 140 of file ChannelInterface.cpp.
|
inlinevirtual |
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 in RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 116 of file ChannelElement.hpp.
References RTT::base::ChannelElement< T >::getInput(), RTT::NoData, and RTT::base::ChannelElement< T >::read().
Referenced by RTT::base::ChannelElement< T >::read(), RTT::corba::RemoteChannelElement< T >::read(), and RTT::mqueue::MQChannelElement< T >::signal().
|
protectedinherited |
Increases the reference count.
Definition at line 160 of file ChannelInterface.cpp.
References oro_atomic_inc().
Referenced by RTT::corba::RemoteChannelElement< T >::_add_ref(), RTT::base::intrusive_ptr_add_ref(), and RTT::corba::RemoteChannelElement< T >::RemoteChannelElement().
|
inherited |
Removes the input channel (if any).
This call may delete channels from memory.
|
inherited |
Sets the output of this channel element to output and sets the input of output to this.
This implies that this channel element becomes the input of output. There is no setInput function since this function does both setting input and output of this and output.
output | the next element in chain. |
Definition at line 69 of file ChannelInterface.cpp.
Referenced by RTT::internal::ConnFactory::buildBufferedChannelInput(), RTT::internal::ConnFactory::buildBufferedChannelOutput(), RTT::internal::ConnFactory::buildChannelInput(), and RTT::corba::CDataFlowInterface_i::deregisterChannel().
|
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::mqueue::MQChannelElement< T >, RTT::corba::RemoteChannelElement< T >, and RTT::internal::ConnOutputEndpoint< T >.
Definition at line 124 of file ChannelInterface.cpp.
References RTT::base::ChannelElementBase::getOutput().
Referenced by RTT::corba::RemoteChannelElement< T >::remoteSignal(), RTT::corba::RemoteChannelElement< T >::signal(), and RTT::internal::ChannelDataElement< T >::write().
|
inlinevirtual |
Writes a new sample on this connection.
sample is the sample to write.
Reimplemented in RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 103 of file ChannelElement.hpp.
References RTT::base::ChannelElement< T >::getOutput(), and RTT::base::ChannelElement< T >::write().
Referenced by RTT::mqueue::MQChannelElement< T >::signal(), RTT::base::ChannelElement< T >::write(), and RTT::corba::RemoteChannelElement< T >::write().