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

#include <DataSources.hpp>

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

Public Types
typedef boost::intrusive_ptr < ActionAliasDataSource< T > >	shared_ptr
typedef boost::intrusive_ptr < ActionAliasDataSource< T > >	shared_ptr
Public Member Functions
	ActionAliasDataSource (base::ActionInterface act, DataSource< T > ds)
	ActionAliasDataSource (base::ActionInterface act, DataSource< T > ds)
virtual ActionAliasDataSource < T > *	clone () const
virtual ActionAliasDataSource < T > *	clone () const
virtual ActionAliasDataSource < T > *	copy (std::map< const base::DataSourceBase , base::DataSourceBase > &alreadyCloned) const
virtual ActionAliasDataSource < T > *	copy (std::map< const base::DataSourceBase , base::DataSourceBase > &alreadyCloned) const
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
	~ActionAliasDataSource ()
	~ActionAliasDataSource ()
Private Attributes
base::ActionInterface *	action
DataSource< T >::shared_ptr	alias

Detailed Description

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

A DataSource which is used to execute an action and then return the value of another DataSource.

Parameters:

T

The result data type of get().

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

Member Typedef Documentation

template<typename T>

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

Use this type to store a pointer to a DataSourceBase.

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

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

template<typename T>

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

Use this type to store a pointer to a DataSourceBase.

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

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

Constructor & Destructor Documentation

template<typename T>

RTT::internal::ActionAliasDataSource< T >::ActionAliasDataSource	(	base::ActionInterface *	act,
		DataSource< T > *	ds
	)			`[inline]`

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

template<typename T>

RTT::internal::ActionAliasDataSource< T >::~ActionAliasDataSource ( ) [inline]

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

template<typename T>

RTT::internal::ActionAliasDataSource< T >::ActionAliasDataSource	(	base::ActionInterface *	act,
		DataSource< T > *	ds
	)			`[inline]`

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

template<typename T>

RTT::internal::ActionAliasDataSource< T >::~ActionAliasDataSource ( ) [inline]

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

Member Function Documentation

template<typename T>

virtual ActionAliasDataSource<T>* RTT::internal::ActionAliasDataSource< 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 474 of file rtt/internal/DataSources.hpp.

template<typename T>

virtual ActionAliasDataSource<T>* RTT::internal::ActionAliasDataSource< 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 474 of file install/include/rtt/internal/DataSources.hpp.

template<typename T>

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

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

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

template<typename T>

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

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

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

template<typename T>

bool RTT::internal::ActionAliasDataSource< 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 443 of file rtt/internal/DataSources.hpp.

template<typename T>

bool RTT::internal::ActionAliasDataSource< 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 443 of file install/include/rtt/internal/DataSources.hpp.

template<typename T>

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

Return the data as type T.

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

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

template<typename T>

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

Return the data as type T.

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

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

template<typename T>

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

Reset the data to initial values.

Reimplemented from RTT::base::DataSourceBase.

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

template<typename T>

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

Reset the data to initial values.

Reimplemented from RTT::base::DataSourceBase.

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

template<typename T>

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

template<typename T>

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

template<typename T>

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

template<typename T>

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