MultipleAnalogSensorsClient_ParamsParser Class Reference

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

#include <networkWrappers/multipleanalogsensorsclient/MultipleAnalogSensorsClient_ParamsParser.h>

Inheritance diagram for MultipleAnalogSensorsClient_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	MultipleAnalogSensorsClient_ParamsParser ()
	~MultipleAnalogSensorsClient_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 = {"MultipleAnalogSensorsClient"}
const std::string	m_device_name = {"multipleanalogsensorsclient"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_remote_defaultValue = {""}
const std::string	m_local_defaultValue = {""}
const std::string	m_timeout_defaultValue = {"0.02"}
const std::string	m_externalConnection_defaultValue = {"false"}
const std::string	m_carrier_defaultValue = {"tcp"}
std::string	m_remote = {}
std::string	m_local = {}
double	m_timeout = {0.02}
bool	m_externalConnection = {false}
std::string	m_carrier = {"tcp"}

Detailed Description

This class is the parameters parser for class MultipleAnalogSensorsClient.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	remote	string	-	-	1	Prefix of the ports to which to connect, opened by MultipleAnalogSensorsServer device.	-
-	local	string	-	-	1	Port prefix of the ports opened by this device.	-
-	timeout	double	s	0.02	0	Timeout after which the device reports an error if no measurement was received.	-
-	externalConnection	bool	-	false	0	If set to true, the connection to the rpc port of the MAS server is skipped and it is possible to connect to the data source externally after being opened	Use case: e.g yarpdataplayer source. Note that with this configuration some information like sensor name, frame name and sensor number will be not available.
-	carrier	string	-	tcp	0	The carier used for the connection with the server.	-

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

yarpdev --device multipleanalogsensorsclient --remote <mandatory_value> --local <mandatory_value> --timeout 0.02 --externalConnection false --carrier tcp

yarpdev --device multipleanalogsensorsclient --remote <mandatory_value> --local <mandatory_value>

Definition at line 45 of file MultipleAnalogSensorsClient_ParamsParser.h.

Constructor & Destructor Documentation

MultipleAnalogSensorsClient_ParamsParser()

MultipleAnalogSensorsClient_ParamsParser::MultipleAnalogSensorsClient_ParamsParser

(

)

Definition at line 23 of file MultipleAnalogSensorsClient_ParamsParser.cpp.

~MultipleAnalogSensorsClient_ParamsParser()

MultipleAnalogSensorsClient_ParamsParser::~MultipleAnalogSensorsClient_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string MultipleAnalogSensorsClient_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 75 of file MultipleAnalogSensorsClient_ParamsParser.h.

getDeviceName()

std::string MultipleAnalogSensorsClient_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 76 of file MultipleAnalogSensorsClient_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string MultipleAnalogSensorsClient_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 153 of file MultipleAnalogSensorsClient_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > MultipleAnalogSensorsClient_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 MultipleAnalogSensorsClient_ParamsParser.cpp.

parseParams()

bool MultipleAnalogSensorsClient_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 40 of file MultipleAnalogSensorsClient_ParamsParser.cpp.

Member Data Documentation

m_carrier

std::string MultipleAnalogSensorsClient_ParamsParser::m_carrier = {"tcp"}

Definition at line 72 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_carrier_defaultValue

const std::string MultipleAnalogSensorsClient_ParamsParser::m_carrier_defaultValue = {"tcp"}

Definition at line 66 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_device_classname

const std::string MultipleAnalogSensorsClient_ParamsParser::m_device_classname = {"MultipleAnalogSensorsClient"}

Definition at line 52 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_device_name

const std::string MultipleAnalogSensorsClient_ParamsParser::m_device_name = {"multipleanalogsensorsclient"}

Definition at line 53 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_externalConnection

bool MultipleAnalogSensorsClient_ParamsParser::m_externalConnection = {false}

Definition at line 71 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_externalConnection_defaultValue

const std::string MultipleAnalogSensorsClient_ParamsParser::m_externalConnection_defaultValue = {"false"}

Definition at line 65 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_local

std::string MultipleAnalogSensorsClient_ParamsParser::m_local = {}

Definition at line 69 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_local_defaultValue

const std::string MultipleAnalogSensorsClient_ParamsParser::m_local_defaultValue = {""}

Definition at line 63 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_parser_is_strict

bool MultipleAnalogSensorsClient_ParamsParser::m_parser_is_strict = false

Definition at line 54 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_parser_version

const parser_version_type MultipleAnalogSensorsClient_ParamsParser::m_parser_version = {}

Definition at line 60 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_remote

std::string MultipleAnalogSensorsClient_ParamsParser::m_remote = {}

Definition at line 68 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_remote_defaultValue

const std::string MultipleAnalogSensorsClient_ParamsParser::m_remote_defaultValue = {""}

Definition at line 62 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_timeout

double MultipleAnalogSensorsClient_ParamsParser::m_timeout = {0.02}

Definition at line 70 of file MultipleAnalogSensorsClient_ParamsParser.h.

m_timeout_defaultValue

const std::string MultipleAnalogSensorsClient_ParamsParser::m_timeout_defaultValue = {"0.02"}

Definition at line 64 of file MultipleAnalogSensorsClient_ParamsParser.h.

---

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

• src/devices/networkWrappers/multipleanalogsensorsclient/MultipleAnalogSensorsClient_ParamsParser.h
• src/devices/networkWrappers/multipleanalogsensorsclient/MultipleAnalogSensorsClient_ParamsParser.cpp