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

#include <DataObjectDataSource.hpp>

Inheritance diagram for RTT::internal::DataObjectDataSource< T >:

Public Types
typedef boost::intrusive_ptr < DataObjectDataSource< T > >	shared_ptr
typedef boost::intrusive_ptr < DataObjectDataSource< T > >	shared_ptr
Public Member Functions
virtual DataObjectDataSource< T > *	clone () const
virtual DataObjectDataSource< T > *	clone () const
virtual DataObjectDataSource< T > *	copy (std::map< const base::DataSourceBase , base::DataSourceBase > &alreadyCloned) const
virtual DataObjectDataSource< T > *	copy (std::map< const base::DataSourceBase , base::DataSourceBase > &alreadyCloned) const
	DataObjectDataSource (typename base::DataObjectInterface< T >::shared_ptr obj)
	DataObjectDataSource (typename base::DataObjectInterface< T >::shared_ptr obj)
bool	evaluate () const
bool	evaluate () const
DataSource< T >::result_t	get () const
DataSource< T >::result_t	get () const
virtual void	reset ()
virtual void	reset ()
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
virtual	~DataObjectDataSource ()
virtual	~DataObjectDataSource ()
Private Attributes
T	mcopy
base::DataObjectInterface< T > ::shared_ptr	mobject

Detailed Description

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

A DataSource which is used to read a DataObject. When it returns a const reference, it returns a reference to a copy, since we can't get a reference to the internals of a DataObject.

Parameters:

T

The result data type of get().

Definition at line 18 of file install/include/rtt/internal/DataObjectDataSource.hpp.

Member Typedef Documentation

template<typename T >

typedef boost::intrusive_ptr<DataObjectDataSource<T> > RTT::internal::DataObjectDataSource< T >::shared_ptr

Use this type to store a pointer to a DataSourceBase.

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

Definition at line 24 of file rtt/internal/DataObjectDataSource.hpp.

template<typename T >

typedef boost::intrusive_ptr<DataObjectDataSource<T> > RTT::internal::DataObjectDataSource< T >::shared_ptr

Use this type to store a pointer to a DataSourceBase.

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

Definition at line 24 of file install/include/rtt/internal/DataObjectDataSource.hpp.

Constructor & Destructor Documentation

template<typename T >

RTT::internal::DataObjectDataSource< T >::DataObjectDataSource ( typename base::DataObjectInterface< T >::shared_ptr obj ) [inline]

Definition at line 26 of file install/include/rtt/internal/DataObjectDataSource.hpp.

template<typename T >

virtual RTT::internal::DataObjectDataSource< T >::~DataObjectDataSource ( ) [inline, virtual]

Definition at line 30 of file install/include/rtt/internal/DataObjectDataSource.hpp.

template<typename T >

RTT::internal::DataObjectDataSource< T >::DataObjectDataSource ( typename base::DataObjectInterface< T >::shared_ptr obj ) [inline]

Definition at line 26 of file rtt/internal/DataObjectDataSource.hpp.

template<typename T >

virtual RTT::internal::DataObjectDataSource< T >::~DataObjectDataSource ( ) [inline, virtual]

Definition at line 30 of file rtt/internal/DataObjectDataSource.hpp.

Member Function Documentation

template<typename T >

virtual DataObjectDataSource<T>* RTT::internal::DataObjectDataSource< T >::clone ( ) const [inline, 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 >.

Definition at line 55 of file rtt/internal/DataObjectDataSource.hpp.

template<typename T >

virtual DataObjectDataSource<T>* RTT::internal::DataObjectDataSource< T >::clone ( ) const [inline, 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 >.

Definition at line 55 of file install/include/rtt/internal/DataObjectDataSource.hpp.

template<typename T >

virtual DataObjectDataSource<T>* RTT::internal::DataObjectDataSource< T >::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > & alreadyCloned ) const [inline, virtual]

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

Definition at line 58 of file rtt/internal/DataObjectDataSource.hpp.

template<typename T >

virtual DataObjectDataSource<T>* RTT::internal::DataObjectDataSource< T >::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > & alreadyCloned ) const [inline, virtual]

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

Definition at line 58 of file install/include/rtt/internal/DataObjectDataSource.hpp.

template<typename T >

bool RTT::internal::DataObjectDataSource< T >::evaluate ( ) const [inline, virtual]

Force an evaluation of the DataSourceBase.

Returns:: true on successful evaluation.

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

Definition at line 32 of file rtt/internal/DataObjectDataSource.hpp.

template<typename T >

bool RTT::internal::DataObjectDataSource< T >::evaluate ( ) const [inline, virtual]

Force an evaluation of the DataSourceBase.

Returns:: true on successful evaluation.

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

Definition at line 32 of file install/include/rtt/internal/DataObjectDataSource.hpp.

template<typename T >

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

Return the data as type T.

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

Definition at line 37 of file rtt/internal/DataObjectDataSource.hpp.

template<typename T >

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

Return the data as type T.

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

Definition at line 37 of file install/include/rtt/internal/DataObjectDataSource.hpp.

template<typename T >

virtual void RTT::internal::DataObjectDataSource< T >::reset ( ) [inline, virtual]

Reset the data to initial values.

Reimplemented from RTT::base::DataSourceBase.

Definition at line 53 of file rtt/internal/DataObjectDataSource.hpp.

template<typename T >

virtual void RTT::internal::DataObjectDataSource< T >::reset ( ) [inline, virtual]

Reset the data to initial values.

Reimplemented from RTT::base::DataSourceBase.

Definition at line 53 of file install/include/rtt/internal/DataObjectDataSource.hpp.

template<typename T >

DataSource<T>::const_reference_t RTT::internal::DataObjectDataSource< 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 48 of file rtt/internal/DataObjectDataSource.hpp.

template<typename T >

DataSource<T>::const_reference_t RTT::internal::DataObjectDataSource< 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 48 of file install/include/rtt/internal/DataObjectDataSource.hpp.

template<typename T >

DataSource<T>::result_t RTT::internal::DataObjectDataSource< 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 43 of file rtt/internal/DataObjectDataSource.hpp.

template<typename T >

DataSource<T>::result_t RTT::internal::DataObjectDataSource< 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 43 of file install/include/rtt/internal/DataObjectDataSource.hpp.