This class is the parameters parser for class JoypadControl_nws_yarp. More...
#include <networkWrappers/joypadControl_nws_yarp/JoypadControl_nws_yarp_ParamsParser.h>
Inheritance diagram for JoypadControl_nws_yarp_ParamsParser:Classes | |
| struct | parser_version_type |
Public Member Functions | |
| JoypadControl_nws_yarp_ParamsParser () | |
| ~JoypadControl_nws_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. | |
| bool | getParamValue (const std::string ¶mName, std::string ¶mValue) 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 = {"JoypadControl_nws_yarp"} |
| const std::string | m_device_name = {"JoypadControl_nws_yarp"} |
| 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.01"} |
| const std::string | m_name_defaultValue = {"/robotName/joypad"} |
| const std::string | m_profile_defaultValue = {"false"} |
| const std::string | m_publish_on_event_defaultValue = {"false"} |
| double | m_period = {0.01} |
| std::string | m_name = {"/robotName/joypad"} |
| bool | m_profile = {false} |
| bool | m_publish_on_event = {false} |
This class is the parameters parser for class JoypadControl_nws_yarp.
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 | - |
| - | profile | bool | - | false | 0 | print the joypad data for debugging purpose | - |
| - | publish_on_event | bool | - | false | 0 | if true, events, are published when the status changes (on event). Otherwise they are published at the frequency specified through the period parameter | - |
The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):
Definition at line 44 of file JoypadControl_nws_yarp_ParamsParser.h.
| JoypadControl_nws_yarp_ParamsParser::JoypadControl_nws_yarp_ParamsParser | ( | ) |
Definition at line 23 of file JoypadControl_nws_yarp_ParamsParser.cpp.
|
overridedefault |
|
overridevirtual |
Return the configuration of the device.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 70 of file JoypadControl_nws_yarp_ParamsParser.cpp.
|
inlineoverridevirtual |
Get the name of the DeviceDriver class.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 74 of file JoypadControl_nws_yarp_ParamsParser.h.
|
inlineoverridevirtual |
Get the name of the device (i.e.
the plugin name).
Implements yarp::dev::IDeviceDriverParams.
Definition at line 75 of file JoypadControl_nws_yarp_ParamsParser.h.
|
overridevirtual |
Get the documentation of the DeviceDriver's parameters.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 177 of file JoypadControl_nws_yarp_ParamsParser.cpp.
|
overridevirtual |
Return a list of all params used by the device.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 28 of file JoypadControl_nws_yarp_ParamsParser.cpp.
|
overridevirtual |
Return the value (represented as a string) of the requested parameter.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 39 of file JoypadControl_nws_yarp_ParamsParser.cpp.
|
overridevirtual |
Parse the DeviceDriver parameters.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 80 of file JoypadControl_nws_yarp_ParamsParser.cpp.
| const std::string JoypadControl_nws_yarp_ParamsParser::m_device_classname = {"JoypadControl_nws_yarp"} |
Definition at line 51 of file JoypadControl_nws_yarp_ParamsParser.h.
| const std::string JoypadControl_nws_yarp_ParamsParser::m_device_name = {"JoypadControl_nws_yarp"} |
Definition at line 52 of file JoypadControl_nws_yarp_ParamsParser.h.
| std::string JoypadControl_nws_yarp_ParamsParser::m_name = {"/robotName/joypad"} |
Definition at line 69 of file JoypadControl_nws_yarp_ParamsParser.h.
| const std::string JoypadControl_nws_yarp_ParamsParser::m_name_defaultValue = {"/robotName/joypad"} |
Definition at line 64 of file JoypadControl_nws_yarp_ParamsParser.h.
| bool JoypadControl_nws_yarp_ParamsParser::m_parser_is_strict = false |
Definition at line 53 of file JoypadControl_nws_yarp_ParamsParser.h.
| const parser_version_type JoypadControl_nws_yarp_ParamsParser::m_parser_version = {} |
Definition at line 59 of file JoypadControl_nws_yarp_ParamsParser.h.
| double JoypadControl_nws_yarp_ParamsParser::m_period = {0.01} |
Definition at line 68 of file JoypadControl_nws_yarp_ParamsParser.h.
| const std::string JoypadControl_nws_yarp_ParamsParser::m_period_defaultValue = {"0.01"} |
Definition at line 63 of file JoypadControl_nws_yarp_ParamsParser.h.
| bool JoypadControl_nws_yarp_ParamsParser::m_profile = {false} |
Definition at line 70 of file JoypadControl_nws_yarp_ParamsParser.h.
| const std::string JoypadControl_nws_yarp_ParamsParser::m_profile_defaultValue = {"false"} |
Definition at line 65 of file JoypadControl_nws_yarp_ParamsParser.h.
| std::string JoypadControl_nws_yarp_ParamsParser::m_provided_configuration |
Definition at line 61 of file JoypadControl_nws_yarp_ParamsParser.h.
| bool JoypadControl_nws_yarp_ParamsParser::m_publish_on_event = {false} |
Definition at line 71 of file JoypadControl_nws_yarp_ParamsParser.h.
| const std::string JoypadControl_nws_yarp_ParamsParser::m_publish_on_event_defaultValue = {"false"} |
Definition at line 66 of file JoypadControl_nws_yarp_ParamsParser.h.