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

#include <DataSources.hpp>

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

Public Types

typedef boost::intrusive_ptr< ConstReferenceDataSource< 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 ConstReferenceDataSource< T > * clone () const
 
 ConstReferenceDataSource (typename DataSource< T >::const_reference_t ref)
 
virtual ConstReferenceDataSource< T > * copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
 
DataSource< T >::result_t get () const
 
DataSource< T >::const_reference_t rvalue () const
 
DataSource< T >::result_t value () const
 
 ~ConstReferenceDataSource ()
 
- 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 ()
 
virtual void * getRawPointer ()
 
virtual bool isAssignable () const
 
void ref () const
 
virtual void reset ()
 
std::string toString ()
 
virtual bool update (DataSourceBase *other)
 
virtual ActionInterfaceupdateAction (DataSourceBase *other)
 
virtual void updated ()
 
std::ostream & write (std::ostream &os)
 

Private Attributes

DataSource< T >::const_reference_t mref
 

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::ConstReferenceDataSource< T >

A DataSource which is used to read a const reference to an external value.

Parameters
TThe result data type of get().

Definition at line 156 of file DataSources.hpp.

Member Typedef Documentation

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

Definition at line 167 of file DataSources.hpp.

Constructor & Destructor Documentation

Use shared_ptr.

Member Function Documentation

template<typename T>
virtual ConstReferenceDataSource<T>* RTT::internal::ConstReferenceDataSource< T >::clone ( ) const
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 >.

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

Return the data as type T.

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

Definition at line 171 of file DataSources.hpp.

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

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

Member Data Documentation

template<typename T>
DataSource<T>::const_reference_t RTT::internal::ConstReferenceDataSource< T >::mref
private

Definition at line 160 of file DataSources.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