This class is the parameters parser for class JoypadControl_nwc_yarp. More...
#include <networkWrappers/joypadControl_nwc_yarp/JoypadControl_nwc_yarp_ParamsParser.h>
Inheritance diagram for JoypadControl_nwc_yarp_ParamsParser:Classes | |
| struct | parser_version_type |
Public Member Functions | |
| JoypadControl_nwc_yarp_ParamsParser () | |
| ~JoypadControl_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. | |
| 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_nwc_yarp"} |
| const std::string | m_device_name = {"JoypadControl_nwc_yarp"} |
| bool | m_parser_is_strict = false |
| const parser_version_type | m_parser_version = {} |
| std::string | m_provided_configuration |
| const std::string | m_local_defaultValue = {""} |
| const std::string | m_remote_defaultValue = {""} |
| const std::string | m_use_streaming_defaultValue = {"true"} |
| const std::string | m_use_all_port_defaultValue = {"true"} |
| std::string | m_local = {} |
| std::string | m_remote = {} |
| bool | m_use_streaming = {true} |
| bool | m_use_all_port = {true} |
This class is the parameters parser for class JoypadControl_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 client device. | - |
| - | remote | string | - | - | 1 | Full port name of the port opened on the server side, to which the client device connects to. | - |
| - | use_streaming | bool | - | true | 0 | enable/disables the use of streaming commands. If disabled, rpc is used instead | - |
| - | use_all_port | bool | - | true | 0 | enable/disables the reception of streaming data on a single port instead of multiple separated ports. | - |
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_nwc_yarp_ParamsParser.h.
| JoypadControl_nwc_yarp_ParamsParser::JoypadControl_nwc_yarp_ParamsParser | ( | ) |
Definition at line 23 of file JoypadControl_nwc_yarp_ParamsParser.cpp.
|
overridedefault |
|
overridevirtual |
Return the configuration of the device.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 70 of file JoypadControl_nwc_yarp_ParamsParser.cpp.
|
inlineoverridevirtual |
Get the name of the DeviceDriver class.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 74 of file JoypadControl_nwc_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_nwc_yarp_ParamsParser.h.
|
overridevirtual |
Get the documentation of the DeviceDriver's parameters.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 179 of file JoypadControl_nwc_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_nwc_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_nwc_yarp_ParamsParser.cpp.
|
overridevirtual |
Parse the DeviceDriver parameters.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 80 of file JoypadControl_nwc_yarp_ParamsParser.cpp.
| const std::string JoypadControl_nwc_yarp_ParamsParser::m_device_classname = {"JoypadControl_nwc_yarp"} |
Definition at line 51 of file JoypadControl_nwc_yarp_ParamsParser.h.
| const std::string JoypadControl_nwc_yarp_ParamsParser::m_device_name = {"JoypadControl_nwc_yarp"} |
Definition at line 52 of file JoypadControl_nwc_yarp_ParamsParser.h.
| std::string JoypadControl_nwc_yarp_ParamsParser::m_local = {} |
Definition at line 68 of file JoypadControl_nwc_yarp_ParamsParser.h.
| const std::string JoypadControl_nwc_yarp_ParamsParser::m_local_defaultValue = {""} |
Definition at line 63 of file JoypadControl_nwc_yarp_ParamsParser.h.
| bool JoypadControl_nwc_yarp_ParamsParser::m_parser_is_strict = false |
Definition at line 53 of file JoypadControl_nwc_yarp_ParamsParser.h.
| const parser_version_type JoypadControl_nwc_yarp_ParamsParser::m_parser_version = {} |
Definition at line 59 of file JoypadControl_nwc_yarp_ParamsParser.h.
| std::string JoypadControl_nwc_yarp_ParamsParser::m_provided_configuration |
Definition at line 61 of file JoypadControl_nwc_yarp_ParamsParser.h.
| std::string JoypadControl_nwc_yarp_ParamsParser::m_remote = {} |
Definition at line 69 of file JoypadControl_nwc_yarp_ParamsParser.h.
| const std::string JoypadControl_nwc_yarp_ParamsParser::m_remote_defaultValue = {""} |
Definition at line 64 of file JoypadControl_nwc_yarp_ParamsParser.h.
| bool JoypadControl_nwc_yarp_ParamsParser::m_use_all_port = {true} |
Definition at line 71 of file JoypadControl_nwc_yarp_ParamsParser.h.
| const std::string JoypadControl_nwc_yarp_ParamsParser::m_use_all_port_defaultValue = {"true"} |
Definition at line 66 of file JoypadControl_nwc_yarp_ParamsParser.h.
| bool JoypadControl_nwc_yarp_ParamsParser::m_use_streaming = {true} |
Definition at line 70 of file JoypadControl_nwc_yarp_ParamsParser.h.
| const std::string JoypadControl_nwc_yarp_ParamsParser::m_use_streaming_defaultValue = {"true"} |
Definition at line 65 of file JoypadControl_nwc_yarp_ParamsParser.h.