#include <ChannelElement.hpp>
Public Types | |
| typedef boost::call_traits< T > ::param_type | param_t |
| typedef boost::call_traits< T > ::param_type | param_t |
| typedef boost::call_traits< T > ::reference | reference_t |
| typedef boost::call_traits< T > ::reference | reference_t |
| typedef boost::intrusive_ptr < ChannelElement< T > > | shared_ptr |
| typedef boost::intrusive_ptr < ChannelElement< T > > | shared_ptr |
| typedef T | value_t |
| typedef T | value_t |
Public Member Functions | |
| virtual bool | data_sample (param_t sample) |
| virtual bool | data_sample (param_t sample) |
| shared_ptr | getInput () |
| shared_ptr | getInput () |
| shared_ptr | getOutput () |
| shared_ptr | getOutput () |
| virtual FlowStatus | read (reference_t sample, bool copy_old_data) |
| virtual FlowStatus | read (reference_t sample, bool copy_old_data) |
| virtual bool | write (param_t sample) |
| virtual bool | write (param_t sample) |
A typed version of ChannelElementBase. It defines generic methods that are type-specific (like write and read)
Definition at line 53 of file install/include/rtt/base/ChannelElement.hpp.
| typedef boost::call_traits<T>::param_type RTT::base::ChannelElement< T >::param_t |
Reimplemented in RTT::internal::ChannelBufferElement< T >, RTT::internal::ChannelDataElement< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 50 of file rtt/base/ChannelElement.hpp.
| typedef boost::call_traits<T>::param_type RTT::base::ChannelElement< T >::param_t |
Reimplemented in RTT::internal::ChannelBufferElement< T >, RTT::internal::ChannelDataElement< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 50 of file install/include/rtt/base/ChannelElement.hpp.
| typedef boost::call_traits<T>::reference RTT::base::ChannelElement< T >::reference_t |
Reimplemented in RTT::internal::ChannelBufferElement< T >, RTT::internal::ChannelDataElement< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 51 of file rtt/base/ChannelElement.hpp.
| typedef boost::call_traits<T>::reference RTT::base::ChannelElement< T >::reference_t |
Reimplemented in RTT::internal::ChannelBufferElement< T >, RTT::internal::ChannelDataElement< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 51 of file install/include/rtt/base/ChannelElement.hpp.
| typedef boost::intrusive_ptr< ChannelElement<T> > RTT::base::ChannelElement< T >::shared_ptr |
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 49 of file rtt/base/ChannelElement.hpp.
| typedef boost::intrusive_ptr< ChannelElement<T> > RTT::base::ChannelElement< T >::shared_ptr |
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 49 of file install/include/rtt/base/ChannelElement.hpp.
| typedef T RTT::base::ChannelElement< T >::value_t |
Reimplemented in RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelBufferElement< T >.
Definition at line 48 of file rtt/base/ChannelElement.hpp.
| typedef T RTT::base::ChannelElement< T >::value_t |
Reimplemented in RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelBufferElement< T >.
Definition at line 48 of file install/include/rtt/base/ChannelElement.hpp.
| virtual bool RTT::base::ChannelElement< T >::data_sample | ( | param_t | sample | ) | [inline, virtual] |
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 >, RTT::internal::ChannelDataElement< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 73 of file rtt/base/ChannelElement.hpp.
| virtual bool RTT::base::ChannelElement< T >::data_sample | ( | param_t | sample | ) | [inline, virtual] |
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 >, RTT::internal::ChannelDataElement< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 73 of file install/include/rtt/base/ChannelElement.hpp.
| shared_ptr RTT::base::ChannelElement< T >::getInput | ( | ) | [inline] |
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 setOutput().
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 59 of file rtt/base/ChannelElement.hpp.
| shared_ptr RTT::base::ChannelElement< T >::getInput | ( | ) | [inline] |
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 setOutput().
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 59 of file install/include/rtt/base/ChannelElement.hpp.
| shared_ptr RTT::base::ChannelElement< T >::getOutput | ( | ) | [inline] |
Returns the next channel element in the channel's propagation direction
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 53 of file rtt/base/ChannelElement.hpp.
| shared_ptr RTT::base::ChannelElement< T >::getOutput | ( | ) | [inline] |
Returns the next channel element in the channel's propagation direction
Reimplemented from RTT::base::ChannelElementBase.
Definition at line 53 of file install/include/rtt/base/ChannelElement.hpp.
| virtual FlowStatus RTT::base::ChannelElement< T >::read | ( | reference_t | sample, | |
| bool | copy_old_data | |||
| ) | [inline, virtual] |
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 >, RTT::internal::ChannelDataElement< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 99 of file rtt/base/ChannelElement.hpp.
| virtual FlowStatus RTT::base::ChannelElement< T >::read | ( | reference_t | sample, | |
| bool | copy_old_data | |||
| ) | [inline, virtual] |
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 >, RTT::internal::ChannelDataElement< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 99 of file install/include/rtt/base/ChannelElement.hpp.
| virtual bool RTT::base::ChannelElement< T >::write | ( | param_t | sample | ) | [inline, virtual] |
Writes a new sample on this connection. sample is the sample to write.
Reimplemented in RTT::internal::ChannelBufferElement< T >, RTT::internal::ChannelDataElement< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 86 of file rtt/base/ChannelElement.hpp.
| virtual bool RTT::base::ChannelElement< T >::write | ( | param_t | sample | ) | [inline, virtual] |
Writes a new sample on this connection. sample is the sample to write.
Reimplemented in RTT::internal::ChannelBufferElement< T >, RTT::internal::ChannelDataElement< T >, RTT::internal::ChannelBufferElement< T >, and RTT::internal::ChannelDataElement< T >.
Definition at line 86 of file install/include/rtt/base/ChannelElement.hpp.
