RTT::internal::ConstReferenceDataSource< T > Class Template Reference

#include <DataSources.hpp>

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

List of all members.

Public Types

typedef boost::intrusive_ptr
< ConstReferenceDataSource< T > > 
shared_ptr
typedef boost::intrusive_ptr
< ConstReferenceDataSource< T > > 
shared_ptr

Public Member Functions

virtual
ConstReferenceDataSource< T > * 
clone () const
virtual
ConstReferenceDataSource< T > * 
clone () const
 ConstReferenceDataSource (typename DataSource< T >::const_reference_t ref)
 ConstReferenceDataSource (typename DataSource< T >::const_reference_t ref)
virtual
ConstReferenceDataSource< T > * 
copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
virtual
ConstReferenceDataSource< T > * 
copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
DataSource< T >::result_t get () const
DataSource< T >::result_t get () const
DataSource< T >::const_reference_t rvalue () const
DataSource< T >::const_reference_t rvalue () const
DataSource< T >::result_t value () const
DataSource< T >::result_t value () const
 ~ConstReferenceDataSource ()
 ~ConstReferenceDataSource ()

Private Attributes

DataSource< T >::const_reference_t mref

Detailed Description

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

A DataSource which is used to read a const reference to an external value.

Parameters:
T The result data type of get().

Definition at line 167 of file install/include/rtt/internal/DataSources.hpp.


Member Typedef Documentation

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

Use this type to store a pointer to a DataSourceBase.

Reimplemented from RTT::internal::DataSource< T >.

Definition at line 178 of file rtt/internal/DataSources.hpp.

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

Use this type to store a pointer to a DataSourceBase.

Reimplemented from RTT::internal::DataSource< T >.

Definition at line 178 of file install/include/rtt/internal/DataSources.hpp.


Constructor & Destructor Documentation

Use shared_ptr.

template<typename T>
RTT::internal::ConstReferenceDataSource< T >::ConstReferenceDataSource ( typename DataSource< T >::const_reference_t  ref  ) 

Use shared_ptr.

template<typename T>
RTT::internal::ConstReferenceDataSource< T >::ConstReferenceDataSource ( typename DataSource< T >::const_reference_t  ref  ) 

Member Function Documentation

template<typename T>
virtual ConstReferenceDataSource<T>* RTT::internal::ConstReferenceDataSource< T >::clone (  )  const [virtual]

Return a shallow clone of this DataSource. This method returns a duplicate of this instance which re-uses the DataSources this internal::DataSource holds reference to. The clone() function is thus a non-deep copy.

Implements RTT::internal::DataSource< T >.

template<typename T>
virtual ConstReferenceDataSource<T>* RTT::internal::ConstReferenceDataSource< T >::clone (  )  const [virtual]

Return a shallow clone of this DataSource. This method returns a duplicate of this instance which re-uses the DataSources this internal::DataSource holds reference to. The clone() function is thus a non-deep copy.

Implements RTT::internal::DataSource< T >.

template<typename T>
virtual ConstReferenceDataSource<T>* RTT::internal::ConstReferenceDataSource< T >::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned  )  const [virtual]
template<typename T>
virtual ConstReferenceDataSource<T>* RTT::internal::ConstReferenceDataSource< T >::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned  )  const [virtual]
template<typename T>
DataSource<T>::result_t RTT::internal::ConstReferenceDataSource< T >::get (  )  const [inline, virtual]

Return the data as type T.

Implements RTT::internal::DataSource< T >.

Definition at line 182 of file rtt/internal/DataSources.hpp.

template<typename T>
DataSource<T>::result_t RTT::internal::ConstReferenceDataSource< T >::get (  )  const [inline, virtual]

Return the data as type T.

Implements RTT::internal::DataSource< T >.

Definition at line 182 of file install/include/rtt/internal/DataSources.hpp.

template<typename T>
DataSource<T>::const_reference_t RTT::internal::ConstReferenceDataSource< T >::rvalue (  )  const [inline, virtual]

Get a const reference to the value of this DataSource. You must call evaluate() prior to calling this function in order to get the most recent value of this attribute.

Note:
Getting a reference to an internal data structure is not thread-safe.

Implements RTT::internal::DataSource< T >.

Definition at line 192 of file rtt/internal/DataSources.hpp.

template<typename T>
DataSource<T>::const_reference_t RTT::internal::ConstReferenceDataSource< T >::rvalue (  )  const [inline, virtual]

Get a const reference to the value of this DataSource. You must call evaluate() prior to calling this function in order to get the most recent value of this attribute.

Note:
Getting a reference to an internal data structure is not thread-safe.

Implements RTT::internal::DataSource< T >.

Definition at line 192 of file install/include/rtt/internal/DataSources.hpp.

template<typename T>
DataSource<T>::result_t RTT::internal::ConstReferenceDataSource< T >::value (  )  const [inline, virtual]

Return the result of the last evaluate() function. You must call evaluate() prior to calling this function in order to get the most recent value of this attribute.

Implements RTT::internal::DataSource< T >.

Definition at line 187 of file rtt/internal/DataSources.hpp.

template<typename T>
DataSource<T>::result_t RTT::internal::ConstReferenceDataSource< T >::value (  )  const [inline, virtual]

Return the result of the last evaluate() function. You must call evaluate() prior to calling this function in order to get the most recent value of this attribute.

Implements RTT::internal::DataSource< T >.

Definition at line 187 of file install/include/rtt/internal/DataSources.hpp.


Member Data Documentation

template<typename T>
DataSource< T >::const_reference_t RTT::internal::ConstReferenceDataSource< T >::mref [private]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:49:59 2013