YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
ControlBoard_nwc_yarp_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.2)
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_GENERATION is ON.
10
11// Generated on: Tue Jul 28 23:33:23 2026
12
13
14#ifndef CONTROLBOARD_NWC_YARP_PARAMSPARSER_H
15#define CONTROLBOARD_NWC_YARP_PARAMSPARSER_H
16
17#include <yarp/os/Searchable.h>
19#include <string>
20#include <cmath>
21
57{
58public:
61
62public:
63 const std::string m_device_classname = {"ControlBoard_nwc_yarp"};
64 const std::string m_device_name = {"controlBoard_nwc_yarp"};
65 bool m_parser_is_strict = false;
67 {
68 int major = 2;
69 int minor = 2;
70 };
72
74
75 const std::string m_remote_defaultValue = {""};
76 const std::string m_local_defaultValue = {""};
77 const std::string m_writeStrict_defaultValue = {""};
78 const std::string m_carrier_defaultValue = {"fast_tcp"};
79 const std::string m_carrier_cmd_defaultValue = {"fast_tcp"};
80 const std::string m_timeout_defaultValue = {"0.5"};
81 const std::string m_use_streaming_defaultValue = {"true"};
82 const std::string m_local_qos_enable_defaultValue = {"false"};
84 const std::string m_local_qos_thread_policy_defaultValue = {"0"};
86 const std::string m_remote_qos_enable_defaultValue = {"false"};
88 const std::string m_remote_qos_thread_policy_defaultValue = {"0"};
90 const std::string m_diagnostic_defaultValue = {"false"};
91
92 std::string m_remote = {}; //This default value is autogenerated. It is highly recommended to provide a suggested value also for mandatory parameters.
93 std::string m_local = {}; //This default value is autogenerated. It is highly recommended to provide a suggested value also for mandatory parameters.
94 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.
95 std::string m_carrier = {"fast_tcp"};
96 std::string m_carrier_cmd = {"fast_tcp"};
97 float m_timeout = {0.5};
98 bool m_use_streaming = {true};
99 bool m_local_qos_enable = {false};
102 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.
103 bool m_remote_qos_enable = {false};
106 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.
107 bool m_diagnostic = {false};
108
109 bool parseParams(const yarp::os::Searchable & config) override;
110 std::string getDeviceClassName() const override { return m_device_classname; }
111 std::string getDeviceName() const override { return m_device_name; }
112 std::string getDocumentationOfDeviceParams() const override;
113 std::vector<std::string> getListOfParams() const override;
114 bool getParamValue(const std::string& paramName, std::string& paramValue) const override;
115 std::string getConfiguration() const override;
116};
117
118#endif
This class is the parameters parser for class ControlBoard_nwc_yarp.
~ControlBoard_nwc_yarp_ParamsParser() override=default
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.
std::string getDocumentationOfDeviceParams() const override
Get the documentation of the DeviceDriver's parameters.
std::string getDeviceClassName() const override
Get the name of the DeviceDriver class.
bool parseParams(const yarp::os::Searchable &config) override
Parse the DeviceDriver parameters.
std::vector< std::string > getListOfParams() const override
Return a list of all params used by the device.
std::string getConfiguration() const override
Return the configuration of the device.
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