YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
RemoteControlBoard_ParamsParser Class Reference

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

#include <networkWrappers/RemoteControlBoard/RemoteControlBoard_ParamsParser.h>

+ Inheritance diagram for RemoteControlBoard_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 RemoteControlBoard_ParamsParser ()
 
 ~RemoteControlBoard_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 = {"RemoteControlBoard"}
 
const std::string m_device_name = {"remote_controlboard"}
 
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_writeStrict_defaultValue = {""}
 
const std::string m_carrier_defaultValue = {"udp"}
 
const std::string m_timeout_defaultValue = {"0.5"}
 
const std::string m_local_qos_enable_defaultValue = {"false"}
 
const std::string m_local_qos_thread_priority_defaultValue = {"0"}
 
const std::string m_local_qos_thread_policy_defaultValue = {"0"}
 
const std::string m_local_qos_packet_priority_defaultValue = {""}
 
const std::string m_remote_qos_enable_defaultValue = {"false"}
 
const std::string m_remote_qos_thread_priority_defaultValue = {"0"}
 
const std::string m_remote_qos_thread_policy_defaultValue = {"0"}
 
const std::string m_remote_qos_packet_priority_defaultValue = {""}
 
const std::string m_ignoreProtocolCheck_defaultValue = {"false"}
 
const std::string m_diagnostic_defaultValue = {"false"}
 
std::string m_remote = {}
 
std::string m_local = {}
 
std::string m_writeStrict = {}
 
std::string m_carrier = {"udp"}
 
float m_timeout = {0.5}
 
bool m_local_qos_enable = {false}
 
int m_local_qos_thread_priority = {0}
 
int m_local_qos_thread_policy = {0}
 
std::string m_local_qos_packet_priority = {}
 
bool m_remote_qos_enable = {false}
 
int m_remote_qos_thread_priority = {0}
 
int m_remote_qos_thread_policy = {0}
 
std::string m_remote_qos_packet_priority = {}
 
bool m_ignoreProtocolCheck = {false}
 
bool m_diagnostic = {false}
 

Detailed Description

This class is the parameters parser for class RemoteControlBoard.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- remote string - - 1 Prefix of the port to which to connect. -
- local string - - 1 Port prefix of the port opened by this device. -
- writeStrict string - - 0 It can be 'on' or 'off' See implementation
- carrier string - udp 0 carrier used for streaming robot state -
- timeout float - 0.5 0 timeout for the input port which receives the streamed robot state -
local_qos enable bool - false 0 Enable the usage of local Qos -
local_qos thread_priority int - 0 0 Local Qos. See https://yarp.it/latest/channelprioritization.html -
local_qos thread_policy int - 0 0 Local Qos. See https://yarp.it/latest/channelprioritization.html -
local_qos packet_priority string - - 0 Local Qos. See https://yarp.it/latest/channelprioritization.html -
remote_qos enable bool - false 0 Enable the usage of remote Qos -
remote_qos thread_priority int - 0 0 Remote Qos. See https://yarp.it/latest/channelprioritization.html -
remote_qos thread_policy int - 0 0 Remote Qos. See https://yarp.it/latest/channelprioritization.html. -
remote_qos packet_priority string - - 0 Remote Qos. See https://yarp.it/latest/channelprioritization.html. -
- ignoreProtocolCheck bool - false 0 For development purpose only -
- diagnostic bool - false 0 For development purpose only -

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

yarpdev --device remote_controlboard --remote <mandatory_value> --local <mandatory_value> --writeStrict <optional_value> --carrier udp --timeout 0.5 --local_qos::enable false --local_qos::thread_priority 0 --local_qos::thread_policy 0 --local_qos::packet_priority <optional_value> --remote_qos::enable false --remote_qos::thread_priority 0 --remote_qos::thread_policy 0 --remote_qos::packet_priority <optional_value> --ignoreProtocolCheck false --diagnostic false
yarpdev --device remote_controlboard --remote <mandatory_value> --local <mandatory_value>

Definition at line 55 of file RemoteControlBoard_ParamsParser.h.

Constructor & Destructor Documentation

◆ RemoteControlBoard_ParamsParser()

RemoteControlBoard_ParamsParser::RemoteControlBoard_ParamsParser ( )

Definition at line 23 of file RemoteControlBoard_ParamsParser.cpp.

◆ ~RemoteControlBoard_ParamsParser()

RemoteControlBoard_ParamsParser::~RemoteControlBoard_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string RemoteControlBoard_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 105 of file RemoteControlBoard_ParamsParser.h.

◆ getDeviceName()

std::string RemoteControlBoard_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 106 of file RemoteControlBoard_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string RemoteControlBoard_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 319 of file RemoteControlBoard_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > RemoteControlBoard_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 RemoteControlBoard_ParamsParser.cpp.

◆ parseParams()

bool RemoteControlBoard_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 50 of file RemoteControlBoard_ParamsParser.cpp.

Member Data Documentation

◆ m_carrier

std::string RemoteControlBoard_ParamsParser::m_carrier = {"udp"}

Definition at line 91 of file RemoteControlBoard_ParamsParser.h.

◆ m_carrier_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_carrier_defaultValue = {"udp"}

Definition at line 75 of file RemoteControlBoard_ParamsParser.h.

◆ m_device_classname

const std::string RemoteControlBoard_ParamsParser::m_device_classname = {"RemoteControlBoard"}

Definition at line 62 of file RemoteControlBoard_ParamsParser.h.

◆ m_device_name

const std::string RemoteControlBoard_ParamsParser::m_device_name = {"remote_controlboard"}

Definition at line 63 of file RemoteControlBoard_ParamsParser.h.

◆ m_diagnostic

bool RemoteControlBoard_ParamsParser::m_diagnostic = {false}

Definition at line 102 of file RemoteControlBoard_ParamsParser.h.

◆ m_diagnostic_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_diagnostic_defaultValue = {"false"}

Definition at line 86 of file RemoteControlBoard_ParamsParser.h.

◆ m_ignoreProtocolCheck

bool RemoteControlBoard_ParamsParser::m_ignoreProtocolCheck = {false}

Definition at line 101 of file RemoteControlBoard_ParamsParser.h.

◆ m_ignoreProtocolCheck_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_ignoreProtocolCheck_defaultValue = {"false"}

Definition at line 85 of file RemoteControlBoard_ParamsParser.h.

◆ m_local

std::string RemoteControlBoard_ParamsParser::m_local = {}

Definition at line 89 of file RemoteControlBoard_ParamsParser.h.

◆ m_local_defaultValue

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

Definition at line 73 of file RemoteControlBoard_ParamsParser.h.

◆ m_local_qos_enable

bool RemoteControlBoard_ParamsParser::m_local_qos_enable = {false}

Definition at line 93 of file RemoteControlBoard_ParamsParser.h.

◆ m_local_qos_enable_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_local_qos_enable_defaultValue = {"false"}

Definition at line 77 of file RemoteControlBoard_ParamsParser.h.

◆ m_local_qos_packet_priority

std::string RemoteControlBoard_ParamsParser::m_local_qos_packet_priority = {}

Definition at line 96 of file RemoteControlBoard_ParamsParser.h.

◆ m_local_qos_packet_priority_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_local_qos_packet_priority_defaultValue = {""}

Definition at line 80 of file RemoteControlBoard_ParamsParser.h.

◆ m_local_qos_thread_policy

int RemoteControlBoard_ParamsParser::m_local_qos_thread_policy = {0}

Definition at line 95 of file RemoteControlBoard_ParamsParser.h.

◆ m_local_qos_thread_policy_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_local_qos_thread_policy_defaultValue = {"0"}

Definition at line 79 of file RemoteControlBoard_ParamsParser.h.

◆ m_local_qos_thread_priority

int RemoteControlBoard_ParamsParser::m_local_qos_thread_priority = {0}

Definition at line 94 of file RemoteControlBoard_ParamsParser.h.

◆ m_local_qos_thread_priority_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_local_qos_thread_priority_defaultValue = {"0"}

Definition at line 78 of file RemoteControlBoard_ParamsParser.h.

◆ m_parser_is_strict

bool RemoteControlBoard_ParamsParser::m_parser_is_strict = false

Definition at line 64 of file RemoteControlBoard_ParamsParser.h.

◆ m_parser_version

const parser_version_type RemoteControlBoard_ParamsParser::m_parser_version = {}

Definition at line 70 of file RemoteControlBoard_ParamsParser.h.

◆ m_remote

std::string RemoteControlBoard_ParamsParser::m_remote = {}

Definition at line 88 of file RemoteControlBoard_ParamsParser.h.

◆ m_remote_defaultValue

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

Definition at line 72 of file RemoteControlBoard_ParamsParser.h.

◆ m_remote_qos_enable

bool RemoteControlBoard_ParamsParser::m_remote_qos_enable = {false}

Definition at line 97 of file RemoteControlBoard_ParamsParser.h.

◆ m_remote_qos_enable_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_remote_qos_enable_defaultValue = {"false"}

Definition at line 81 of file RemoteControlBoard_ParamsParser.h.

◆ m_remote_qos_packet_priority

std::string RemoteControlBoard_ParamsParser::m_remote_qos_packet_priority = {}

Definition at line 100 of file RemoteControlBoard_ParamsParser.h.

◆ m_remote_qos_packet_priority_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_remote_qos_packet_priority_defaultValue = {""}

Definition at line 84 of file RemoteControlBoard_ParamsParser.h.

◆ m_remote_qos_thread_policy

int RemoteControlBoard_ParamsParser::m_remote_qos_thread_policy = {0}

Definition at line 99 of file RemoteControlBoard_ParamsParser.h.

◆ m_remote_qos_thread_policy_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_remote_qos_thread_policy_defaultValue = {"0"}

Definition at line 83 of file RemoteControlBoard_ParamsParser.h.

◆ m_remote_qos_thread_priority

int RemoteControlBoard_ParamsParser::m_remote_qos_thread_priority = {0}

Definition at line 98 of file RemoteControlBoard_ParamsParser.h.

◆ m_remote_qos_thread_priority_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_remote_qos_thread_priority_defaultValue = {"0"}

Definition at line 82 of file RemoteControlBoard_ParamsParser.h.

◆ m_timeout

float RemoteControlBoard_ParamsParser::m_timeout = {0.5}

Definition at line 92 of file RemoteControlBoard_ParamsParser.h.

◆ m_timeout_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_timeout_defaultValue = {"0.5"}

Definition at line 76 of file RemoteControlBoard_ParamsParser.h.

◆ m_writeStrict

std::string RemoteControlBoard_ParamsParser::m_writeStrict = {}

Definition at line 90 of file RemoteControlBoard_ParamsParser.h.

◆ m_writeStrict_defaultValue

const std::string RemoteControlBoard_ParamsParser::m_writeStrict_defaultValue = {""}

Definition at line 74 of file RemoteControlBoard_ParamsParser.h.

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