Public Types | Public Member Functions | Private Attributes | List of all members
RTT::internal::SharedConnection< T > Class Template Reference

#include <rtt-internal-fwd.hpp>

Inheritance diagram for RTT::internal::SharedConnection< T >:
Inheritance graph
[legend]

Public Types

typedef base::ChannelElement< T >::param_t param_t
 
typedef base::ChannelElement< T >::reference_t reference_t
 
typedef boost::intrusive_ptr< SharedConnection< T > > shared_ptr
 
typedef base::ChannelElement< T >::value_t value_t
 
- Public Types inherited from RTT::internal::SharedConnectionBase
typedef boost::intrusive_ptr< SharedConnectionBaseshared_ptr
 
- Public Types inherited from RTT::base::ChannelElementBase
typedef boost::intrusive_ptr< ChannelElementBaseshared_ptr
 
- Public Types inherited from RTT::base::MultipleInputsMultipleOutputsChannelElement< T >
typedef ChannelElement< T >::param_t param_t
 
typedef ChannelElement< T >::reference_t referene_t
 
typedef boost::intrusive_ptr< MultipleInputsMultipleOutputsChannelElement< T > > shared_ptr
 
typedef ChannelElement< T >::value_t value_t
 
- Public Types inherited from RTT::base::MultipleInputsMultipleOutputsChannelElementBase
typedef boost::intrusive_ptr< MultipleInputsMultipleOutputsChannelElementBaseshared_ptr
 
- Public Types inherited from RTT::base::MultipleInputsChannelElementBase
typedef std::list< ChannelElementBase::shared_ptrInputs
 
typedef boost::intrusive_ptr< MultipleInputsChannelElementBaseshared_ptr
 
- Public Types inherited from RTT::base::MultipleOutputsChannelElementBase
typedef std::list< OutputOutputs
 
typedef boost::intrusive_ptr< MultipleOutputsChannelElementBaseshared_ptr
 
- Public Types inherited from RTT::base::MultipleInputsChannelElement< T >
typedef ChannelElement< T >::param_t param_t
 
typedef ChannelElement< T >::reference_t reference_t
 
typedef boost::intrusive_ptr< MultipleInputsChannelElement< T > > shared_ptr
 
typedef ChannelElement< T >::value_t value_t
 
- Public Types inherited from RTT::base::ChannelElement< T >
typedef boost::call_traits< T >::param_type param_t
 
typedef boost::call_traits< T >::reference reference_t
 
typedef boost::intrusive_ptr< ChannelElement< T > > shared_ptr
 
typedef T value_t
 
- Public Types inherited from RTT::base::MultipleOutputsChannelElement< T >
typedef ChannelElement< T >::param_t param_t
 
typedef ChannelElement< T >::reference_t reference_t
 
typedef boost::intrusive_ptr< MultipleInputsChannelElement< T > > shared_ptr
 
typedef ChannelElement< T >::value_t value_t
 

Public Member Functions

virtual void clear ()
 
virtual WriteStatus data_sample (param_t sample, bool reset=true)
 
virtual value_t data_sample ()
 
virtual FlowStatus read (reference_t sample, bool copy_old_data=true)
 
 SharedConnection (typename base::ChannelElement< T > *storage, const ConnPolicy &policy)
 
virtual WriteStatus write (param_t sample)
 
virtual ~SharedConnection ()
 
- Public Member Functions inherited from RTT::internal::SharedConnectionBase
virtual SharedConnIDgetConnID ()
 
virtual const ConnPolicygetConnPolicy () const
 
virtual const std::string & getName () const
 
template<typename T >
SharedConnection< T > * narrow ()
 
 SharedConnectionBase (const ConnPolicy &policy)
 
virtual ~SharedConnectionBase ()
 
- Public Member Functions inherited from RTT::base::ChannelElementBase
 ChannelElementBase ()
 
virtual bool connectFrom (ChannelElementBase::shared_ptr const &input)
 
virtual bool connectTo (ChannelElementBase::shared_ptr const &output, bool mandatory=true)
 
virtual void disconnect (bool forward)
 
virtual std::string getElementName () const
 
shared_ptr getInput ()
 
virtual shared_ptr getInputEndPoint ()
 
virtual std::string getLocalURI () const
 
shared_ptr getOutput ()
 
virtual shared_ptr getOutputEndPoint ()
 
virtual PortInterfacegetPort () const
 
virtual std::string getRemoteURI () const
 
virtual bool isRemoteElement () const
 
template<typename T >
ChannelElement< T > * narrow ()
 
RTT_DEPRECATED void setInput (const ChannelElementBase::shared_ptr &input)
 
RTT_DEPRECATED void setOutput (const ChannelElementBase::shared_ptr &output)
 
virtual ~ChannelElementBase ()
 
- Public Member Functions inherited from RTT::base::MultipleInputsMultipleOutputsChannelElementBase
virtual bool connected ()
 
virtual bool disconnect (ChannelElementBase::shared_ptr const &channel, bool forward)
 
- Public Member Functions inherited from RTT::base::MultipleInputsChannelElementBase
virtual bool inputReady (ChannelElementBase::shared_ptr const &caller)
 
 MultipleInputsChannelElementBase ()
 
bool signalFrom (ChannelElementBase *caller)
 
- Public Member Functions inherited from RTT::base::MultipleOutputsChannelElementBase
virtual bool channelReady (ChannelElementBase::shared_ptr const &caller, ConnPolicy const &policy, internal::ConnID *conn_id=0)
 
 MultipleOutputsChannelElementBase ()
 
virtual bool signal ()
 
- Public Member Functions inherited from RTT::base::MultipleInputsChannelElement< T >
 MultipleInputsChannelElement ()
 
- Public Member Functions inherited from RTT::base::ChannelElement< T >
shared_ptr getInput ()
 
shared_ptr getOutput ()
 

Private Attributes

base::ChannelElement< T >::shared_ptr mstorage
 
bool mstorage_initialized
 

Additional Inherited Members

- Static Public Member Functions inherited from RTT::internal::SharedConnectionBase
template<typename T >
static SharedConnection< T > * narrow (ChannelElementBase *e)
 
- Static Public Member Functions inherited from RTT::base::ChannelElementBase
template<typename T >
static ChannelElement< T > * narrow (ChannelElementBase *e)
 
- Protected Member Functions inherited from RTT::base::ChannelElementBase
void deref ()
 
void ref ()
 
- Protected Member Functions inherited from RTT::base::MultipleInputsChannelElementBase
virtual bool addInput (ChannelElementBase::shared_ptr const &input)
 
- Protected Member Functions inherited from RTT::base::MultipleOutputsChannelElementBase
virtual bool addOutput (ChannelElementBase::shared_ptr const &output, bool mandatory=true)
 
void removeDisconnectedOutputs ()
 
virtual void removeOutput (ChannelElementBase::shared_ptr const &output)
 
- Protected Member Functions inherited from RTT::base::MultipleInputsChannelElement< T >
virtual void removeInput (ChannelElementBase::shared_ptr const &input)
 
- Protected Attributes inherited from RTT::base::ChannelElementBase
shared_ptr input
 
RTT::os::SharedMutex input_lock
 
shared_ptr output
 
RTT::os::SharedMutex output_lock
 
- Protected Attributes inherited from RTT::base::MultipleInputsChannelElementBase
Inputs inputs
 
RTT::os::SharedMutex inputs_lock
 
- Protected Attributes inherited from RTT::base::MultipleOutputsChannelElementBase
Outputs outputs
 
RTT::os::SharedMutex outputs_lock
 

Detailed Description

template<typename T>
class RTT::internal::SharedConnection< T >

Definition at line 64 of file rtt-internal-fwd.hpp.

Member Typedef Documentation

template<typename T>
typedef base::ChannelElement<T>::param_t RTT::internal::SharedConnection< T >::param_t

Definition at line 139 of file SharedConnection.hpp.

Definition at line 140 of file SharedConnection.hpp.

template<typename T>
typedef boost::intrusive_ptr< SharedConnection<T> > RTT::internal::SharedConnection< T >::shared_ptr

Definition at line 137 of file SharedConnection.hpp.

template<typename T>
typedef base::ChannelElement<T>::value_t RTT::internal::SharedConnection< T >::value_t

Definition at line 138 of file SharedConnection.hpp.

Constructor & Destructor Documentation

template<typename T>
RTT::internal::SharedConnection< T >::SharedConnection ( typename base::ChannelElement< T > *  storage,
const ConnPolicy policy 
)
inline

Definition at line 147 of file SharedConnection.hpp.

template<typename T>
virtual RTT::internal::SharedConnection< T >::~SharedConnection ( )
inlinevirtual

Definition at line 154 of file SharedConnection.hpp.

Member Function Documentation

template<typename T>
virtual void RTT::internal::SharedConnection< T >::clear ( )
inlinevirtual

Resets the stored sample. After clear() has been called, read() returns false

Reimplemented from RTT::base::ChannelElementBase.

Definition at line 189 of file SharedConnection.hpp.

template<typename T>
virtual WriteStatus RTT::internal::SharedConnection< T >::data_sample ( param_t  sample,
bool  reset = true 
)
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.

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

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

Definition at line 203 of file SharedConnection.hpp.

template<typename T>
virtual value_t RTT::internal::SharedConnection< T >::data_sample ( )
inlinevirtual

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

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

Definition at line 213 of file SharedConnection.hpp.

template<typename T>
virtual FlowStatus RTT::internal::SharedConnection< T >::read ( reference_t  sample,
bool  copy_old_data = true 
)
inlinevirtual

Reads the last sample given to write()

Returns
false if no sample has ever been written, true otherwise

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

Definition at line 180 of file SharedConnection.hpp.

template<typename T>
virtual WriteStatus RTT::internal::SharedConnection< T >::write ( param_t  sample)
inlinevirtual

Writes a new sample on this connection. sample is the sample to write.

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::MultipleOutputsChannelElement< T >.

Definition at line 164 of file SharedConnection.hpp.

Member Data Documentation

template<typename T>
base::ChannelElement<T>::shared_ptr RTT::internal::SharedConnection< T >::mstorage
private

Definition at line 143 of file SharedConnection.hpp.

template<typename T>
bool RTT::internal::SharedConnection< T >::mstorage_initialized
private

Definition at line 144 of file SharedConnection.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:47