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

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

Inheritance diagram for ControlBoard_nws_ros2_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	ControlBoard_nws_ros2_ParamsParser ()

	~ControlBoard_nws_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 = {"ControlBoard_nws_ros2"}

const std::string	m_device_name = {"controlBoard_nws_ros2"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_node_name_defaultValue = {""}

const std::string	m_topic_name_defaultValue = {""}

const std::string	m_msgs_name_defaultValue = {""}

const std::string	m_period_defaultValue = {"0.02"}

std::string	m_node_name = {}

std::string	m_topic_name = {}

std::string	m_msgs_name = {}

double	m_period = {0.02}

Detailed Description

This class is the parameters parser for class ControlBoard_nws_ros2.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	node_name	string	-	-	1	set the name for ROS node	must not start with a leading '/'
-	topic_name	string	-	-	1	set the name for ROS topic	must start with a leading '/'
-	msgs_name	string	-	-	0	set the base name for the topics and interfaces	If it is not specified, the control related topics and services will not be initialized
-	period	double	s	0.02	0	refresh period of the broadcasted values in s	optional, default 20ms

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

yarpdev --device controlBoard_nws_ros2 --node_name <mandatory_value> --topic_name <mandatory_value> --msgs_name <optional_value> --period 0.02

yarpdev --device controlBoard_nws_ros2 --node_name <mandatory_value> --topic_name <mandatory_value>

Definition at line 44 of file ControlBoard_nws_ros2_ParamsParser.h.

Constructor & Destructor Documentation

◆ ControlBoard_nws_ros2_ParamsParser()

ControlBoard_nws_ros2_ParamsParser::ControlBoard_nws_ros2_ParamsParser ( )

Definition at line 23 of file ControlBoard_nws_ros2_ParamsParser.cpp.

◆ ~ControlBoard_nws_ros2_ParamsParser()

ControlBoard_nws_ros2_ParamsParser::~ControlBoard_nws_ros2_ParamsParser ( )

overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string ControlBoard_nws_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 ControlBoard_nws_ros2_ParamsParser.h.

◆ getDeviceName()

std::string ControlBoard_nws_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 ControlBoard_nws_ros2_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string ControlBoard_nws_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 138 of file ControlBoard_nws_ros2_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > ControlBoard_nws_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 ControlBoard_nws_ros2_ParamsParser.cpp.

◆ parseParams()

bool ControlBoard_nws_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 ControlBoard_nws_ros2_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string ControlBoard_nws_ros2_ParamsParser::m_device_classname = {"ControlBoard_nws_ros2"}

Definition at line 51 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_device_name

const std::string ControlBoard_nws_ros2_ParamsParser::m_device_name = {"controlBoard_nws_ros2"}

Definition at line 52 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_msgs_name

std::string ControlBoard_nws_ros2_ParamsParser::m_msgs_name = {}

Definition at line 68 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_msgs_name_defaultValue

const std::string ControlBoard_nws_ros2_ParamsParser::m_msgs_name_defaultValue = {""}

Definition at line 63 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_node_name

std::string ControlBoard_nws_ros2_ParamsParser::m_node_name = {}

Definition at line 66 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_node_name_defaultValue

const std::string ControlBoard_nws_ros2_ParamsParser::m_node_name_defaultValue = {""}

Definition at line 61 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_parser_is_strict

bool ControlBoard_nws_ros2_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_parser_version

const parser_version_type ControlBoard_nws_ros2_ParamsParser::m_parser_version = {}

Definition at line 59 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_period

double ControlBoard_nws_ros2_ParamsParser::m_period = {0.02}

Definition at line 69 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_period_defaultValue

const std::string ControlBoard_nws_ros2_ParamsParser::m_period_defaultValue = {"0.02"}

Definition at line 64 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_topic_name

std::string ControlBoard_nws_ros2_ParamsParser::m_topic_name = {}

Definition at line 67 of file ControlBoard_nws_ros2_ParamsParser.h.

◆ m_topic_name_defaultValue

const std::string ControlBoard_nws_ros2_ParamsParser::m_topic_name_defaultValue = {""}

Definition at line 62 of file ControlBoard_nws_ros2_ParamsParser.h.

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

opt-modules/yarp-devices-ros2/src/devices/controlBoard_nws_ros2/ControlBoard_nws_ros2_ParamsParser.h
opt-modules/yarp-devices-ros2/src/devices/controlBoard_nws_ros2/ControlBoard_nws_ros2_ParamsParser.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ControlBoard_nws_ros2_ParamsParser()

◆ ~ControlBoard_nws_ros2_ParamsParser()

Member Function Documentation

◆ getDeviceClassName()

◆ getDeviceName()

◆ getDocumentationOfDeviceParams()

◆ getListOfParams()

◆ parseParams()

Member Data Documentation

◆ m_device_classname

◆ m_device_name

◆ m_msgs_name

◆ m_msgs_name_defaultValue

◆ m_node_name

◆ m_node_name_defaultValue

◆ m_parser_is_strict

◆ m_parser_version

◆ m_period

◆ m_period_defaultValue

◆ m_topic_name

◆ m_topic_name_defaultValue