Map2D_nwc_yarp_ParamsParser Class Reference

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

#include <networkWrappers/map2D_nwc_yarp/Map2D_nwc_yarp_ParamsParser.h>

Inheritance diagram for Map2D_nwc_yarp_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	Map2D_nwc_yarp_ParamsParser ()
	~Map2D_nwc_yarp_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 = {"Map2D_nwc_yarp"}
const std::string	m_device_name = {"map2D_nwc_yarp"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_local_defaultValue = {""}
const std::string	m_remote_defaultValue = {""}
const std::string	m_carrier_defaultValue = {"fast_tcp"}
std::string	m_local = {}
std::string	m_remote = {}
std::string	m_carrier = {"fast_tcp"}

Detailed Description

This class is the parameters parser for class Map2D_nwc_yarp.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	local	string	-	-	1	Full port name opened by the Map2D_nwc_yarp device.	-
-	remote	string	-	-	1	Full port name of the port remotely opened by the Map2D_nws_yarp, to which the Map2D_nwc_yarp connects to.	-
-	carrier	string	-	fast_tcp	0	The carrier 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 map2D_nwc_yarp --local <mandatory_value> --remote <mandatory_value> --carrier fast_tcp

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

Definition at line 43 of file Map2D_nwc_yarp_ParamsParser.h.

Constructor & Destructor Documentation

Map2D_nwc_yarp_ParamsParser()

Map2D_nwc_yarp_ParamsParser::Map2D_nwc_yarp_ParamsParser

(

)

Definition at line 23 of file Map2D_nwc_yarp_ParamsParser.cpp.

~Map2D_nwc_yarp_ParamsParser()

Map2D_nwc_yarp_ParamsParser::~Map2D_nwc_yarp_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string Map2D_nwc_yarp_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 69 of file Map2D_nwc_yarp_ParamsParser.h.

getDeviceName()

std::string Map2D_nwc_yarp_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 70 of file Map2D_nwc_yarp_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string Map2D_nwc_yarp_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 123 of file Map2D_nwc_yarp_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > Map2D_nwc_yarp_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 Map2D_nwc_yarp_ParamsParser.cpp.

parseParams()

bool Map2D_nwc_yarp_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 38 of file Map2D_nwc_yarp_ParamsParser.cpp.

Member Data Documentation

m_carrier

std::string Map2D_nwc_yarp_ParamsParser::m_carrier = {"fast_tcp"}

Definition at line 66 of file Map2D_nwc_yarp_ParamsParser.h.

m_carrier_defaultValue

const std::string Map2D_nwc_yarp_ParamsParser::m_carrier_defaultValue = {"fast_tcp"}

Definition at line 62 of file Map2D_nwc_yarp_ParamsParser.h.

m_device_classname

const std::string Map2D_nwc_yarp_ParamsParser::m_device_classname = {"Map2D_nwc_yarp"}

Definition at line 50 of file Map2D_nwc_yarp_ParamsParser.h.

m_device_name

const std::string Map2D_nwc_yarp_ParamsParser::m_device_name = {"map2D_nwc_yarp"}

Definition at line 51 of file Map2D_nwc_yarp_ParamsParser.h.

m_local

std::string Map2D_nwc_yarp_ParamsParser::m_local = {}

Definition at line 64 of file Map2D_nwc_yarp_ParamsParser.h.

m_local_defaultValue

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

Definition at line 60 of file Map2D_nwc_yarp_ParamsParser.h.

m_parser_is_strict

bool Map2D_nwc_yarp_ParamsParser::m_parser_is_strict = false

Definition at line 52 of file Map2D_nwc_yarp_ParamsParser.h.

m_parser_version

const parser_version_type Map2D_nwc_yarp_ParamsParser::m_parser_version = {}

Definition at line 58 of file Map2D_nwc_yarp_ParamsParser.h.

m_remote

std::string Map2D_nwc_yarp_ParamsParser::m_remote = {}

Definition at line 65 of file Map2D_nwc_yarp_ParamsParser.h.

m_remote_defaultValue

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

Definition at line 61 of file Map2D_nwc_yarp_ParamsParser.h.

---

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

• src/devices/networkWrappers/map2D_nwc_yarp/Map2D_nwc_yarp_ParamsParser.h
• src/devices/networkWrappers/map2D_nwc_yarp/Map2D_nwc_yarp_ParamsParser.cpp