YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
RemoteControlBoard_ParamsParser.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2023-2023 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: LGPL-2.1-or-later
4 */
5
6
7// Generated by yarpDeviceParamParserGenerator (2.0)
8// This is an automatically generated file. Please do not edit it.
9// It will be re-generated if the cmake flag ALLOW_DEVICE_PARAM_PARSER_GERNERATION is ON.
10
11// Generated on: Thu May 22 11:32:44 2025
12
13
14#ifndef REMOTECONTROLBOARD_PARAMSPARSER_H
15#define REMOTECONTROLBOARD_PARAMSPARSER_H
16
17#include <yarp/os/Searchable.h>
19#include <string>
20#include <cmath>
21
56{
57public:
60
61public:
62 const std::string m_device_classname = {"RemoteControlBoard"};
63 const std::string m_device_name = {"remote_controlboard"};
64 bool m_parser_is_strict = false;
66 {
67 int major = 2;
68 int minor = 0;
69 };
71
73
74 const std::string m_remote_defaultValue = {""};
75 const std::string m_local_defaultValue = {""};
76 const std::string m_writeStrict_defaultValue = {""};
77 const std::string m_carrier_defaultValue = {"udp"};
78 const std::string m_timeout_defaultValue = {"0.5"};
79 const std::string m_local_qos_enable_defaultValue = {"false"};
81 const std::string m_local_qos_thread_policy_defaultValue = {"0"};
83 const std::string m_remote_qos_enable_defaultValue = {"false"};
85 const std::string m_remote_qos_thread_policy_defaultValue = {"0"};
87 const std::string m_ignoreProtocolCheck_defaultValue = {"false"};
88 const std::string m_diagnostic_defaultValue = {"false"};
89
90 std::string m_remote = {}; //This default value is autogenerated. It is highly recommended to provide a suggested value also for mandatory parameters.
91 std::string m_local = {}; //This default value is autogenerated. It is highly recommended to provide a suggested value also for mandatory parameters.
92 std::string m_writeStrict = {}; //This default value of this string is an empty string. It is highly recommended to provide a suggested value also for optional string parameters.
93 std::string m_carrier = {"udp"};
94 float m_timeout = {0.5};
95 bool m_local_qos_enable = {false};
98 std::string m_local_qos_packet_priority = {}; //This default value of this string is an empty string. It is highly recommended to provide a suggested value also for optional string parameters.
99 bool m_remote_qos_enable = {false};
102 std::string m_remote_qos_packet_priority = {}; //This default value of this string is an empty string. It is highly recommended to provide a suggested value also for optional string parameters.
103 bool m_ignoreProtocolCheck = {false};
104 bool m_diagnostic = {false};
105
106 bool parseParams(const yarp::os::Searchable & config) override;
107 std::string getDeviceClassName() const override { return m_device_classname; }
108 std::string getDeviceName() const override { return m_device_name; }
109 std::string getDocumentationOfDeviceParams() const override;
110 std::vector<std::string> getListOfParams() const override;
111 bool getParamValue(const std::string& paramName, std::string& paramValue) const override;
112 std::string getConfiguration() const override;
113};
114
115#endif
This class is the parameters parser for class RemoteControlBoard.
std::vector< std::string > getListOfParams() const override
Return a list of all params used by the device.
std::string getDocumentationOfDeviceParams() const override
Get the documentation of the DeviceDriver's parameters.
std::string getConfiguration() const override
Return the configuration of the device.
bool parseParams(const yarp::os::Searchable &config) override
Parse the DeviceDriver parameters.
std::string getDeviceName() const override
Get the name of the device (i.e.
bool getParamValue(const std::string &paramName, std::string &paramValue) const override
Return the value (represented as a string) of the requested parameter.
~RemoteControlBoard_ParamsParser() override=default
std::string getDeviceClassName() const override
Get the name of the DeviceDriver class.
An interface for the management of the parameters of a DeviceDriver.
A base class for nested structures that can be searched.
Definition Searchable.h:31