YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
SimulatedWorld_nws_ros2_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.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: Wed Feb 25 10:20:51 2026
12
13
15#include <yarp/os/LogStream.h>
16#include <yarp/os/Value.h>
17
18namespace {
19 YARP_LOG_COMPONENT(SimulatedWorld_nws_ros2ParamsCOMPONENT, "yarp.device.SimulatedWorld_nws_ros2")
20}
21
22
26
27
29{
30 std::vector<std::string> params;
31 params.push_back("node_name");
32 params.push_back("namespace");
33 params.push_back("makesphere_servicename");
34 params.push_back("makebox_servicename");
35 params.push_back("makecylinder_servicename");
36 params.push_back("makeframe_servicename");
37 params.push_back("makemodel_servicename");
38 params.push_back("makeactor_servicename");
39 params.push_back("changecolor_servicename");
40 params.push_back("setpose_servicename");
41 params.push_back("enablegravity_servicename");
42 params.push_back("enablecollision_servicename");
43 params.push_back("getpose_servicename");
44 params.push_back("deleteobject_servicename");
45 params.push_back("deleteall_servicename");
46 params.push_back("getlist_servicename");
47 params.push_back("attach_servicename");
48 params.push_back("detach_servicename");
49 params.push_back("rename_servicename");
50 return params;
51}
52
53
54bool SimulatedWorld_nws_ros2_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
55{
56 if (paramName =="node_name")
57 {
58 paramValue = m_node_name;
59 return true;
60 }
61 if (paramName =="namespace")
62 {
63 paramValue = m_namespace;
64 return true;
65 }
66 if (paramName =="makesphere_servicename")
67 {
68 paramValue = m_makesphere_servicename;
69 return true;
70 }
71 if (paramName =="makebox_servicename")
72 {
73 paramValue = m_makebox_servicename;
74 return true;
75 }
76 if (paramName =="makecylinder_servicename")
77 {
78 paramValue = m_makecylinder_servicename;
79 return true;
80 }
81 if (paramName =="makeframe_servicename")
82 {
83 paramValue = m_makeframe_servicename;
84 return true;
85 }
86 if (paramName =="makemodel_servicename")
87 {
88 paramValue = m_makemodel_servicename;
89 return true;
90 }
91 if (paramName =="makeactor_servicename")
92 {
93 paramValue = m_makeactor_servicename;
94 return true;
95 }
96 if (paramName =="changecolor_servicename")
97 {
98 paramValue = m_changecolor_servicename;
99 return true;
100 }
101 if (paramName =="setpose_servicename")
102 {
103 paramValue = m_setpose_servicename;
104 return true;
105 }
106 if (paramName =="enablegravity_servicename")
107 {
108 paramValue = m_enablegravity_servicename;
109 return true;
110 }
111 if (paramName =="enablecollision_servicename")
112 {
114 return true;
115 }
116 if (paramName =="getpose_servicename")
117 {
118 paramValue = m_getpose_servicename;
119 return true;
120 }
121 if (paramName =="deleteobject_servicename")
122 {
123 paramValue = m_deleteobject_servicename;
124 return true;
125 }
126 if (paramName =="deleteall_servicename")
127 {
128 paramValue = m_deleteall_servicename;
129 return true;
130 }
131 if (paramName =="getlist_servicename")
132 {
133 paramValue = m_getlist_servicename;
134 return true;
135 }
136 if (paramName =="attach_servicename")
137 {
138 paramValue = m_attach_servicename;
139 return true;
140 }
141 if (paramName =="detach_servicename")
142 {
143 paramValue = m_detach_servicename;
144 return true;
145 }
146 if (paramName =="rename_servicename")
147 {
148 paramValue = m_rename_servicename;
149 return true;
150 }
151
152 yError() <<"parameter '" << paramName << "' was not found";
153 return false;
154
155}
156
157
159{
160 //This is a sub-optimal solution.
161 //Ideally getConfiguration() should return all parameters but it is currently
162 //returning only user provided parameters (excluding default values)
163 //This behaviour will be fixed in the near future.
164 std::string s_cfg = m_provided_configuration;
165 return s_cfg;
166}
167
169{
170 //Check for --help option
171 if (config.check("help"))
172 {
173 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << getDocumentationOfDeviceParams();
174 }
175
178 //Parser of parameter node_name
179 {
180 if (config.check("node_name"))
181 {
182 m_node_name = config.find("node_name").asString();
183 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'node_name' using value:" << m_node_name;
184 }
185 else
186 {
187 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'node_name' using DEFAULT value:" << m_node_name;
188 }
189 prop_check.unput("node_name");
190 }
191
192 //Parser of parameter namespace
193 {
194 if (config.check("namespace"))
195 {
196 m_namespace = config.find("namespace").asString();
197 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'namespace' using value:" << m_namespace;
198 }
199 else
200 {
201 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'namespace' using DEFAULT value:" << m_namespace;
202 }
203 prop_check.unput("namespace");
204 }
205
206 //Parser of parameter makesphere_servicename
207 {
208 if (config.check("makesphere_servicename"))
209 {
210 m_makesphere_servicename = config.find("makesphere_servicename").asString();
211 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makesphere_servicename' using value:" << m_makesphere_servicename;
212 }
213 else
214 {
215 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makesphere_servicename' using DEFAULT value:" << m_makesphere_servicename;
216 }
217 prop_check.unput("makesphere_servicename");
218 }
219
220 //Parser of parameter makebox_servicename
221 {
222 if (config.check("makebox_servicename"))
223 {
224 m_makebox_servicename = config.find("makebox_servicename").asString();
225 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makebox_servicename' using value:" << m_makebox_servicename;
226 }
227 else
228 {
229 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makebox_servicename' using DEFAULT value:" << m_makebox_servicename;
230 }
231 prop_check.unput("makebox_servicename");
232 }
233
234 //Parser of parameter makecylinder_servicename
235 {
236 if (config.check("makecylinder_servicename"))
237 {
238 m_makecylinder_servicename = config.find("makecylinder_servicename").asString();
239 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makecylinder_servicename' using value:" << m_makecylinder_servicename;
240 }
241 else
242 {
243 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makecylinder_servicename' using DEFAULT value:" << m_makecylinder_servicename;
244 }
245 prop_check.unput("makecylinder_servicename");
246 }
247
248 //Parser of parameter makeframe_servicename
249 {
250 if (config.check("makeframe_servicename"))
251 {
252 m_makeframe_servicename = config.find("makeframe_servicename").asString();
253 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makeframe_servicename' using value:" << m_makeframe_servicename;
254 }
255 else
256 {
257 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makeframe_servicename' using DEFAULT value:" << m_makeframe_servicename;
258 }
259 prop_check.unput("makeframe_servicename");
260 }
261
262 //Parser of parameter makemodel_servicename
263 {
264 if (config.check("makemodel_servicename"))
265 {
266 m_makemodel_servicename = config.find("makemodel_servicename").asString();
267 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makemodel_servicename' using value:" << m_makemodel_servicename;
268 }
269 else
270 {
271 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makemodel_servicename' using DEFAULT value:" << m_makemodel_servicename;
272 }
273 prop_check.unput("makemodel_servicename");
274 }
275
276 //Parser of parameter makeactor_servicename
277 {
278 if (config.check("makeactor_servicename"))
279 {
280 m_makeactor_servicename = config.find("makeactor_servicename").asString();
281 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makeactor_servicename' using value:" << m_makeactor_servicename;
282 }
283 else
284 {
285 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'makeactor_servicename' using DEFAULT value:" << m_makeactor_servicename;
286 }
287 prop_check.unput("makeactor_servicename");
288 }
289
290 //Parser of parameter changecolor_servicename
291 {
292 if (config.check("changecolor_servicename"))
293 {
294 m_changecolor_servicename = config.find("changecolor_servicename").asString();
295 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'changecolor_servicename' using value:" << m_changecolor_servicename;
296 }
297 else
298 {
299 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'changecolor_servicename' using DEFAULT value:" << m_changecolor_servicename;
300 }
301 prop_check.unput("changecolor_servicename");
302 }
303
304 //Parser of parameter setpose_servicename
305 {
306 if (config.check("setpose_servicename"))
307 {
308 m_setpose_servicename = config.find("setpose_servicename").asString();
309 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'setpose_servicename' using value:" << m_setpose_servicename;
310 }
311 else
312 {
313 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'setpose_servicename' using DEFAULT value:" << m_setpose_servicename;
314 }
315 prop_check.unput("setpose_servicename");
316 }
317
318 //Parser of parameter enablegravity_servicename
319 {
320 if (config.check("enablegravity_servicename"))
321 {
322 m_enablegravity_servicename = config.find("enablegravity_servicename").asString();
323 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'enablegravity_servicename' using value:" << m_enablegravity_servicename;
324 }
325 else
326 {
327 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'enablegravity_servicename' using DEFAULT value:" << m_enablegravity_servicename;
328 }
329 prop_check.unput("enablegravity_servicename");
330 }
331
332 //Parser of parameter enablecollision_servicename
333 {
334 if (config.check("enablecollision_servicename"))
335 {
336 m_enablecollision_servicename = config.find("enablecollision_servicename").asString();
337 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'enablecollision_servicename' using value:" << m_enablecollision_servicename;
338 }
339 else
340 {
341 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'enablecollision_servicename' using DEFAULT value:" << m_enablecollision_servicename;
342 }
343 prop_check.unput("enablecollision_servicename");
344 }
345
346 //Parser of parameter getpose_servicename
347 {
348 if (config.check("getpose_servicename"))
349 {
350 m_getpose_servicename = config.find("getpose_servicename").asString();
351 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'getpose_servicename' using value:" << m_getpose_servicename;
352 }
353 else
354 {
355 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'getpose_servicename' using DEFAULT value:" << m_getpose_servicename;
356 }
357 prop_check.unput("getpose_servicename");
358 }
359
360 //Parser of parameter deleteobject_servicename
361 {
362 if (config.check("deleteobject_servicename"))
363 {
364 m_deleteobject_servicename = config.find("deleteobject_servicename").asString();
365 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'deleteobject_servicename' using value:" << m_deleteobject_servicename;
366 }
367 else
368 {
369 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'deleteobject_servicename' using DEFAULT value:" << m_deleteobject_servicename;
370 }
371 prop_check.unput("deleteobject_servicename");
372 }
373
374 //Parser of parameter deleteall_servicename
375 {
376 if (config.check("deleteall_servicename"))
377 {
378 m_deleteall_servicename = config.find("deleteall_servicename").asString();
379 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'deleteall_servicename' using value:" << m_deleteall_servicename;
380 }
381 else
382 {
383 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'deleteall_servicename' using DEFAULT value:" << m_deleteall_servicename;
384 }
385 prop_check.unput("deleteall_servicename");
386 }
387
388 //Parser of parameter getlist_servicename
389 {
390 if (config.check("getlist_servicename"))
391 {
392 m_getlist_servicename = config.find("getlist_servicename").asString();
393 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'getlist_servicename' using value:" << m_getlist_servicename;
394 }
395 else
396 {
397 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'getlist_servicename' using DEFAULT value:" << m_getlist_servicename;
398 }
399 prop_check.unput("getlist_servicename");
400 }
401
402 //Parser of parameter attach_servicename
403 {
404 if (config.check("attach_servicename"))
405 {
406 m_attach_servicename = config.find("attach_servicename").asString();
407 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'attach_servicename' using value:" << m_attach_servicename;
408 }
409 else
410 {
411 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'attach_servicename' using DEFAULT value:" << m_attach_servicename;
412 }
413 prop_check.unput("attach_servicename");
414 }
415
416 //Parser of parameter detach_servicename
417 {
418 if (config.check("detach_servicename"))
419 {
420 m_detach_servicename = config.find("detach_servicename").asString();
421 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'detach_servicename' using value:" << m_detach_servicename;
422 }
423 else
424 {
425 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'detach_servicename' using DEFAULT value:" << m_detach_servicename;
426 }
427 prop_check.unput("detach_servicename");
428 }
429
430 //Parser of parameter rename_servicename
431 {
432 if (config.check("rename_servicename"))
433 {
434 m_rename_servicename = config.find("rename_servicename").asString();
435 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'rename_servicename' using value:" << m_rename_servicename;
436 }
437 else
438 {
439 yCInfo(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "Parameter 'rename_servicename' using DEFAULT value:" << m_rename_servicename;
440 }
441 prop_check.unput("rename_servicename");
442 }
443
444 /*
445 //This code check if the user set some parameter which are not check by the parser
446 //If the parser is set in strict mode, this will generate an error
447 if (prop_check.size() > 0)
448 {
449 bool extra_params_found = false;
450 for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
451 {
452 if (m_parser_is_strict)
453 {
454 yCError(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
455 extra_params_found = true;
456 }
457 else
458 {
459 yCWarning(SimulatedWorld_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
460 }
461 }
462
463 if (m_parser_is_strict && extra_params_found)
464 {
465 return false;
466 }
467 }
468 */
469 return true;
470}
471
472
474{
475 std::string doc;
476 doc = doc + std::string("\n=============================================\n");
477 doc = doc + std::string("This is the help for device: SimulatedWorld_nws_ros2\n");
478 doc = doc + std::string("\n");
479 doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
480 doc = doc + std::string("'node_name': The ROS2 node name\n");
481 doc = doc + std::string("'namespace': optional namespace for ros2 node\n");
482 doc = doc + std::string("'makesphere_servicename': ROS2 service name for makeSphere\n");
483 doc = doc + std::string("'makebox_servicename': ROS2 service name for makeBox\n");
484 doc = doc + std::string("'makecylinder_servicename': ROS2 service name for makeCylinder\n");
485 doc = doc + std::string("'makeframe_servicename': ROS2 service name for makeFrame\n");
486 doc = doc + std::string("'makemodel_servicename': ROS2 service name for makeModel\n");
487 doc = doc + std::string("'makeactor_servicename': ROS2 service name for makeActor\n");
488 doc = doc + std::string("'changecolor_servicename': ROS2 service name for changeColor\n");
489 doc = doc + std::string("'setpose_servicename': ROS2 service name for setPose\n");
490 doc = doc + std::string("'enablegravity_servicename': ROS2 service name for enableGravity\n");
491 doc = doc + std::string("'enablecollision_servicename': ROS2 service name for enableCollision\n");
492 doc = doc + std::string("'getpose_servicename': ROS2 service name for getPose\n");
493 doc = doc + std::string("'deleteobject_servicename': ROS2 service name for deleteObject\n");
494 doc = doc + std::string("'deleteall_servicename': ROS2 service name for deleteAll\n");
495 doc = doc + std::string("'getlist_servicename': ROS2 service name for getList\n");
496 doc = doc + std::string("'attach_servicename': ROS2 service name for attach\n");
497 doc = doc + std::string("'detach_servicename': ROS2 service name for detach\n");
498 doc = doc + std::string("'rename_servicename': ROS2 service name for rename\n");
499 doc = doc + std::string("\n");
500 doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
501 doc = doc + " yarpdev --device simulatedWorld_nws_ros2 --node_name simulatedWorld_nws_ros2 --namespace <optional_value> --makesphere_servicename makeSphere --makebox_servicename makeBox --makecylinder_servicename makeCylinder --makeframe_servicename makeFrame --makemodel_servicename makeModel --makeactor_servicename makeActor --changecolor_servicename changeColor --setpose_servicename setPose --enablegravity_servicename enableGravity --enablecollision_servicename enableCollision --getpose_servicename getPose --deleteobject_servicename deleteObject --deleteall_servicename deleteAll --getlist_servicename getList --attach_servicename attach --detach_servicename detach --rename_servicename rename\n";
502 doc = doc + std::string("Using only mandatory params:\n");
503 doc = doc + " yarpdev --device simulatedWorld_nws_ros2\n";
504 doc = doc + std::string("=============================================\n\n"); return doc;
505}
#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.
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.
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 YARP_LOG_COMPONENT(name,...)