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

#include <networkWrappers/RGBDSensorClient/RGBDSensorClient_ParamsParser.h>

Inheritance diagram for RGBDSensorClient_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	RGBDSensorClient_ParamsParser ()

	~RGBDSensorClient_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 = {"RGBDSensorClient"}

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

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.03"}

const std::string	m_localImagePort_defaultValue = {"/RGBD_nwc/Image:o"}

const std::string	m_localDepthPort_defaultValue = {"/RGBD_nwc/Depth:o"}

const std::string	m_remoteImagePort_defaultValue = {"/RGBD_nws/Image:o"}

const std::string	m_remoteDepthPort_defaultValue = {"/RGBD_nws/Depth:i"}

const std::string	m_localRpcPort_defaultValue = {"/RGBD_nwc/rpc:o"}

const std::string	m_remoteRpcPort_defaultValue = {"/RGBD_nws/rpc:i"}

const std::string	m_ImageCarrier_defaultValue = {"udp"}

const std::string	m_DepthCarrier_defaultValue = {"udp"}

double	m_period = {0.03}

std::string	m_localImagePort = {"/RGBD_nwc/Image:o"}

std::string	m_localDepthPort = {"/RGBD_nwc/Depth:o"}

std::string	m_remoteImagePort = {"/RGBD_nws/Image:o"}

std::string	m_remoteDepthPort = {"/RGBD_nws/Depth:i"}

std::string	m_localRpcPort = {"/RGBD_nwc/rpc:o"}

std::string	m_remoteRpcPort = {"/RGBD_nws/rpc:i"}

std::string	m_ImageCarrier = {"udp"}

std::string	m_DepthCarrier = {"udp"}

Detailed Description

This class is the parameters parser for class RGBDSensorClient.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	period	double	s	0.03	0	refresh period (in s) of the broadcasted values through yarp ports	default 0.03s
-	localImagePort	string	-	/RGBD_nwc/Image:o	1	Full name of the local image streaming port to open	-
-	localDepthPort	string	-	/RGBD_nwc/Depth:o	1	Full name of the local depth streaming port to open	-
-	remoteImagePort	string	-	/RGBD_nws/Image:o	1	Full name of the remote image port to connect to	-
-	remoteDepthPort	string	-	/RGBD_nws/Depth:i	1	Full name of the remote depth port to connect to	-
-	localRpcPort	string	-	/RGBD_nwc/rpc:o	1	Full name of the local rpc port to open	-
-	remoteRpcPort	string	-	/RGBD_nws/rpc:i	1	Full name of the remote rpc port to connect to	-
-	ImageCarrier	string	-	udp	0	Carrier for the image stream	-
-	DepthCarrier	string	-	udp	0	Carrier for the depth stream	-

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

yarpdev --device RGBDSensorClient --period 0.03 --localImagePort /RGBD_nwc/Image:o --localDepthPort /RGBD_nwc/Depth:o --remoteImagePort /RGBD_nws/Image:o --remoteDepthPort /RGBD_nws/Depth:i --localRpcPort /RGBD_nwc/rpc:o --remoteRpcPort /RGBD_nws/rpc:i --ImageCarrier udp --DepthCarrier udp

yarpdev --device RGBDSensorClient --localImagePort /RGBD_nwc/Image:o --localDepthPort /RGBD_nwc/Depth:o --remoteImagePort /RGBD_nws/Image:o --remoteDepthPort /RGBD_nws/Depth:i --localRpcPort /RGBD_nwc/rpc:o --remoteRpcPort /RGBD_nws/rpc:i

Definition at line 49 of file RGBDSensorClient_ParamsParser.h.

Constructor & Destructor Documentation

◆ RGBDSensorClient_ParamsParser()

RGBDSensorClient_ParamsParser::RGBDSensorClient_ParamsParser ( )

Definition at line 23 of file RGBDSensorClient_ParamsParser.cpp.

◆ ~RGBDSensorClient_ParamsParser()

RGBDSensorClient_ParamsParser::~RGBDSensorClient_ParamsParser ( )

overridedefault

Member Function Documentation

◆ getConfiguration()

std::string RGBDSensorClient_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 98 of file RGBDSensorClient_ParamsParser.cpp.

◆ getDeviceClassName()

std::string RGBDSensorClient_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 89 of file RGBDSensorClient_ParamsParser.h.

◆ getDeviceName()

std::string RGBDSensorClient_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 90 of file RGBDSensorClient_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string RGBDSensorClient_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 285 of file RGBDSensorClient_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > RGBDSensorClient_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 RGBDSensorClient_ParamsParser.cpp.

◆ getParamValue()

bool RGBDSensorClient_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 44 of file RGBDSensorClient_ParamsParser.cpp.

◆ parseParams()

bool RGBDSensorClient_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 108 of file RGBDSensorClient_ParamsParser.cpp.

Member Data Documentation

◆ m_DepthCarrier

std::string RGBDSensorClient_ParamsParser::m_DepthCarrier = {"udp"}

Definition at line 86 of file RGBDSensorClient_ParamsParser.h.

◆ m_DepthCarrier_defaultValue

const std::string RGBDSensorClient_ParamsParser::m_DepthCarrier_defaultValue = {"udp"}

Definition at line 76 of file RGBDSensorClient_ParamsParser.h.

◆ m_device_classname

const std::string RGBDSensorClient_ParamsParser::m_device_classname = {"RGBDSensorClient"}

Definition at line 56 of file RGBDSensorClient_ParamsParser.h.

◆ m_device_name

const std::string RGBDSensorClient_ParamsParser::m_device_name = {"RGBDSensorClient"}

Definition at line 57 of file RGBDSensorClient_ParamsParser.h.

◆ m_ImageCarrier

std::string RGBDSensorClient_ParamsParser::m_ImageCarrier = {"udp"}

Definition at line 85 of file RGBDSensorClient_ParamsParser.h.

◆ m_ImageCarrier_defaultValue

const std::string RGBDSensorClient_ParamsParser::m_ImageCarrier_defaultValue = {"udp"}

Definition at line 75 of file RGBDSensorClient_ParamsParser.h.

◆ m_localDepthPort

std::string RGBDSensorClient_ParamsParser::m_localDepthPort = {"/RGBD_nwc/Depth:o"}

Definition at line 80 of file RGBDSensorClient_ParamsParser.h.

◆ m_localDepthPort_defaultValue

const std::string RGBDSensorClient_ParamsParser::m_localDepthPort_defaultValue = {"/RGBD_nwc/Depth:o"}

Definition at line 70 of file RGBDSensorClient_ParamsParser.h.

◆ m_localImagePort

std::string RGBDSensorClient_ParamsParser::m_localImagePort = {"/RGBD_nwc/Image:o"}

Definition at line 79 of file RGBDSensorClient_ParamsParser.h.

◆ m_localImagePort_defaultValue

const std::string RGBDSensorClient_ParamsParser::m_localImagePort_defaultValue = {"/RGBD_nwc/Image:o"}

Definition at line 69 of file RGBDSensorClient_ParamsParser.h.

◆ m_localRpcPort

std::string RGBDSensorClient_ParamsParser::m_localRpcPort = {"/RGBD_nwc/rpc:o"}

Definition at line 83 of file RGBDSensorClient_ParamsParser.h.

◆ m_localRpcPort_defaultValue

const std::string RGBDSensorClient_ParamsParser::m_localRpcPort_defaultValue = {"/RGBD_nwc/rpc:o"}

Definition at line 73 of file RGBDSensorClient_ParamsParser.h.

◆ m_parser_is_strict

bool RGBDSensorClient_ParamsParser::m_parser_is_strict = false

Definition at line 58 of file RGBDSensorClient_ParamsParser.h.

◆ m_parser_version

const parser_version_type RGBDSensorClient_ParamsParser::m_parser_version = {}

Definition at line 64 of file RGBDSensorClient_ParamsParser.h.

◆ m_period

double RGBDSensorClient_ParamsParser::m_period = {0.03}

Definition at line 78 of file RGBDSensorClient_ParamsParser.h.

◆ m_period_defaultValue

const std::string RGBDSensorClient_ParamsParser::m_period_defaultValue = {"0.03"}

Definition at line 68 of file RGBDSensorClient_ParamsParser.h.

◆ m_provided_configuration

std::string RGBDSensorClient_ParamsParser::m_provided_configuration

Definition at line 66 of file RGBDSensorClient_ParamsParser.h.

◆ m_remoteDepthPort

std::string RGBDSensorClient_ParamsParser::m_remoteDepthPort = {"/RGBD_nws/Depth:i"}

Definition at line 82 of file RGBDSensorClient_ParamsParser.h.

◆ m_remoteDepthPort_defaultValue

const std::string RGBDSensorClient_ParamsParser::m_remoteDepthPort_defaultValue = {"/RGBD_nws/Depth:i"}

Definition at line 72 of file RGBDSensorClient_ParamsParser.h.

◆ m_remoteImagePort

std::string RGBDSensorClient_ParamsParser::m_remoteImagePort = {"/RGBD_nws/Image:o"}

Definition at line 81 of file RGBDSensorClient_ParamsParser.h.

◆ m_remoteImagePort_defaultValue

const std::string RGBDSensorClient_ParamsParser::m_remoteImagePort_defaultValue = {"/RGBD_nws/Image:o"}

Definition at line 71 of file RGBDSensorClient_ParamsParser.h.

◆ m_remoteRpcPort

std::string RGBDSensorClient_ParamsParser::m_remoteRpcPort = {"/RGBD_nws/rpc:i"}

Definition at line 84 of file RGBDSensorClient_ParamsParser.h.

◆ m_remoteRpcPort_defaultValue

const std::string RGBDSensorClient_ParamsParser::m_remoteRpcPort_defaultValue = {"/RGBD_nws/rpc:i"}

Definition at line 74 of file RGBDSensorClient_ParamsParser.h.

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

src/devices/networkWrappers/RGBDSensorClient/RGBDSensorClient_ParamsParser.h
src/devices/networkWrappers/RGBDSensorClient/RGBDSensorClient_ParamsParser.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RGBDSensorClient_ParamsParser()

◆ ~RGBDSensorClient_ParamsParser()

Member Function Documentation

◆ getConfiguration()

◆ getDeviceClassName()

◆ getDeviceName()

◆ getDocumentationOfDeviceParams()

◆ getListOfParams()

◆ getParamValue()

◆ parseParams()

Member Data Documentation

◆ m_DepthCarrier

◆ m_DepthCarrier_defaultValue

◆ m_device_classname

◆ m_device_name

◆ m_ImageCarrier

◆ m_ImageCarrier_defaultValue

◆ m_localDepthPort

◆ m_localDepthPort_defaultValue

◆ m_localImagePort

◆ m_localImagePort_defaultValue

◆ m_localRpcPort

◆ m_localRpcPort_defaultValue

◆ m_parser_is_strict

◆ m_parser_version

◆ m_period

◆ m_period_defaultValue

◆ m_provided_configuration

◆ m_remoteDepthPort

◆ m_remoteDepthPort_defaultValue

◆ m_remoteImagePort

◆ m_remoteImagePort_defaultValue

◆ m_remoteRpcPort

◆ m_remoteRpcPort_defaultValue