Public Types | Public Member Functions | Private Attributes | List of all members
RTT::internal::PartDataSource< T > Class Template Reference

#include <PartDataSource.hpp>

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

Public Types

typedef boost::intrusive_ptr< PartDataSource< T > > shared_ptr
 
- Public Types inherited from RTT::internal::AssignableDataSource< T >
typedef boost::intrusive_ptr< const AssignableDataSource< T > > const_ptr
 
typedef DataSource< T >::const_reference_t const_reference_t
 
typedef boost::call_traits< value_t >::param_type param_t
 
typedef boost::call_traits< value_t >::reference reference_t
 
typedef boost::intrusive_ptr< AssignableDataSource< T > > shared_ptr
 
typedef DataSource< T >::value_t value_t
 
- Public Types inherited from RTT::internal::DataSource< T >
typedef boost::intrusive_ptr< const DataSource< T > > const_ptr
 
typedef details::GetConstRef< T >::type const_reference_t
 
typedef T result_t
 
typedef boost::intrusive_ptr< DataSource< T > > shared_ptr
 
typedef T value_t
 
- Public Types inherited from RTT::base::DataSourceBase
typedef boost::intrusive_ptr< const DataSourceBaseconst_ptr
 
typedef boost::intrusive_ptr< DataSourceBaseshared_ptr
 

Public Member Functions

virtual PartDataSource< T > * clone () const
 
virtual PartDataSource< T > * copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &replace) const
 
DataSource< T >::result_t get () const
 
 PartDataSource (typename AssignableDataSource< T >::reference_t ref, base::DataSourceBase::shared_ptr parent)
 
AssignableDataSource< T >::const_reference_t rvalue () const
 
void set (typename AssignableDataSource< T >::param_t t)
 
AssignableDataSource< T >::reference_t set ()
 
void updated ()
 
DataSource< T >::result_t value () const
 
 ~PartDataSource ()
 
- Public Member Functions inherited from RTT::internal::AssignableDataSource< T >
void * getRawPointer ()
 
virtual bool isAssignable () const
 
virtual void set (param_t t)=0
 
virtual bool update (base::DataSourceBase *other)
 
virtual base::ActionInterfaceupdateAction (base::DataSourceBase *other)
 
- Public Member Functions inherited from RTT::internal::DataSource< T >
 BOOST_STATIC_ASSERT (!details::HasConst< T >::value)
 
virtual bool evaluate () const
 
void const * getRawConstPointer ()
 
virtual std::string getType () const
 
virtual const types::TypeInfogetTypeInfo () const
 
virtual std::string getTypeName () const
 
- Public Member Functions inherited from RTT::base::DataSourceBase
virtual DataSourceBasecopy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const =0
 
 DataSourceBase ()
 
void deref () const
 
virtual shared_ptr getMember (const std::string &member_name)
 
virtual shared_ptr getMember (DataSourceBase::shared_ptr member_id, DataSourceBase::shared_ptr offset)
 
virtual std::vector< std::string > getMemberNames () const
 
virtual shared_ptr getParent ()
 
void ref () const
 
virtual void reset ()
 
std::string toString ()
 
std::ostream & write (std::ostream &os)
 

Private Attributes

base::DataSourceBase::shared_ptr mparent
 
AssignableDataSource< T >::reference_t mref
 

Additional Inherited Members

- Static Public Member Functions inherited from RTT::internal::AssignableDataSource< T >
static AssignableDataSource< T > * narrow (base::DataSourceBase *db)
 
- Static Public Member Functions inherited from RTT::internal::DataSource< T >
static std::string GetType ()
 
static const types::TypeInfoGetTypeInfo ()
 
static std::string GetTypeName ()
 
static DataSource< T > * narrow (base::DataSourceBase *db)
 
- Static Public Member Functions inherited from RTT::base::DataSourceBase
static const_ptr stack_const_ptr (const DataSourceBase *dsb)
 
static shared_ptr stack_shared_ptr (DataSourceBase *dsb)
 
- Protected Member Functions inherited from RTT::internal::AssignableDataSource< T >
 ~AssignableDataSource ()
 
- Protected Member Functions inherited from RTT::internal::DataSource< T >
virtual ~DataSource ()
 
- Protected Member Functions inherited from RTT::base::DataSourceBase
virtual ~DataSourceBase ()
 
- Protected Attributes inherited from RTT::base::DataSourceBase
os::AtomicInt refcount
 

Detailed Description

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

A DataSource which is used to manipulate a reference to a part of a data source.

It recalculates the reference of the part in case of copy/clone semantics.

Parameters
TThe data type of an element.

Definition at line 58 of file PartDataSource.hpp.

Member Typedef Documentation

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

Definition at line 68 of file PartDataSource.hpp.

Constructor & Destructor Documentation

template<typename T>
RTT::internal::PartDataSource< T >::~PartDataSource ( )
inline

Definition at line 66 of file PartDataSource.hpp.

template<typename T>
RTT::internal::PartDataSource< T >::PartDataSource ( typename AssignableDataSource< T >::reference_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 76 of file PartDataSource.hpp.

Member Function Documentation

template<typename T>
virtual PartDataSource<T>* RTT::internal::PartDataSource< T >::clone ( ) const
inlinevirtual

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< T >.

Definition at line 112 of file PartDataSource.hpp.

template<typename T>
virtual PartDataSource<T>* RTT::internal::PartDataSource< T >::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  replace) const
inlinevirtual

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

Definition at line 116 of file PartDataSource.hpp.

template<typename T>
DataSource<T>::result_t RTT::internal::PartDataSource< T >::get ( ) const
inlinevirtual

Return the data as type T.

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

Definition at line 82 of file PartDataSource.hpp.

template<typename T>
AssignableDataSource<T>::const_reference_t RTT::internal::PartDataSource< T >::rvalue ( ) const
inlinevirtual

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 103 of file PartDataSource.hpp.

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

Definition at line 92 of file PartDataSource.hpp.

template<typename T>
AssignableDataSource<T>::reference_t RTT::internal::PartDataSource< T >::set ( )
inlinevirtual

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< T >.

Definition at line 98 of file PartDataSource.hpp.

template<typename T>
void RTT::internal::PartDataSource< T >::updated ( )
inlinevirtual

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 108 of file PartDataSource.hpp.

template<typename T>
DataSource<T>::result_t RTT::internal::PartDataSource< T >::value ( ) const
inlinevirtual

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 87 of file PartDataSource.hpp.

Member Data Documentation

template<typename T>
base::DataSourceBase::shared_ptr RTT::internal::PartDataSource< T >::mparent
private

Definition at line 64 of file PartDataSource.hpp.

template<typename T>
AssignableDataSource<T>::reference_t RTT::internal::PartDataSource< T >::mref
private

Definition at line 62 of file PartDataSource.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Tue Jun 25 2019 19:33:45