Public Member Functions | Private Member Functions | List of all members
ROSParamService Class Reference
Inheritance diagram for ROSParamService:
Inheritance graph
[legend]

Public Member Functions

 ROSParamService (TaskContext *owner)
 
- Public Member Functions inherited from RTT::Service
bool addLocalOperation (base::OperationBase &op)
 
Operation< Signature > & addOperation (Operation< Signature > &op)
 
Operation< Func > & addOperation (const std::string name, Func *func, ExecutionThread et=ClientThread)
 
Operation< typename internal::GetSignature< Func >::Signature > & addOperation (const std::string name, Func func, Class *obj, ExecutionThread et=ClientThread)
 
Operation< typename internal::GetSignatureDS< Func >::Signature > & addOperationDS (const std::string &name, Func func, internal::DataSource< boost::shared_ptr< ObjT > > *sp, ExecutionThread et=ClientThread)
 
Operation< Signature > & addOperationDS (internal::DataSource< boost::shared_ptr< ObjT > > *sp, Operation< Signature > &op)
 
virtual bool addService (shared_ptr obj)
 
Operation< Signature > & addSynchronousOperation (Operation< Signature > &op)
 
Operation< typename internal::GetSignature< Func >::Signature > & addSynchronousOperation (const std::string name, Func func, Class *obj, ExecutionThread et=ClientThread)
 
void clear ()
 
internal::OperationCallerC create (std::string name, ExecutionEngine *caller)
 
const std::string & doc () const
 
void doc (const std::string &description)
 
boost::shared_ptr< base::DisposableInterfacegetLocalOperation (std::string name)
 
const std::string & getName () const
 
OperationInterfacePartgetOperation (std::string name)
 
base::DataSourceBase::shared_ptr getOperation (std::string name, const std::vector< base::DataSourceBase::shared_ptr > &args, ExecutionEngine *caller) const
 
std::vector< std::string > getOperationNames () const
 
TaskContextgetOwner () const
 
ExecutionEnginegetOwnerExecutionEngine () const
 
shared_ptr getParent () const
 
virtual ProviderNames getProviderNames () const
 
shared_ptr getService (const std::string &service_name)
 
bool hasOperation (const std::string &name) const
 
bool hasService (const std::string &service_name)
 
Service::shared_ptr provides (const std::string &service_name)
 
Service::shared_ptr provides ()
 
void removeOperation (const std::string &name)
 
virtual void removeService (std::string const &service_name)
 
bool resetOperation (std::string name, base::OperationBase *impl)
 
 Service (const std::string &name, TaskContext *owner=0)
 
void setName (const std::string &name)
 
bool setOperationThread (std::string const &name, ExecutionThread et)
 
void setOwner (TaskContext *new_owner)
 
void setParent (shared_ptr new_parent)
 
virtual ~Service ()
 
- Public Member Functions inherited from RTT::OperationInterface
void add (const std::string &name, OperationInterfacePart *part)
 
void clear ()
 
Descriptions getArgumentList (const std::string &name) const
 
int getArity (const std::string &name) const
 
int getCollectArity (const std::string &name) const
 
std::string getDescription (const std::string &name) const
 
std::vector< std::string > getNames () const
 
OperationInterfacePartgetPart (const std::string &name)
 
std::string getResultType (const std::string &name) const
 
bool hasMember (const std::string &name) const
 
bool isSynchronous (const std::string &name) const
 
base::DataSourceBase::shared_ptr produce (const std::string &name, const Arguments &args, ExecutionEngine *caller) const
 
base::DataSourceBase::shared_ptr produceCollect (const std::string &name, const Arguments &args, internal::DataSource< bool >::shared_ptr blocking) const
 
base::DataSourceBase::shared_ptr produceHandle (const std::string &name) const
 
base::DataSourceBase::shared_ptr produceSend (const std::string &name, const Arguments &args, ExecutionEngine *caller) const
 
void remove (const std::string &name)
 
- Public Member Functions inherited from RTT::ConfigurationInterface
bool addAttribute (const std::string &name, T &attr)
 
Attribute< T > & addAttribute (const std::string &name, Attribute< T > &attr)
 
bool addAttribute (base::AttributeBase &a)
 
bool addConstant (const std::string &name, const T &cnst)
 
Constant< T > & addConstant (const std::string &name, Constant< T > &cnst)
 
bool addConstant (base::AttributeBase &c)
 
Property< T > & addProperty (const std::string &name, Property< T > &prop)
 
bool addProperty (base::PropertyBase &pb)
 
Property< T > & addProperty (const std::string &name, T &prop)
 
void clear ()
 
 ConfigurationInterface ()
 
ConfigurationInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &repl, bool instantiate) const
 
base::AttributeBasegetAttribute (const std::string &name) const
 
AttributeNames getAttributeNames () const
 
base::AttributeBasegetConstant (const std::string &name) const
 
base::PropertyBasegetProperty (const std::string &name) const
 
base::AttributeBasegetValue (const std::string &name) const
 
AttributeObjects const & getValues () const
 
bool hasAttribute (const std::string &name) const
 
bool hasProperty (const std::string &name) const
 
void loadValues (AttributeObjects const &new_values)
 
PropertyBagproperties ()
 
void removeAttribute (const std::string &name)
 
bool removeProperty (base::PropertyBase &p)
 
bool removeValue (const std::string &name)
 
bool setValue (base::AttributeBase *ab)
 
 ~ConfigurationInterface ()
 
- Public Member Functions inherited from RTT::DataFlowInterface
base::InputPortInterfaceaddEventPort (const std::string &name, base::InputPortInterface &port, SlotFunction callback=SlotFunction())
 
base::InputPortInterfaceaddEventPort (base::InputPortInterface &port, SlotFunction callback=SlotFunction())
 
base::InputPortInterfaceaddLocalEventPort (base::InputPortInterface &port, SlotFunction callback=SlotFunction())
 
base::PortInterfaceaddLocalPort (base::PortInterface &port)
 
base::PortInterfaceaddPort (const std::string &name, base::PortInterface &port)
 
base::PortInterfaceaddPort (base::PortInterface &port)
 
void clear ()
 
 DataFlowInterface (Service *parent=0)
 
void dataOnPort (base::PortInterface *port)
 
TaskContextgetOwner () const
 
base::PortInterfacegetPort (const std::string &name) const
 
std::string getPortDescription (const std::string &name) const
 
PortNames getPortNames () const
 
Ports getPorts () const
 
Type * getPortType (const std::string &name)
 
ServicegetService () const
 
void removeLocalPort (const std::string &name)
 
void removePort (const std::string &name)
 
bool setPortDescription (const std::string &name, const std::string description)
 
 ~DataFlowInterface ()
 

Private Member Functions

template<typename T , ResolutionPolicy P>
Property< T > & addRosParamProperty (const std::string &name)
 
bool get (const std::string &param_name, const unsigned int policy=(unsigned int) COMPONENT_PRIVATE)
 
template<typename T , ResolutionPolicy P>
bool getEigenVectorParamImpl (const std::string &ros_param_name, Eigen::Matrix< T, Eigen::Dynamic, 1 > &eigen_vector)
 
bool getParam (const std::string &ros_name, const std::string &rtt_name)
 
bool getParamAbsolute (const std::string &name)
 
bool getParamComponentAbsolute (const std::string &name)
 
bool getParamComponentPrivate (const std::string &name)
 
bool getParamComponentRelative (const std::string &name)
 
template<typename T , ResolutionPolicy P>
bool getParamImpl (const std::string &ros_param_name, T &value)
 
bool getParamPrivate (const std::string &name)
 
bool getParamRelative (const std::string &name)
 
bool getParams (RTT::Service::shared_ptr service, const std::string &ns)
 
bool getParams (const ResolutionPolicy policy)
 
bool getParamsAbsolute ()
 
bool getParamsComponentAbsolute ()
 
bool getParamsComponentPrivate ()
 
bool getParamsComponentRelative ()
 
bool getParamsPrivate ()
 
bool getParamsRelative ()
 
const std::string resolvedName (const std::string &param_name, const ResolutionPolicy policy)
 Resolve a parameter name based on the given ResolutionPolicy. More...
 
bool set (const std::string &param_name, const unsigned int policy=(unsigned int) COMPONENT_PRIVATE)
 
template<typename T , ResolutionPolicy P>
void setEigenVectorParamImpl (const std::string &ros_param_name, const Eigen::Matrix< T, Eigen::Dynamic, 1 > &eigen_vector)
 
bool setParam (const std::string &ros_name, const std::string &rtt_name)
 
bool setParamAbsolute (const std::string &name)
 
bool setParamComponentAbsolute (const std::string &name)
 
bool setParamComponentPrivate (const std::string &name)
 
bool setParamComponentRelative (const std::string &name)
 
template<typename T , ResolutionPolicy P>
void setParamImpl (const std::string &ros_param_name, const T &value)
 
bool setParamPrivate (const std::string &name)
 
bool setParamRelative (const std::string &name)
 
bool setParams (RTT::Service::shared_ptr service, const std::string &ns)
 
bool setParams (const ResolutionPolicy policy)
 
bool setParamsAbsolute ()
 
bool setParamsComponentAbsolute ()
 
bool setParamsComponentPrivate ()
 
bool setParamsComponentRelative ()
 
bool setParamsPrivate ()
 
bool setParamsRelative ()
 

Additional Inherited Members

- Public Types inherited from RTT::Service
typedef OperationInterface Factory
 
typedef std::vector< std::string > ProviderNames
 
typedef boost::shared_ptr< const Serviceshared_constptr
 
typedef boost::shared_ptr< Serviceshared_ptr
 
- Public Types inherited from RTT::OperationInterface
typedef std::vector< base::DataSourceBase::shared_ptrArguments
 
typedef std::vector< ArgumentDescriptionDescriptions
 
- Public Types inherited from RTT::ConfigurationInterface
typedef std::vector< std::string > AttributeNames
 
typedef std::vector< base::AttributeBase * > AttributeObjects
 
- Public Types inherited from RTT::DataFlowInterface
typedef std::vector< std::string > PortNames
 
typedef std::vector< base::PortInterface * > Ports
 
typedef boost::function< void(base::PortInterface *)> SlotFunction
 
- Static Public Member Functions inherited from RTT::Service
static Service::shared_ptr Create (const std::string &name, TaskContext *owner=0)
 
- Protected Types inherited from RTT::Service
typedef std::vector< base::OperationBase * > OperationList
 
typedef std::map< std::string, shared_ptrServices
 
typedef std::map< std::string, base::OperationBase * > SimpleOperations
 
- Protected Types inherited from RTT::OperationInterface
typedef std::map< std::string, OperationInterfacePart * > map_t
 
- Protected Types inherited from RTT::ConfigurationInterface
typedef std::vector< base::AttributeBase * > map_t
 
- Protected Member Functions inherited from RTT::Service
bool testOperation (base::OperationBase &op)
 
- Protected Member Functions inherited from RTT::ConfigurationInterface
bool chkPtr (const std::string &where, const std::string &name, const void *ptr)
 
- Protected Member Functions inherited from RTT::DataFlowInterface
bool chkPtr (const std::string &where, const std::string &name, const void *ptr)
 
ServicecreatePortObject (const std::string &name)
 
- Protected Attributes inherited from RTT::Service
std::string mdescription
 
std::string mname
 
TaskContextmowner
 
OperationList ownedoperations
 
shared_ptr parent
 
Services services
 
SimpleOperations simpleoperations
 
- Protected Attributes inherited from RTT::OperationInterface
map_t data
 
- Protected Attributes inherited from RTT::ConfigurationInterface
PropertyBag bag
 
map_t values
 
- Protected Attributes inherited from RTT::DataFlowInterface
Ports mports
 
Servicemservice
 

Detailed Description

Definition at line 55 of file rtt_rosparam_service.cpp.

Constructor & Destructor Documentation

ROSParamService::ROSParamService ( TaskContext owner)
inline

Definition at line 59 of file rtt_rosparam_service.cpp.

Member Function Documentation

template<typename T , ResolutionPolicy P>
Property<T>& ROSParamService::addRosParamProperty ( const std::string &  name)
inlineprivate

Adds a ROS parameter of supported types by ROS param as a property to this bag. The new property mirrors the value of the respective ROS parameter of the same name. Setting the value of the property sets the ROS parameter, and evaluating it loads the current value from the ROS parameter server.

Parameters
nameThe name of the ROS parameter and the property to be added.
Returns
the Property object by reference, which you can further query or document.

Definition at line 278 of file rtt_rosparam_service.cpp.

bool ROSParamService::get ( const std::string &  param_name,
const unsigned int  policy = (unsigned int) COMPONENT_PRIVATE 
)
private

Definition at line 885 of file rtt_rosparam_service.cpp.

template<typename T , ResolutionPolicy P>
bool ROSParamService::getEigenVectorParamImpl ( const std::string &  ros_param_name,
Eigen::Matrix< T, Eigen::Dynamic, 1 > &  eigen_vector 
)
inlineprivate

Definition at line 202 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParam ( const std::string &  ros_name,
const std::string &  rtt_name 
)
private

Definition at line 897 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamAbsolute ( const std::string &  name)
inlineprivate

Definition at line 239 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamComponentAbsolute ( const std::string &  name)
inlineprivate

Definition at line 243 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamComponentPrivate ( const std::string &  name)
inlineprivate

Definition at line 241 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamComponentRelative ( const std::string &  name)
inlineprivate

Definition at line 242 of file rtt_rosparam_service.cpp.

template<typename T , ResolutionPolicy P>
bool ROSParamService::getParamImpl ( const std::string &  ros_param_name,
T &  value 
)
inlineprivate

Definition at line 188 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamPrivate ( const std::string &  name)
inlineprivate

Definition at line 240 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamRelative ( const std::string &  name)
inlineprivate

Definition at line 238 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParams ( RTT::Service::shared_ptr  service,
const std::string &  ns 
)
private

Definition at line 946 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParams ( const ResolutionPolicy  policy)
private

Definition at line 941 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamsAbsolute ( )
inlineprivate

Definition at line 226 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamsComponentAbsolute ( )
inlineprivate

Definition at line 230 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamsComponentPrivate ( )
inlineprivate

Definition at line 228 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamsComponentRelative ( )
inlineprivate

Definition at line 229 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamsPrivate ( )
inlineprivate

Definition at line 227 of file rtt_rosparam_service.cpp.

bool ROSParamService::getParamsRelative ( )
inlineprivate

Definition at line 225 of file rtt_rosparam_service.cpp.

const std::string ROSParamService::resolvedName ( const std::string &  param_name,
const ResolutionPolicy  policy 
)
private

Resolve a parameter name based on the given ResolutionPolicy.

Definition at line 288 of file rtt_rosparam_service.cpp.

bool ROSParamService::set ( const std::string &  param_name,
const unsigned int  policy = (unsigned int) COMPONENT_PRIVATE 
)
private

Definition at line 509 of file rtt_rosparam_service.cpp.

template<typename T , ResolutionPolicy P>
void ROSParamService::setEigenVectorParamImpl ( const std::string &  ros_param_name,
const Eigen::Matrix< T, Eigen::Dynamic, 1 > &  eigen_vector 
)
inlineprivate

Definition at line 212 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParam ( const std::string &  ros_name,
const std::string &  rtt_name 
)
private

Definition at line 520 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamAbsolute ( const std::string &  name)
inlineprivate

Definition at line 261 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamComponentAbsolute ( const std::string &  name)
inlineprivate

Definition at line 265 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamComponentPrivate ( const std::string &  name)
inlineprivate

Definition at line 263 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamComponentRelative ( const std::string &  name)
inlineprivate

Definition at line 264 of file rtt_rosparam_service.cpp.

template<typename T , ResolutionPolicy P>
void ROSParamService::setParamImpl ( const std::string &  ros_param_name,
const T &  value 
)
inlineprivate

Definition at line 197 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamPrivate ( const std::string &  name)
inlineprivate

Definition at line 262 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamRelative ( const std::string &  name)
inlineprivate

Definition at line 260 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParams ( RTT::Service::shared_ptr  service,
const std::string &  ns 
)
private

Definition at line 552 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParams ( const ResolutionPolicy  policy)
private

Definition at line 547 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamsAbsolute ( )
inlineprivate

Definition at line 248 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamsComponentAbsolute ( )
inlineprivate

Definition at line 252 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamsComponentPrivate ( )
inlineprivate

Definition at line 250 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamsComponentRelative ( )
inlineprivate

Definition at line 251 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamsPrivate ( )
inlineprivate

Definition at line 249 of file rtt_rosparam_service.cpp.

bool ROSParamService::setParamsRelative ( )
inlineprivate

Definition at line 247 of file rtt_rosparam_service.cpp.


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