Public Types | Public Member Functions | Private Attributes | List of all members
rtt_rosparam::RosParamDataSource< T > Class Template Reference

#include <ros_param_data_source.hpp>

Inheritance diagram for rtt_rosparam::RosParamDataSource< T >:
Inheritance graph
[legend]

Public Types

typedef boost::intrusive_ptr< RosParamDataSource< 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 RosParamDataSource< T > * clone () const
 
virtual RosParamDataSource< T > * copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &already_cloned) const
 
bool evaluate () const
 
internal::DataSource< T >::result_t get () const
 
 RosParamDataSource (std::string param_name_id)
 
internal::DataSource< T >::const_reference_t rvalue () const
 
void set (typename internal::AssignableDataSource< T >::param_t t)
 
internal::AssignableDataSource< T >::reference_t set ()
 
void updated ()
 
internal::DataSource< T >::result_t value () const
 
 ~RosParamDataSource ()
 
- 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)
 
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

internal::DataSource< T >::value_t mcached_data_
 
std::string mparam_name_
 

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_rosparam::RosParamDataSource< T >

A DataSource which checks the ROS parameter server and it returns the parameter value in its get() method. It sets the parameter value in its set() method. The constructor receives the full qualified property name attached to the DataSource.
Warning The properties with a RosParamDataSource<T> are not real-time safe and therefore this DataSource shouldn't be used in the updateHook() of a real-time component.

Definition at line 54 of file ros_param_data_source.hpp.

Member Typedef Documentation

template<typename T>
typedef boost::intrusive_ptr< RosParamDataSource<T> > rtt_rosparam::RosParamDataSource< T >::shared_ptr

Definition at line 65 of file ros_param_data_source.hpp.

Constructor & Destructor Documentation

template<typename T>
rtt_rosparam::RosParamDataSource< T >::~RosParamDataSource ( )
inline

Definition at line 67 of file ros_param_data_source.hpp.

template<typename T>
rtt_rosparam::RosParamDataSource< T >::RosParamDataSource ( std::string  param_name_id)
inline

Definition at line 71 of file ros_param_data_source.hpp.

Member Function Documentation

template<typename T>
virtual RosParamDataSource<T>* rtt_rosparam::RosParamDataSource< T >::clone ( ) const
inlinevirtual
template<typename T>
virtual RosParamDataSource<T>* rtt_rosparam::RosParamDataSource< T >::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  already_cloned) const
inlinevirtual
template<typename T>
bool rtt_rosparam::RosParamDataSource< T >::evaluate ( ) const
inlinevirtual

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

Definition at line 83 of file ros_param_data_source.hpp.

template<typename T>
internal::DataSource<T>::result_t rtt_rosparam::RosParamDataSource< T >::get ( ) const
inlinevirtual

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

Definition at line 77 of file ros_param_data_source.hpp.

template<typename T>
internal::DataSource<T>::const_reference_t rtt_rosparam::RosParamDataSource< T >::rvalue ( ) const
inlinevirtual

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

Definition at line 100 of file ros_param_data_source.hpp.

template<typename T>
void rtt_rosparam::RosParamDataSource< T >::set ( typename internal::AssignableDataSource< T >::param_t  t)
inline

Definition at line 105 of file ros_param_data_source.hpp.

template<typename T>
internal::AssignableDataSource<T>::reference_t rtt_rosparam::RosParamDataSource< T >::set ( )
inlinevirtual
template<typename T>
void rtt_rosparam::RosParamDataSource< T >::updated ( )
inlinevirtual

Reimplemented from RTT::base::DataSourceBase.

Definition at line 119 of file ros_param_data_source.hpp.

template<typename T>
internal::DataSource<T>::result_t rtt_rosparam::RosParamDataSource< T >::value ( ) const
inlinevirtual

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

Definition at line 92 of file ros_param_data_source.hpp.

Member Data Documentation

template<typename T>
internal::DataSource<T>::value_t rtt_rosparam::RosParamDataSource< T >::mcached_data_
mutableprivate

Definition at line 61 of file ros_param_data_source.hpp.

template<typename T>
std::string rtt_rosparam::RosParamDataSource< T >::mparam_name_
private

Stores the full-qualified property name of the ROS parameter

Definition at line 60 of file ros_param_data_source.hpp.


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


rtt_rosparam
Author(s): Ruben Smits
autogenerated on Mon May 10 2021 02:45:11