Public Types | Public Member Functions | Private Attributes
RTT::internal::ActionAliasDataSource< T > Class Template Reference

#include <DataSources.hpp>

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

List of all members.

Public Types

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

Public Member Functions

 ActionAliasDataSource (base::ActionInterface *act, DataSource< T > *ds)
virtual ActionAliasDataSource
< T > * 
clone () const
virtual ActionAliasDataSource
< T > * 
copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
bool evaluate () const
DataSource< T >::result_t get () const
virtual void reset ()
DataSource< T >::const_reference_t rvalue () const
DataSource< T >::result_t value () const
 ~ActionAliasDataSource ()

Private Attributes

base::ActionInterfaceaction
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:
TThe result data type of get().

Definition at line 516 of file 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 522 of file DataSources.hpp.


Constructor & Destructor Documentation

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

Definition at line 524 of file DataSources.hpp.

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

Definition at line 528 of file 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 561 of file 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 564 of file 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 530 of file 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 541 of file 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 559 of file 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 554 of file 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 549 of file DataSources.hpp.


Member Data Documentation

template<typename T>
base::ActionInterface* RTT::internal::ActionAliasDataSource< T >::action [private]

Definition at line 519 of file DataSources.hpp.

template<typename T>
DataSource<T>::shared_ptr RTT::internal::ActionAliasDataSource< T >::alias [private]

Definition at line 520 of file DataSources.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Wed Aug 26 2015 16:16:24