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

#include <DataObjectDataSource.hpp>

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

Public Types

typedef boost::intrusive_ptr< DataObjectDataSource< T > > shared_ptr
 
- 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 DataObjectDataSource< T > * clone () const
 
virtual DataObjectDataSource< T > * copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
 
 DataObjectDataSource (typename base::DataObjectInterface< T >::shared_ptr obj)
 
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
 
virtual ~DataObjectDataSource ()
 
- Public Member Functions inherited from RTT::internal::DataSource< T >
 BOOST_STATIC_ASSERT (!details::HasConst< T >::value)
 
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 ()
 
virtual void * getRawPointer ()
 
virtual bool isAssignable () const
 
void ref () const
 
std::string toString ()
 
virtual bool update (DataSourceBase *other)
 
virtual ActionInterfaceupdateAction (DataSourceBase *other)
 
virtual void updated ()
 
std::ostream & write (std::ostream &os)
 

Private Attributes

mcopy
 
base::DataObjectInterface< T >::shared_ptr mobject
 

Additional Inherited Members

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

Definition at line 56 of file DataObjectDataSource.hpp.

Member Typedef Documentation

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

Definition at line 62 of file DataObjectDataSource.hpp.

Constructor & Destructor Documentation

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

Definition at line 64 of file DataObjectDataSource.hpp.

template<typename T >
virtual RTT::internal::DataObjectDataSource< T >::~DataObjectDataSource ( )
inlinevirtual

Definition at line 68 of file DataObjectDataSource.hpp.

Member Function Documentation

template<typename T >
virtual DataObjectDataSource<T>* RTT::internal::DataObjectDataSource< 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::DataSource< T >.

Definition at line 93 of file DataObjectDataSource.hpp.

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

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

Definition at line 96 of file DataObjectDataSource.hpp.

template<typename T >
bool RTT::internal::DataObjectDataSource< T >::evaluate ( ) const
inlinevirtual

Force an evaluation of the DataSourceBase.

Returns
true on successful evaluation.

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

Definition at line 70 of file DataObjectDataSource.hpp.

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

Return the data as type T.

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

Definition at line 75 of file DataObjectDataSource.hpp.

template<typename T >
virtual void RTT::internal::DataObjectDataSource< T >::reset ( )
inlinevirtual

Reset the data to initial values.

Reimplemented from RTT::base::DataSourceBase.

Definition at line 91 of file DataObjectDataSource.hpp.

template<typename T >
DataSource<T>::const_reference_t RTT::internal::DataObjectDataSource< 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 86 of file DataObjectDataSource.hpp.

template<typename T >
DataSource<T>::result_t RTT::internal::DataObjectDataSource< 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 81 of file DataObjectDataSource.hpp.

Member Data Documentation

template<typename T >
T RTT::internal::DataObjectDataSource< T >::mcopy
mutableprivate

Definition at line 60 of file DataObjectDataSource.hpp.

template<typename T >
base::DataObjectInterface<T>::shared_ptr RTT::internal::DataObjectDataSource< T >::mobject
private

Definition at line 59 of file DataObjectDataSource.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:46