RawValuesPublisherClient_ParamsParser Class Reference

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

#include <RawValuesPublisherClient_ParamsParser.h>

Inheritance diagram for RawValuesPublisherClient_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	RawValuesPublisherClient_ParamsParser ()
	~RawValuesPublisherClient_ParamsParser ()=default
bool	parseParams (const yarp::os::Searchable &config)
std::string	getDeviceClassName () const
std::string	getDeviceName () const
std::string	getDocumentationOfDeviceParams () const
std::vector< std::string >	getListOfParams () const

Public Attributes
const std::string	m_device_classname = {"RawValuesPublisherClient"}
const std::string	m_device_name = {"rawValuesPublisherClient"}
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_externalConnection_defaultValue = {"false"}
const std::string	m_carrier_defaultValue = {"tcp"}
std::string	m_remote = {}
std::string	m_local = {}
bool	m_externalConnection = {false}
std::string	m_carrier = {"tcp"}

Detailed Description

This class is the parameters parser for class RawValuesPublisherClient.

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 RawValuesParameterSensorsServer device.	-
-	local	string	-	-	1	Port prefix of the ports opened by this device.	-
-	externalConnection	bool	-	false	0	If set to true, the connection to the rpc port of the RVP server is skipped and it is possible to connect to the data source externally after being opened	-
-	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 rawValuesPublisherClient --remote <mandatory_value> --local <mandatory_value> --externalConnection false --carrier tcp

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

Definition at line 47 of file RawValuesPublisherClient_ParamsParser.h.

Constructor & Destructor Documentation

RawValuesPublisherClient_ParamsParser()

RawValuesPublisherClient_ParamsParser::RawValuesPublisherClient_ParamsParser

(

)

Definition at line 23 of file RawValuesPublisherClient_ParamsParser.cpp.

~RawValuesPublisherClient_ParamsParser()

RawValuesPublisherClient_ParamsParser::~RawValuesPublisherClient_ParamsParser ( )

default

Member Function Documentation

getDeviceClassName()

std::string RawValuesPublisherClient_ParamsParser::getDeviceClassName ( ) const

inline

Definition at line 75 of file RawValuesPublisherClient_ParamsParser.h.

getDeviceName()

std::string RawValuesPublisherClient_ParamsParser::getDeviceName ( ) const

inline

Definition at line 76 of file RawValuesPublisherClient_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string RawValuesPublisherClient_ParamsParser::getDocumentationOfDeviceParams

(

)

const

Definition at line 138 of file RawValuesPublisherClient_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > RawValuesPublisherClient_ParamsParser::getListOfParams

(

)

const

Definition at line 28 of file RawValuesPublisherClient_ParamsParser.cpp.

parseParams()

bool RawValuesPublisherClient_ParamsParser::parseParams

(

const yarp::os::Searchable &

config

)

Definition at line 39 of file RawValuesPublisherClient_ParamsParser.cpp.

Member Data Documentation

m_carrier

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

Definition at line 72 of file RawValuesPublisherClient_ParamsParser.h.

m_carrier_defaultValue

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

Definition at line 67 of file RawValuesPublisherClient_ParamsParser.h.

m_device_classname

const std::string RawValuesPublisherClient_ParamsParser::m_device_classname = {"RawValuesPublisherClient"}

Definition at line 54 of file RawValuesPublisherClient_ParamsParser.h.

m_device_name

const std::string RawValuesPublisherClient_ParamsParser::m_device_name = {"rawValuesPublisherClient"}

Definition at line 55 of file RawValuesPublisherClient_ParamsParser.h.

m_externalConnection

bool RawValuesPublisherClient_ParamsParser::m_externalConnection = {false}

Definition at line 71 of file RawValuesPublisherClient_ParamsParser.h.

m_externalConnection_defaultValue

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

Definition at line 66 of file RawValuesPublisherClient_ParamsParser.h.

m_local

std::string RawValuesPublisherClient_ParamsParser::m_local = {}

Definition at line 70 of file RawValuesPublisherClient_ParamsParser.h.

m_local_defaultValue

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

Definition at line 65 of file RawValuesPublisherClient_ParamsParser.h.

m_parser_is_strict

bool RawValuesPublisherClient_ParamsParser::m_parser_is_strict = false

Definition at line 56 of file RawValuesPublisherClient_ParamsParser.h.

m_parser_version

const parser_version_type RawValuesPublisherClient_ParamsParser::m_parser_version = {}

Definition at line 62 of file RawValuesPublisherClient_ParamsParser.h.

m_remote

std::string RawValuesPublisherClient_ParamsParser::m_remote = {}

Definition at line 69 of file RawValuesPublisherClient_ParamsParser.h.

m_remote_defaultValue

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

Definition at line 64 of file RawValuesPublisherClient_ParamsParser.h.

---

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

• icub-main/src/libraries/icubmod/rawValuesPublisherClient/RawValuesPublisherClient_ParamsParser.h
• icub-main/src/libraries/icubmod/rawValuesPublisherClient/RawValuesPublisherClient_ParamsParser.cpp