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

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

Inheritance diagram for FrameTransformSet_nwc_ros2_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	FrameTransformSet_nwc_ros2_ParamsParser ()

	~FrameTransformSet_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 ()

Public Attributes
const std::string	m_device_classname = {"FrameTransformSet_nwc_ros2"}

const std::string	m_device_name = {"frameTransformSet_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_GENERAL_period_defaultValue = {"0.01"}

const std::string	m_GENERAL_asynch_pub_defaultValue = {"1"}

const std::string	m_ROS2_ft_node_defaultValue = {"tfNodeSet"}

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}

double	m_GENERAL_period = {0.01}

int	m_GENERAL_asynch_pub = {1}

std::string	m_ROS2_ft_node = {"tfNodeSet"}

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 FrameTransformSet_nwc_ros2.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Description	Notes
GENERAL	refresh_interval	double	seconds	0.1	The time interval outside which timed ft will be deleted	-
GENERAL	period	double	seconds	0.01	The PeriodicThread period in seconds	-
GENERAL	asynch_pub	int	-	1	If 1, the fts will be published not only every "period" seconds but also when set functions are called	-
ROS2	ft_node	string	-	tfNodeSet	The name of the ROS2 node	-
ROS2	ft_topic	string	-	/tf	The name of the ROS2 topic from which fts will be received	-
ROS2	ft_topic_static	string	-	/tf_static	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 frameTransformSet_nwc_ros2 --GENERAL::refresh_interval 0.1 --GENERAL::period 0.01 --GENERAL::asynch_pub 1 --ROS2::ft_node tfNodeSet --ROS2::ft_topic /tf --ROS2::ft_topic_static /tf_static

yarpdev --device frameTransformSet_nwc_ros2

Definition at line 46 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

Constructor & Destructor Documentation

◆ FrameTransformSet_nwc_ros2_ParamsParser()

FrameTransformSet_nwc_ros2_ParamsParser::FrameTransformSet_nwc_ros2_ParamsParser ( )

Definition at line 23 of file FrameTransformSet_nwc_ros2_ParamsParser.cpp.

◆ ~FrameTransformSet_nwc_ros2_ParamsParser()

FrameTransformSet_nwc_ros2_ParamsParser::~FrameTransformSet_nwc_ros2_ParamsParser ( )

overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string FrameTransformSet_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 78 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ getDeviceName()

std::string FrameTransformSet_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 79 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string FrameTransformSet_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 176 of file FrameTransformSet_nwc_ros2_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > FrameTransformSet_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 FrameTransformSet_nwc_ros2_ParamsParser.cpp.

◆ parseParams()

bool FrameTransformSet_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 41 of file FrameTransformSet_nwc_ros2_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string FrameTransformSet_nwc_ros2_ParamsParser::m_device_classname = {"FrameTransformSet_nwc_ros2"}

Definition at line 53 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_device_name

const std::string FrameTransformSet_nwc_ros2_ParamsParser::m_device_name = {"frameTransformSet_nwc_ros2"}

Definition at line 54 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_GENERAL_asynch_pub

int FrameTransformSet_nwc_ros2_ParamsParser::m_GENERAL_asynch_pub = {1}

Definition at line 72 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_GENERAL_asynch_pub_defaultValue

const std::string FrameTransformSet_nwc_ros2_ParamsParser::m_GENERAL_asynch_pub_defaultValue = {"1"}

Definition at line 65 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_GENERAL_period

double FrameTransformSet_nwc_ros2_ParamsParser::m_GENERAL_period = {0.01}

Definition at line 71 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_GENERAL_period_defaultValue

const std::string FrameTransformSet_nwc_ros2_ParamsParser::m_GENERAL_period_defaultValue = {"0.01"}

Definition at line 64 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_GENERAL_refresh_interval

double FrameTransformSet_nwc_ros2_ParamsParser::m_GENERAL_refresh_interval = {0.1}

Definition at line 70 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_GENERAL_refresh_interval_defaultValue

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

Definition at line 63 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_parser_is_strict

bool FrameTransformSet_nwc_ros2_ParamsParser::m_parser_is_strict = false

Definition at line 55 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_parser_version

const parser_version_type FrameTransformSet_nwc_ros2_ParamsParser::m_parser_version = {}

Definition at line 61 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_node

std::string FrameTransformSet_nwc_ros2_ParamsParser::m_ROS2_ft_node = {"tfNodeSet"}

Definition at line 73 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_node_defaultValue

const std::string FrameTransformSet_nwc_ros2_ParamsParser::m_ROS2_ft_node_defaultValue = {"tfNodeSet"}

Definition at line 66 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_topic

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

Definition at line 74 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_topic_defaultValue

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

Definition at line 67 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_topic_static

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

Definition at line 75 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

◆ m_ROS2_ft_topic_static_defaultValue

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

Definition at line 68 of file FrameTransformSet_nwc_ros2_ParamsParser.h.

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

opt-modules/yarp-devices-ros2/src/devices/frameTransformSet_nwc_ros2/FrameTransformSet_nwc_ros2_ParamsParser.h
opt-modules/yarp-devices-ros2/src/devices/frameTransformSet_nwc_ros2/FrameTransformSet_nwc_ros2_ParamsParser.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FrameTransformSet_nwc_ros2_ParamsParser()

◆ ~FrameTransformSet_nwc_ros2_ParamsParser()

Member Function Documentation

◆ getDeviceClassName()

◆ getDeviceName()

◆ getDocumentationOfDeviceParams()

◆ getListOfParams()

◆ parseParams()

Member Data Documentation

◆ m_device_classname

◆ m_device_name

◆ m_GENERAL_asynch_pub

◆ m_GENERAL_asynch_pub_defaultValue

◆ m_GENERAL_period

◆ m_GENERAL_period_defaultValue

◆ m_GENERAL_refresh_interval

◆ m_GENERAL_refresh_interval_defaultValue

◆ m_parser_is_strict

◆ m_parser_version

◆ m_ROS2_ft_node

◆ m_ROS2_ft_node_defaultValue

◆ m_ROS2_ft_topic

◆ m_ROS2_ft_topic_defaultValue

◆ m_ROS2_ft_topic_static

◆ m_ROS2_ft_topic_static_defaultValue