YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
FrameTransformGet_nwc_ros2_ParamsParser Class Reference

This class is the parameters parser for class FrameTransformGet_nwc_ros2. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-devices-ros2/src/devices/frameTransformGet_nwc_ros2/FrameTransformGet_nwc_ros2_ParamsParser.h>

+ Inheritance diagram for FrameTransformGet_nwc_ros2_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 FrameTransformGet_nwc_ros2_ParamsParser ()
 
 ~FrameTransformGet_nwc_ros2_ParamsParser () override=default
 
bool parseParams (const yarp::os::Searchable &config) override
 Parse the DeviceDriver parameters.
 
std::string getDeviceClassName () const override
 Get the name of the DeviceDriver class.
 
std::string getDeviceName () const override
 Get the name of the device (i.e.
 
std::string getDocumentationOfDeviceParams () const override
 Get the documentation of the DeviceDriver's parameters.
 
std::vector< std::string > getListOfParams () const override
 Return a list of all params used by the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 
virtual bool getParamValue (const std::string &paramName, std::string &paramValue) const =0
 Return the value (represented as a string) of the requested parameter.
 
virtual std::string getConfiguration () const =0
 Return the configuration of the device.
 

Public Attributes

const std::string m_device_classname = {"FrameTransformGet_nwc_ros2"}
 
const std::string m_device_name = {"frameTransformGet_nwc_ros2"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_GENERAL_refresh_interval_defaultValue = {"0.1"}
 
const std::string m_ROS2_ft_node_defaultValue = {"tfNodeGet"}
 
const std::string m_ROS2_ft_topic_defaultValue = {"/tf"}
 
const std::string m_ROS2_ft_topic_static_defaultValue = {"/tf_static"}
 
double m_GENERAL_refresh_interval = {0.1}
 
std::string m_ROS2_ft_node = {"tfNodeGet"}
 
std::string m_ROS2_ft_topic = {"/tf"}
 
std::string m_ROS2_ft_topic_static = {"/tf_static"}
 

Detailed Description

This class is the parameters parser for class FrameTransformGet_nwc_ros2.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
GENERAL refresh_interval double seconds 0.1 0 The time interval outside which timed ft will be deleted -
ROS2 ft_node string - tfNodeGet 0 The name of the ROS2 node -
ROS2 ft_topic string - /tf 0 The name of the ROS2 topic from which fts will be received -
ROS2 ft_topic_static string - /tf_static 0 The name of the ROS2 topic from which static fts will be received -

The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):

yarpdev --device frameTransformGet_nwc_ros2 --GENERAL::refresh_interval 0.1 --ROS2::ft_node tfNodeGet --ROS2::ft_topic /tf --ROS2::ft_topic_static /tf_static
yarpdev --device frameTransformGet_nwc_ros2

Definition at line 44 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

Constructor & Destructor Documentation

◆ FrameTransformGet_nwc_ros2_ParamsParser()

FrameTransformGet_nwc_ros2_ParamsParser::FrameTransformGet_nwc_ros2_ParamsParser ( )

Definition at line 23 of file FrameTransformGet_nwc_ros2_ParamsParser.cpp.

◆ ~FrameTransformGet_nwc_ros2_ParamsParser()

FrameTransformGet_nwc_ros2_ParamsParser::~FrameTransformGet_nwc_ros2_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string FrameTransformGet_nwc_ros2_ParamsParser::getDeviceClassName ( ) const
inlineoverridevirtual

Get the name of the DeviceDriver class.

Returns
A string containing the name of the class.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 72 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ getDeviceName()

std::string FrameTransformGet_nwc_ros2_ParamsParser::getDeviceName ( ) const
inlineoverridevirtual

Get the name of the device (i.e.

the plugin name).

Returns
A string containing the name of the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 73 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string FrameTransformGet_nwc_ros2_ParamsParser::getDocumentationOfDeviceParams ( ) const
overridevirtual

Get the documentation of the DeviceDriver's parameters.

Returns
A string containing the documentation.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 142 of file FrameTransformGet_nwc_ros2_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > FrameTransformGet_nwc_ros2_ParamsParser::getListOfParams ( ) const
overridevirtual

Return a list of all params used by the device.

Returns
A vector containing the names of parameters used by the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 28 of file FrameTransformGet_nwc_ros2_ParamsParser.cpp.

◆ parseParams()

bool FrameTransformGet_nwc_ros2_ParamsParser::parseParams ( const yarp::os::Searchable &  config)
overridevirtual

Parse the DeviceDriver parameters.

Returns
true if the parsing is successful, false otherwise

Implements yarp::dev::IDeviceDriverParams.

Definition at line 39 of file FrameTransformGet_nwc_ros2_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string FrameTransformGet_nwc_ros2_ParamsParser::m_device_classname = {"FrameTransformGet_nwc_ros2"}

Definition at line 51 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_device_name

const std::string FrameTransformGet_nwc_ros2_ParamsParser::m_device_name = {"frameTransformGet_nwc_ros2"}

Definition at line 52 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_GENERAL_refresh_interval

double FrameTransformGet_nwc_ros2_ParamsParser::m_GENERAL_refresh_interval = {0.1}

Definition at line 66 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_GENERAL_refresh_interval_defaultValue

const std::string FrameTransformGet_nwc_ros2_ParamsParser::m_GENERAL_refresh_interval_defaultValue = {"0.1"}

Definition at line 61 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_parser_is_strict

bool FrameTransformGet_nwc_ros2_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_parser_version

const parser_version_type FrameTransformGet_nwc_ros2_ParamsParser::m_parser_version = {}

Definition at line 59 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_node

std::string FrameTransformGet_nwc_ros2_ParamsParser::m_ROS2_ft_node = {"tfNodeGet"}

Definition at line 67 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_node_defaultValue

const std::string FrameTransformGet_nwc_ros2_ParamsParser::m_ROS2_ft_node_defaultValue = {"tfNodeGet"}

Definition at line 62 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_topic

std::string FrameTransformGet_nwc_ros2_ParamsParser::m_ROS2_ft_topic = {"/tf"}

Definition at line 68 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_topic_defaultValue

const std::string FrameTransformGet_nwc_ros2_ParamsParser::m_ROS2_ft_topic_defaultValue = {"/tf"}

Definition at line 63 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_topic_static

std::string FrameTransformGet_nwc_ros2_ParamsParser::m_ROS2_ft_topic_static = {"/tf_static"}

Definition at line 69 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_topic_static_defaultValue

const std::string FrameTransformGet_nwc_ros2_ParamsParser::m_ROS2_ft_topic_static_defaultValue = {"/tf_static"}

Definition at line 64 of file FrameTransformGet_nwc_ros2_ParamsParser.h.

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