Classes | Macros | Functions
rtt_rosparam_service.cpp File Reference
#include <rtt/RTT.hpp>
#include <rtt/Property.hpp>
#include <rtt/internal/DataSource.hpp>
#include <rtt/plugin/ServicePlugin.hpp>
#include <rtt/types/PropertyDecomposition.hpp>
#include <boost/lexical_cast.hpp>
#include <boost/utility/enable_if.hpp>
#include <boost/type_traits/is_convertible.hpp>
#include <XmlRpcException.h>
#include <Eigen/Dense>
#include <ros/ros.h>
#include <rtt_rosparam/ros_param_data_source.hpp>
#include <rtt_rosparam/rosparam.h>
Include dependency graph for rtt_rosparam_service.cpp:

Go to the source code of this file.

Classes

class  ROSParamService
 
struct  XmlParamToValue< XMLRPCType, PropertyType, enabled >
 
struct  XmlParamToValue< XMLRPCType, PropertyType, typename boost::enable_if< boost::is_convertible< XMLRPCType, PropertyType > >::type >
 

Macros

#define ADD_ROSPARAM_OPERATION(return_type_str, return_type, func)
 
#define ADD_ROSPARAM_PROPERTY_OPERATION(return_type_str, return_type, func)
 
#define RETURN_RTT_PROPERTY_CONTAINER_TO_XML_PARAM(type, elem_type, prop)   if(castable< type >(prop)) { return rttPropertyToXmlParam< elem_type >(static_cast<const RTT::Property< type >*>(prop)->rvalue()); }
 
#define RETURN_RTT_PROPERTY_TO_XML_PARAM(type, prop)   if(castable< type >(prop)) { return rttPropertyToXmlParam< type >(static_cast<const RTT::Property< type >*>(prop)->rvalue()); }
 

Functions

template<class T >
bool castable (const RTT::base::PropertyBase *prop)
 Determine if the RTT property can be casted into an RTT::Property<T> More...
 
bool propertyIsSequence (RTT::base::PropertyBase *prop)
 
XmlRpc::XmlRpcValue rttPropertyBaseToXmlParam (RTT::base::PropertyBase *prop)
 Convert an abstract RTT PropertyBase to an XmlRpc value. More...
 
XmlRpc::XmlRpcValue rttPropertySequenceToXmlParam (RTT::base::PropertyBase *prop, const RTT::PropertyBag &bag)
 
template<class T >
XmlRpc::XmlRpcValue rttPropertyToXmlParam (const T &prop)
 Convert a value to an XmlRpc value. More...
 
template<class T >
XmlRpc::XmlRpcValue rttPropertyToXmlParam (const std::vector< T > &vec)
 Convert a std::vector<T> to an XmlRpc array value. More...
 
template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam (const Eigen::VectorXd &vec)
 
template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam (const Eigen::VectorXf &vec)
 
template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam< char > (const char &prop)
 
template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam< float > (const float &prop)
 
template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam< RTT::PropertyBag > (const RTT::PropertyBag &bag)
 Convert a PropertyBag to an XmlRpc struct value. More...
 
template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam< unsigned char > (const unsigned char &prop)
 
template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam< unsigned int > (const unsigned int &prop)
 
bool xmlParamArrayToProp (const XmlRpc::XmlRpcValue &xml_value, RTT::Property< RTT::PropertyBag > *prop)
 
bool xmlParamStructToProp (const XmlRpc::XmlRpcValue &xml_value, RTT::Property< RTT::PropertyBag > *prop)
 
template<class T >
bool xmlParamToProp (const XmlRpc::XmlRpcValue &xml_value, RTT::Property< T > *prop)
 Convert an XmlRpc value into an RTT property. More...
 
template<class T >
bool xmlParamToProp (const XmlRpc::XmlRpcValue &xml_value, RTT::Property< std::vector< T > > *prop)
 Convert an XmlRpc array value into an RTT std::vector property. More...
 
template<>
bool xmlParamToProp (const XmlRpc::XmlRpcValue &xml_value, RTT::Property< Eigen::VectorXd > *prop)
 Convert an XmlRpc array value into an RTT Eigen::VectorXd property. More...
 
template<>
bool xmlParamToProp (const XmlRpc::XmlRpcValue &xml_value, RTT::Property< Eigen::VectorXf > *prop)
 
bool xmlParamToProp (const XmlRpc::XmlRpcValue &xml_value, RTT::base::PropertyBase *prop_base)
 Convert an XmlRpc structure value into an abstract RTT PropertyBase. More...
 
template<>
bool xmlParamToProp< bool > (const XmlRpc::XmlRpcValue &xml_value, RTT::Property< std::vector< bool > > *prop)
 
template<>
bool xmlParamToProp< RTT::PropertyBag > (const XmlRpc::XmlRpcValue &xml_value, RTT::Property< RTT::PropertyBag > *prop)
 Convert an XmlRpc structure value into an RTT PropertyBag property. More...
 
template<class PropertyType >
bool xmlParamToValue (const XmlRpc::XmlRpcValue &xml_value, PropertyType &value)
 Convert an XmlRpc value to type T. More...
 

Macro Definition Documentation

#define ADD_ROSPARAM_OPERATION (   return_type_str,
  return_type,
  func 
)
Value:
this->addOperation("get"#return_type_str, &ROSParamService::get##func< return_type , RELATIVE >, this).doc("Get a " #return_type " from rosparam"); \
this->addOperation("set"#return_type_str, &ROSParamService::set##func< return_type , RELATIVE >, this).doc("Set a " #return_type " in rosparam"); \
this->addOperation("get"#return_type_str"Relative", &ROSParamService::get##func< return_type , RELATIVE >, this).doc("Get a " #return_type " from rosparam using the relative resolution policy : `relative/param`"); \
this->addOperation("set"#return_type_str"Relative", &ROSParamService::set##func< return_type , RELATIVE >, this).doc("Set a " #return_type " in rosparam using the relative resolution policy : `relative/param`"); \
this->addOperation("get"#return_type_str"Absolute", &ROSParamService::get##func< return_type , ABSOLUTE >, this).doc("Get a " #return_type " from rosparam using the absolute resolution policy : `/global/param`"); \
this->addOperation("set"#return_type_str"Absolute", &ROSParamService::set##func< return_type , ABSOLUTE >, this).doc("Set a " #return_type " in rosparam using the absolute resolution policy : `/global/param`"); \
this->addOperation("get"#return_type_str"Private", &ROSParamService::get##func< return_type , PRIVATE >, this).doc("Get a " #return_type " from rosparam using the private resolution policy : `~private/param`"); \
this->addOperation("set"#return_type_str"Private", &ROSParamService::set##func< return_type , PRIVATE >, this).doc("Set a " #return_type " in rosparam using the private resolution policy : `~private/param`"); \
this->addOperation("get"#return_type_str"ComponentPrivate", &ROSParamService::get##func< return_type , COMPONENT_PRIVATE >, this).doc("Get a " #return_type " from rosparam using the following resolution policy : `~component_name/param`"); \
this->addOperation("set"#return_type_str"ComponentPrivate", &ROSParamService::set##func< return_type , COMPONENT_PRIVATE >, this).doc("Set a " #return_type " in rosparam using the following resolution policy : `~component_name/param`"); \
this->addOperation("get"#return_type_str"ComponentRelative", &ROSParamService::get##func< return_type , COMPONENT_RELATIVE >, this).doc("Get a " #return_type " from rosparam using the following resolution policy : `component_name/param`"); \
this->addOperation("set"#return_type_str"ComponentRelative", &ROSParamService::set##func< return_type , COMPONENT_RELATIVE >, this).doc("Set a " #return_type " in rosparam using the following resolution policy : `component_name/param`"); \
this->addOperation("get"#return_type_str"ComponentAbsolute", &ROSParamService::get##func< return_type , COMPONENT_ABSOLUTE >, this).doc("Get a " #return_type " from rosparam using the following resolution policy : `/component_name/param`"); \
this->addOperation("set"#return_type_str"ComponentAbsolute", &ROSParamService::set##func< return_type , COMPONENT_ABSOLUTE >, this).doc("Set a " #return_type " in rosparam using the following resolution policy : `/component_name/param`");
ROSParamService::set
bool set(const std::string &param_name, const unsigned int policy=(unsigned int) COMPONENT_PRIVATE)
Definition: rtt_rosparam_service.cpp:509
ROSParamService::get
bool get(const std::string &param_name, const unsigned int policy=(unsigned int) COMPONENT_PRIVATE)
Definition: rtt_rosparam_service.cpp:885

Definition at line 21 of file rtt_rosparam_service.cpp.

#define ADD_ROSPARAM_PROPERTY_OPERATION (   return_type_str,
  return_type,
  func 
)
Value:
this->addOperation("addRosParamProperty"#return_type_str, &ROSParamService::addRosParamProperty<return_type, RELATIVE>, this).doc("Adds a Property to the owner component that is linked to a ROS property of the same name").arg("name", "name of the ROS parameter, the property generated will use the same name"); \
this->addOperation("addRosParamProperty"#return_type_str"Relative", &ROSParamService::addRosParamProperty<return_type, RELATIVE>, this).doc("Adds a Property to the owner component that is linked to a ROS property of the same name").arg("name", "name of the ROS parameter, the property generated will use the same name"); \
this->addOperation("addRosParamProperty"#return_type_str"Absolute", &ROSParamService::addRosParamProperty<return_type, ABSOLUTE>, this).doc("Adds a Property to the owner component that is linked to a ROS property of the same name").arg("name", "name of the ROS parameter, the property generated will use the same name"); \
this->addOperation("addRosParamProperty"#return_type_str"Private", &ROSParamService::addRosParamProperty<return_type, PRIVATE>, this).doc("Adds a Property to the owner component that is linked to a ROS property of the same name").arg("name", "name of the ROS parameter, the property generated will use the same name"); \
this->addOperation("addRosParamProperty"#return_type_str"ComponentPrivate", &ROSParamService::addRosParamProperty<return_type, COMPONENT_PRIVATE>, this).doc("Adds a Property to the owner component that is linked to a ROS property of the same name").arg("name", "name of the ROS parameter, the property generated will use the same name"); \
this->addOperation("addRosParamProperty"#return_type_str"ComponentRelative", &ROSParamService::addRosParamProperty<return_type, COMPONENT_RELATIVE>, this).doc("Adds a Property to the owner component that is linked to a ROS property of the same name").arg("name", "name of the ROS parameter, the property generated will use the same name"); \
this->addOperation("addRosParamProperty"#return_type_str"ComponentAbsolute", &ROSParamService::addRosParamProperty<return_type, COMPONENT_ABSOLUTE>, this).doc("Adds a Property to the owner component that is linked to a ROS property of the same name").arg("name", "name of the ROS parameter, the property generated will use the same name");

Definition at line 39 of file rtt_rosparam_service.cpp.

#define RETURN_RTT_PROPERTY_CONTAINER_TO_XML_PARAM (   type,
  elem_type,
  prop 
)    if(castable< type >(prop)) { return rttPropertyToXmlParam< elem_type >(static_cast<const RTT::Property< type >*>(prop)->rvalue()); }

Definition at line 464 of file rtt_rosparam_service.cpp.

#define RETURN_RTT_PROPERTY_TO_XML_PARAM (   type,
  prop 
)    if(castable< type >(prop)) { return rttPropertyToXmlParam< type >(static_cast<const RTT::Property< type >*>(prop)->rvalue()); }

Definition at line 461 of file rtt_rosparam_service.cpp.

Function Documentation

template<class T >
bool castable ( const RTT::base::PropertyBase *  prop)

Determine if the RTT property can be casted into an RTT::Property<T>

Definition at line 343 of file rtt_rosparam_service.cpp.

bool propertyIsSequence ( RTT::base::PropertyBase *  prop)

Definition at line 439 of file rtt_rosparam_service.cpp.

XmlRpc::XmlRpcValue rttPropertyBaseToXmlParam ( RTT::base::PropertyBase *  prop)

Convert an abstract RTT PropertyBase to an XmlRpc value.

Definition at line 467 of file rtt_rosparam_service.cpp.

XmlRpc::XmlRpcValue rttPropertySequenceToXmlParam ( RTT::base::PropertyBase *  prop,
const RTT::PropertyBag &  bag 
)

Definition at line 446 of file rtt_rosparam_service.cpp.

template<class T >
XmlRpc::XmlRpcValue rttPropertyToXmlParam ( const T &  prop)

Convert a value to an XmlRpc value.

Definition at line 349 of file rtt_rosparam_service.cpp.

template<class T >
XmlRpc::XmlRpcValue rttPropertyToXmlParam ( const std::vector< T > &  vec)

Convert a std::vector<T> to an XmlRpc array value.

Definition at line 399 of file rtt_rosparam_service.cpp.

template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam ( const Eigen::VectorXd &  vec)

Definition at line 412 of file rtt_rosparam_service.cpp.

template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam ( const Eigen::VectorXf &  vec)

Definition at line 425 of file rtt_rosparam_service.cpp.

template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam< char > ( const char &  prop)

Definition at line 367 of file rtt_rosparam_service.cpp.

template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam< float > ( const float &  prop)

Definition at line 355 of file rtt_rosparam_service.cpp.

template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam< RTT::PropertyBag > ( const RTT::PropertyBag &  bag)

Convert a PropertyBag to an XmlRpc struct value.

Definition at line 379 of file rtt_rosparam_service.cpp.

template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam< unsigned char > ( const unsigned char &  prop)

Definition at line 373 of file rtt_rosparam_service.cpp.

template<>
XmlRpc::XmlRpcValue rttPropertyToXmlParam< unsigned int > ( const unsigned int &  prop)

Definition at line 361 of file rtt_rosparam_service.cpp.

bool xmlParamArrayToProp ( const XmlRpc::XmlRpcValue &  xml_value,
RTT::Property< RTT::PropertyBag > *  prop 
)

Definition at line 769 of file rtt_rosparam_service.cpp.

bool xmlParamStructToProp ( const XmlRpc::XmlRpcValue &  xml_value,
RTT::Property< RTT::PropertyBag > *  prop 
)

Definition at line 746 of file rtt_rosparam_service.cpp.

template<class T >
bool xmlParamToProp ( const XmlRpc::XmlRpcValue &  xml_value,
RTT::Property< T > *  prop 
)

Convert an XmlRpc value into an RTT property.

Definition at line 622 of file rtt_rosparam_service.cpp.

template<class T >
bool xmlParamToProp ( const XmlRpc::XmlRpcValue &  xml_value,
RTT::Property< std::vector< T > > *  prop 
)

Convert an XmlRpc array value into an RTT std::vector property.

Definition at line 637 of file rtt_rosparam_service.cpp.

template<>
bool xmlParamToProp ( const XmlRpc::XmlRpcValue &  xml_value,
RTT::Property< Eigen::VectorXd > *  prop 
)

Convert an XmlRpc array value into an RTT Eigen::VectorXd property.

Definition at line 691 of file rtt_rosparam_service.cpp.

template<>
bool xmlParamToProp ( const XmlRpc::XmlRpcValue &  xml_value,
RTT::Property< Eigen::VectorXf > *  prop 
)

Definition at line 719 of file rtt_rosparam_service.cpp.

bool xmlParamToProp ( const XmlRpc::XmlRpcValue &  xml_value,
RTT::base::PropertyBase *  prop_base 
)

Convert an XmlRpc structure value into an abstract RTT PropertyBase.

Definition at line 807 of file rtt_rosparam_service.cpp.

template<>
bool xmlParamToProp< bool > ( const XmlRpc::XmlRpcValue &  xml_value,
RTT::Property< std::vector< bool > > *  prop 
)

Definition at line 663 of file rtt_rosparam_service.cpp.

template<>
bool xmlParamToProp< RTT::PropertyBag > ( const XmlRpc::XmlRpcValue &  xml_value,
RTT::Property< RTT::PropertyBag > *  prop 
)

Convert an XmlRpc structure value into an RTT PropertyBag property.

Definition at line 788 of file rtt_rosparam_service.cpp.

template<class PropertyType >
bool xmlParamToValue ( const XmlRpc::XmlRpcValue &  xml_value,
PropertyType &  value 
)

Convert an XmlRpc value to type T.

Definition at line 607 of file rtt_rosparam_service.cpp.


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