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

#include <PartDataSource.hpp>

Inheritance diagram for RTT::internal::PartDataSource< types::carray< T > >:
Inheritance graph
[legend]

List of all members.

Public Types

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

Public Member Functions

virtual PartDataSourceclone () const
virtual PartDataSourcecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &replace) const
types::carray< T > get () const
 PartDataSource (types::carray< T > ref, base::DataSourceBase::shared_ptr parent)
types::carray< T > const & rvalue () const
void set (typename AssignableDataSource< types::carray< T > >::param_t t)
types::carray< T > & set ()
void updated ()
types::carray< T > value () const
 ~PartDataSource ()

Private Attributes

base::DataSourceBase::shared_ptr mparent
types::carray< T > mref

Detailed Description

template<typename T>
class RTT::internal::PartDataSource< types::carray< T > >

Partial specialisation of PartDataSource for carray<T> types.

Definition at line 142 of file PartDataSource.hpp.


Member Typedef Documentation

template<typename T >
typedef boost::intrusive_ptr<PartDataSource<T> > RTT::internal::PartDataSource< types::carray< T > >::shared_ptr

Use this type to store a pointer to an AssignableDataSource.

Reimplemented from RTT::internal::AssignableDataSource< types::carray< T > >.

Definition at line 152 of file PartDataSource.hpp.


Constructor & Destructor Documentation

template<typename T >
RTT::internal::PartDataSource< types::carray< T > >::~PartDataSource ( ) [inline]

Definition at line 150 of file PartDataSource.hpp.

template<typename T >
RTT::internal::PartDataSource< types::carray< T > >::PartDataSource ( types::carray< T >  ref,
base::DataSourceBase::shared_ptr  parent 
) [inline]

The part is constructed from a reference to a member variable of an existing struct.

Parameters:
refReference to the struct's variable.
parentA data source holding the struct.

Definition at line 160 of file PartDataSource.hpp.


Member Function Documentation

template<typename T >
virtual PartDataSource* RTT::internal::PartDataSource< types::carray< 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::AssignableDataSource< types::carray< T > >.

Definition at line 196 of file PartDataSource.hpp.

template<typename T >
virtual PartDataSource* RTT::internal::PartDataSource< types::carray< T > >::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  replace) const [inline, virtual]
template<typename T >
types::carray<T> RTT::internal::PartDataSource< types::carray< T > >::get ( ) const [inline, virtual]

Return the data as type T.

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

Definition at line 166 of file PartDataSource.hpp.

template<typename T >
types::carray<T> const& RTT::internal::PartDataSource< types::carray< 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< types::carray< T > >.

Definition at line 187 of file PartDataSource.hpp.

template<typename T >
void RTT::internal::PartDataSource< types::carray< T > >::set ( typename AssignableDataSource< types::carray< T > >::param_t  t) [inline]

Definition at line 176 of file PartDataSource.hpp.

template<typename T >
types::carray<T>& RTT::internal::PartDataSource< types::carray< T > >::set ( ) [inline, virtual]

Get a reference to the value of this DataSource. Getting a reference to an internal data structure is not thread-safe.

Implements RTT::internal::AssignableDataSource< types::carray< T > >.

Definition at line 182 of file PartDataSource.hpp.

template<typename T >
void RTT::internal::PartDataSource< types::carray< T > >::updated ( ) [inline, virtual]

In case the internal::DataSource returns a 'reference' type, call this method to notify it that the data was updated in the course of an invocation of get().

Reimplemented from RTT::base::DataSourceBase.

Definition at line 192 of file PartDataSource.hpp.

template<typename T >
types::carray<T> RTT::internal::PartDataSource< types::carray< 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< types::carray< T > >.

Definition at line 171 of file PartDataSource.hpp.


Member Data Documentation

Definition at line 148 of file PartDataSource.hpp.

template<typename T >
types::carray<T> RTT::internal::PartDataSource< types::carray< T > >::mref [private]

Definition at line 146 of file PartDataSource.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Sat Jun 8 2019 18:46:39