JoypadControlServer_ParamsParser Class Reference

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

#include <networkWrappers/JoypadControlServer/JoypadControlServer_ParamsParser.h>

Inheritance diagram for JoypadControlServer_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	JoypadControlServer_ParamsParser ()
	~JoypadControlServer_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 = {"JoypadControlServer"}
const std::string	m_device_name = {"JoypadControlServer"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_period_defaultValue = {"0.01"}
const std::string	m_name_defaultValue = {"/robotName/joypad"}
const std::string	m_use_separate_ports_defaultValue = {"true"}
const std::string	m_profile_defaultValue = {"false"}
double	m_period = {0.01}
std::string	m_name = {"/robotName/joypad"}
bool	m_use_separate_ports = {true}
bool	m_profile = {false}

Detailed Description

This class is the parameters parser for class JoypadControlServer.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	period	double	s	0.01	0	Refresh period (in s) of the broadcasted values through yarp ports	-
-	name	string	-	/robotName/joypad	1	Prefix name of the ports opened by the JoypadControlServer	-
-	use_separate_ports	bool	-	true	0	set it to 1 to use separate ports (buttons, axes, trackballs, hats) and 0 to stream all in one single port	-
-	profile	bool	-	false	0	print the joypad data for debugging purpose	-

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

yarpdev --device JoypadControlServer --period 0.01 --name /robotName/joypad --use_separate_ports true --profile false

yarpdev --device JoypadControlServer --name /robotName/joypad

Definition at line 44 of file JoypadControlServer_ParamsParser.h.

Constructor & Destructor Documentation

JoypadControlServer_ParamsParser()

JoypadControlServer_ParamsParser::JoypadControlServer_ParamsParser

(

)

Definition at line 23 of file JoypadControlServer_ParamsParser.cpp.

~JoypadControlServer_ParamsParser()

JoypadControlServer_ParamsParser::~JoypadControlServer_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string JoypadControlServer_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 72 of file JoypadControlServer_ParamsParser.h.

getDeviceName()

std::string JoypadControlServer_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 73 of file JoypadControlServer_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string JoypadControlServer_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 136 of file JoypadControlServer_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > JoypadControlServer_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 JoypadControlServer_ParamsParser.cpp.

parseParams()

bool JoypadControlServer_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 39 of file JoypadControlServer_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string JoypadControlServer_ParamsParser::m_device_classname = {"JoypadControlServer"}

Definition at line 51 of file JoypadControlServer_ParamsParser.h.

m_device_name

const std::string JoypadControlServer_ParamsParser::m_device_name = {"JoypadControlServer"}

Definition at line 52 of file JoypadControlServer_ParamsParser.h.

m_name

std::string JoypadControlServer_ParamsParser::m_name = {"/robotName/joypad"}

Definition at line 67 of file JoypadControlServer_ParamsParser.h.

m_name_defaultValue

const std::string JoypadControlServer_ParamsParser::m_name_defaultValue = {"/robotName/joypad"}

Definition at line 62 of file JoypadControlServer_ParamsParser.h.

m_parser_is_strict

bool JoypadControlServer_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file JoypadControlServer_ParamsParser.h.

m_parser_version

const parser_version_type JoypadControlServer_ParamsParser::m_parser_version = {}

Definition at line 59 of file JoypadControlServer_ParamsParser.h.

m_period

double JoypadControlServer_ParamsParser::m_period = {0.01}

Definition at line 66 of file JoypadControlServer_ParamsParser.h.

m_period_defaultValue

const std::string JoypadControlServer_ParamsParser::m_period_defaultValue = {"0.01"}

Definition at line 61 of file JoypadControlServer_ParamsParser.h.

m_profile

bool JoypadControlServer_ParamsParser::m_profile = {false}

Definition at line 69 of file JoypadControlServer_ParamsParser.h.

m_profile_defaultValue

const std::string JoypadControlServer_ParamsParser::m_profile_defaultValue = {"false"}

Definition at line 64 of file JoypadControlServer_ParamsParser.h.

m_use_separate_ports

bool JoypadControlServer_ParamsParser::m_use_separate_ports = {true}

Definition at line 68 of file JoypadControlServer_ParamsParser.h.

m_use_separate_ports_defaultValue

const std::string JoypadControlServer_ParamsParser::m_use_separate_ports_defaultValue = {"true"}

Definition at line 63 of file JoypadControlServer_ParamsParser.h.

---

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

• src/devices/networkWrappers/JoypadControlServer/JoypadControlServer_ParamsParser.h
• src/devices/networkWrappers/JoypadControlServer/JoypadControlServer_ParamsParser.cpp