YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
JoypadControl_nwc_yarp_ParamsParser.cpp
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:34 2026
12
13
15#include <yarp/os/LogStream.h>
16#include <yarp/os/Value.h>
17
18namespace {
19 YARP_LOG_COMPONENT(JoypadControl_nwc_yarpParamsCOMPONENT, "yarp.device.JoypadControl_nwc_yarp")
20}
21
22
26
27
29{
30 std::vector<std::string> params;
31 params.push_back("local");
32 params.push_back("remote");
33 params.push_back("use_streaming");
34 params.push_back("use_all_port");
35 return params;
36}
37
38
39bool JoypadControl_nwc_yarp_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
40{
41 if (paramName =="local")
42 {
43 paramValue = m_local;
44 return true;
45 }
46 if (paramName =="remote")
47 {
48 paramValue = m_remote;
49 return true;
50 }
51 if (paramName =="use_streaming")
52 {
53 if (m_use_streaming==true) paramValue = "true";
54 else paramValue = "false";
55 return true;
56 }
57 if (paramName =="use_all_port")
58 {
59 if (m_use_all_port==true) paramValue = "true";
60 else paramValue = "false";
61 return true;
62 }
63
64 yError() <<"parameter '" << paramName << "' was not found";
65 return false;
66
67}
68
69
71{
72 //This is a sub-optimal solution.
73 //Ideally getConfiguration() should return all parameters but it is currently
74 //returning only user provided parameters (excluding default values)
75 //This behaviour will be fixed in the near future.
76 std::string s_cfg = m_provided_configuration;
77 return s_cfg;
78}
79
81{
82 //Check for --help option
83 if (config.check("help"))
84 {
85 yCInfo(JoypadControl_nwc_yarpParamsCOMPONENT) << getDocumentationOfDeviceParams();
86 }
87
90 //Parser of parameter local
91 {
92 if (config.check("local"))
93 {
94 m_local = config.find("local").asString();
95 yCInfo(JoypadControl_nwc_yarpParamsCOMPONENT) << "Parameter 'local' using value:" << m_local;
96 }
97 else
98 {
99 yCError(JoypadControl_nwc_yarpParamsCOMPONENT) << "Mandatory parameter 'local' not found!";
100 yCError(JoypadControl_nwc_yarpParamsCOMPONENT) << "Description of the parameter: Full port name opened by the client device.";
101 return false;
102 }
103 prop_check.unput("local");
104 }
105
106 //Parser of parameter remote
107 {
108 if (config.check("remote"))
109 {
110 m_remote = config.find("remote").asString();
111 yCInfo(JoypadControl_nwc_yarpParamsCOMPONENT) << "Parameter 'remote' using value:" << m_remote;
112 }
113 else
114 {
115 yCError(JoypadControl_nwc_yarpParamsCOMPONENT) << "Mandatory parameter 'remote' not found!";
116 yCError(JoypadControl_nwc_yarpParamsCOMPONENT) << "Description of the parameter: Full port name of the port opened on the server side, to which the client device connects to.";
117 return false;
118 }
119 prop_check.unput("remote");
120 }
121
122 //Parser of parameter use_streaming
123 {
124 if (config.check("use_streaming"))
125 {
126 m_use_streaming = config.find("use_streaming").asBool();
127 yCInfo(JoypadControl_nwc_yarpParamsCOMPONENT) << "Parameter 'use_streaming' using value:" << m_use_streaming;
128 }
129 else
130 {
131 yCInfo(JoypadControl_nwc_yarpParamsCOMPONENT) << "Parameter 'use_streaming' using DEFAULT value:" << m_use_streaming;
132 }
133 prop_check.unput("use_streaming");
134 }
135
136 //Parser of parameter use_all_port
137 {
138 if (config.check("use_all_port"))
139 {
140 m_use_all_port = config.find("use_all_port").asBool();
141 yCInfo(JoypadControl_nwc_yarpParamsCOMPONENT) << "Parameter 'use_all_port' using value:" << m_use_all_port;
142 }
143 else
144 {
145 yCInfo(JoypadControl_nwc_yarpParamsCOMPONENT) << "Parameter 'use_all_port' using DEFAULT value:" << m_use_all_port;
146 }
147 prop_check.unput("use_all_port");
148 }
149
150 /*
151 //This code check if the user set some parameter which are not check by the parser
152 //If the parser is set in strict mode, this will generate an error
153 if (prop_check.size() > 0)
154 {
155 bool extra_params_found = false;
156 for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
157 {
158 if (m_parser_is_strict)
159 {
160 yCError(JoypadControl_nwc_yarpParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
161 extra_params_found = true;
162 }
163 else
164 {
165 yCWarning(JoypadControl_nwc_yarpParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
166 }
167 }
168
169 if (m_parser_is_strict && extra_params_found)
170 {
171 return false;
172 }
173 }
174 */
175 return true;
176}
177
178
180{
181 std::string doc;
182 doc = doc + std::string("\n=============================================\n");
183 doc = doc + std::string("This is the help for device: JoypadControl_nwc_yarp\n");
184 doc = doc + std::string("\n");
185 doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
186 doc = doc + std::string("'local': Full port name opened by the client device.\n");
187 doc = doc + std::string("'remote': Full port name of the port opened on the server side, to which the client device connects to.\n");
188 doc = doc + std::string("'use_streaming': enable/disables the use of streaming commands. If disabled, rpc is used instead\n");
189 doc = doc + std::string("'use_all_port': enable/disables the reception of streaming data on a single port instead of multiple separated ports.\n");
190 doc = doc + std::string("\n");
191 doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
192 doc = doc + " yarpdev --device JoypadControl_nwc_yarp --local <mandatory_value> --remote <mandatory_value> --use_streaming true --use_all_port true\n";
193 doc = doc + std::string("Using only mandatory params:\n");
194 doc = doc + " yarpdev --device JoypadControl_nwc_yarp --local <mandatory_value> --remote <mandatory_value>\n";
195 doc = doc + std::string("=============================================\n\n"); return doc;
196}
#define yError(...)
Definition Log.h:361
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::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.
bool parseParams(const yarp::os::Searchable &config) override
Parse the DeviceDriver parameters.
A class for storing options and configuration information.
Definition Property.h:33
void unput(const std::string &key)
Remove the association from the given key to a value, if present.
A base class for nested structures that can be searched.
Definition Searchable.h:31
virtual bool check(const std::string &key) const =0
Check if there exists a property of the given name.
virtual std::string toString() const =0
Return a standard text representation of the content of the object.
virtual Value & find(const std::string &key) const =0
Gets a value corresponding to a given keyword.
#define yCInfo(component,...)
#define yCError(component,...)
#define YARP_LOG_COMPONENT(name,...)