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

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

Inheritance diagram for RgbdSensor_nws_ros2_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	RgbdSensor_nws_ros2_ParamsParser ()

	~RgbdSensor_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.

bool	getParamValue (const std::string &paramName, std::string &paramValue) const override
	Return the value (represented as a string) of the requested parameter.

std::string	getConfiguration () const override
	Return the configuration of the device.

Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

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

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

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

std::string	m_provided_configuration

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

const std::string	m_node_name_defaultValue = {""}

const std::string	m_color_topic_name_defaultValue = {""}

const std::string	m_depth_topic_name_defaultValue = {""}

const std::string	m_force_info_synch_defaultValue = {"0"}

const std::string	m_depth_frame_id_defaultValue = {""}

const std::string	m_color_frame_id_defaultValue = {""}

double	m_period = {0.02}

std::string	m_node_name = {}

std::string	m_color_topic_name = {}

std::string	m_depth_topic_name = {}

int	m_force_info_synch = {0}

std::string	m_depth_frame_id = {}

std::string	m_color_frame_id = {}

Detailed Description

This class is the parameters parser for class RgbdSensor_nws_ros2.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	period	double	s	0.02	0	refresh period of the broadcasted values in s	-
-	node_name	string	-	-	1	name of the ros2 node	-
-	color_topic_name	string	-	-	1	ros rgb topic (it's also the base name for the rgb camera_info topic)	must start with a leading '/'
-	depth_topic_name	string	-	-	1	ros depth topic (it's also the base name for the depth camera_info topic)	must start with a leading '/'
-	force_info_synch	int	-	0	0	if 1, it forces synching images time stamp with and cameras time stamp	-
-	depth_frame_id	string	-	-	1	The depth image frame	-
-	color_frame_id	string	-	-	1	The color image frame	-

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

yarpdev --device rgbdSensor_nws_ros2 --period 0.02 --node_name <mandatory_value> --color_topic_name <mandatory_value> --depth_topic_name <mandatory_value> --force_info_synch 0 --depth_frame_id <mandatory_value> --color_frame_id <mandatory_value>

yarpdev --device rgbdSensor_nws_ros2 --node_name <mandatory_value> --color_topic_name <mandatory_value> --depth_topic_name <mandatory_value> --depth_frame_id <mandatory_value> --color_frame_id <mandatory_value>

Definition at line 47 of file RgbdSensor_nws_ros2_ParamsParser.h.

Constructor & Destructor Documentation

◆ RgbdSensor_nws_ros2_ParamsParser()

RgbdSensor_nws_ros2_ParamsParser::RgbdSensor_nws_ros2_ParamsParser ( )

Definition at line 23 of file RgbdSensor_nws_ros2_ParamsParser.cpp.

◆ ~RgbdSensor_nws_ros2_ParamsParser()

RgbdSensor_nws_ros2_ParamsParser::~RgbdSensor_nws_ros2_ParamsParser ( )

overridedefault

Member Function Documentation

◆ getConfiguration()

std::string RgbdSensor_nws_ros2_ParamsParser::getConfiguration ( ) const

overridevirtual

Return the configuration of the device.

Returns: The configuration of the device, represented in a string format.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 86 of file RgbdSensor_nws_ros2_ParamsParser.cpp.

◆ getDeviceClassName()

std::string RgbdSensor_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 83 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ getDeviceName()

std::string RgbdSensor_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 84 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string RgbdSensor_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 243 of file RgbdSensor_nws_ros2_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > RgbdSensor_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 RgbdSensor_nws_ros2_ParamsParser.cpp.

◆ getParamValue()

bool RgbdSensor_nws_ros2_ParamsParser::getParamValue	(	const std::string &	paramName,
		std::string &	paramValue
	)		const

overridevirtual

Return the value (represented as a string) of the requested parameter.

Returns: True if the requested parameter was succesfully retrieved.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 42 of file RgbdSensor_nws_ros2_ParamsParser.cpp.

◆ parseParams()

bool RgbdSensor_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 96 of file RgbdSensor_nws_ros2_ParamsParser.cpp.

Member Data Documentation

◆ m_color_frame_id

std::string RgbdSensor_nws_ros2_ParamsParser::m_color_frame_id = {}

Definition at line 80 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_color_frame_id_defaultValue

const std::string RgbdSensor_nws_ros2_ParamsParser::m_color_frame_id_defaultValue = {""}

Definition at line 72 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_color_topic_name

std::string RgbdSensor_nws_ros2_ParamsParser::m_color_topic_name = {}

Definition at line 76 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_color_topic_name_defaultValue

const std::string RgbdSensor_nws_ros2_ParamsParser::m_color_topic_name_defaultValue = {""}

Definition at line 68 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_depth_frame_id

std::string RgbdSensor_nws_ros2_ParamsParser::m_depth_frame_id = {}

Definition at line 79 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_depth_frame_id_defaultValue

const std::string RgbdSensor_nws_ros2_ParamsParser::m_depth_frame_id_defaultValue = {""}

Definition at line 71 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_depth_topic_name

std::string RgbdSensor_nws_ros2_ParamsParser::m_depth_topic_name = {}

Definition at line 77 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_depth_topic_name_defaultValue

const std::string RgbdSensor_nws_ros2_ParamsParser::m_depth_topic_name_defaultValue = {""}

Definition at line 69 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_device_classname

const std::string RgbdSensor_nws_ros2_ParamsParser::m_device_classname = {"RgbdSensor_nws_ros2"}

Definition at line 54 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_device_name

const std::string RgbdSensor_nws_ros2_ParamsParser::m_device_name = {"rgbdSensor_nws_ros2"}

Definition at line 55 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_force_info_synch

int RgbdSensor_nws_ros2_ParamsParser::m_force_info_synch = {0}

Definition at line 78 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_force_info_synch_defaultValue

const std::string RgbdSensor_nws_ros2_ParamsParser::m_force_info_synch_defaultValue = {"0"}

Definition at line 70 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_node_name

std::string RgbdSensor_nws_ros2_ParamsParser::m_node_name = {}

Definition at line 75 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_node_name_defaultValue

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

Definition at line 67 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_parser_is_strict

bool RgbdSensor_nws_ros2_ParamsParser::m_parser_is_strict = false

Definition at line 56 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_parser_version

const parser_version_type RgbdSensor_nws_ros2_ParamsParser::m_parser_version = {}

Definition at line 62 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_period

double RgbdSensor_nws_ros2_ParamsParser::m_period = {0.02}

Definition at line 74 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_period_defaultValue

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

Definition at line 66 of file RgbdSensor_nws_ros2_ParamsParser.h.

◆ m_provided_configuration

std::string RgbdSensor_nws_ros2_ParamsParser::m_provided_configuration

Definition at line 64 of file RgbdSensor_nws_ros2_ParamsParser.h.

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

opt-modules/yarp-devices-ros2/src/devices/rgbdSensor_nws_ros2/RgbdSensor_nws_ros2_ParamsParser.h
opt-modules/yarp-devices-ros2/src/devices/rgbdSensor_nws_ros2/RgbdSensor_nws_ros2_ParamsParser.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RgbdSensor_nws_ros2_ParamsParser()

◆ ~RgbdSensor_nws_ros2_ParamsParser()

Member Function Documentation

◆ getConfiguration()

◆ getDeviceClassName()

◆ getDeviceName()

◆ getDocumentationOfDeviceParams()

◆ getListOfParams()

◆ getParamValue()

◆ parseParams()

Member Data Documentation

◆ m_color_frame_id

◆ m_color_frame_id_defaultValue

◆ m_color_topic_name

◆ m_color_topic_name_defaultValue

◆ m_depth_frame_id

◆ m_depth_frame_id_defaultValue

◆ m_depth_topic_name

◆ m_depth_topic_name_defaultValue

◆ m_device_classname

◆ m_device_name

◆ m_force_info_synch

◆ m_force_info_synch_defaultValue

◆ m_node_name

◆ m_node_name_defaultValue

◆ m_parser_is_strict

◆ m_parser_version

◆ m_period

◆ m_period_defaultValue

◆ m_provided_configuration