YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Map2D_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: Thu Jan 29 14:11:54 2026
12
13
15#include <yarp/os/LogStream.h>
16#include <yarp/os/Value.h>
17
18namespace {
19 YARP_LOG_COMPONENT(Map2D_nws_ros2ParamsCOMPONENT, "yarp.device.Map2D_nws_ros2")
20}
21
22
26
27
28std::vector<std::string> Map2D_nws_ros2_ParamsParser::getListOfParams() const
29{
30 std::vector<std::string> params;
31 params.push_back("name");
32 params.push_back("getmap");
33 params.push_back("getmapbyname");
34 params.push_back("roscmdparser");
35 params.push_back("markers_pub");
36 params.push_back("node_name");
37 params.push_back("namespace");
38 return params;
39}
40
41
42bool Map2D_nws_ros2_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
43{
44 if (paramName =="name")
45 {
46 paramValue = m_name;
47 return true;
48 }
49 if (paramName =="getmap")
50 {
51 paramValue = m_getmap;
52 return true;
53 }
54 if (paramName =="getmapbyname")
55 {
56 paramValue = m_getmapbyname;
57 return true;
58 }
59 if (paramName =="roscmdparser")
60 {
61 paramValue = m_roscmdparser;
62 return true;
63 }
64 if (paramName =="markers_pub")
65 {
66 paramValue = m_markers_pub;
67 return true;
68 }
69 if (paramName =="node_name")
70 {
71 paramValue = m_node_name;
72 return true;
73 }
74 if (paramName =="namespace")
75 {
76 paramValue = m_namespace;
77 return true;
78 }
79
80 yError() <<"parameter '" << paramName << "' was not found";
81 return false;
82
83}
84
85
87{
88 //This is a sub-optimal solution.
89 //Ideally getConfiguration() should return all parameters but it is currently
90 //returning only user provided parameters (excluding default values)
91 //This behaviour will be fixed in the near future.
92 std::string s_cfg = m_provided_configuration;
93 return s_cfg;
94}
95
97{
98 //Check for --help option
99 if (config.check("help"))
100 {
101 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << getDocumentationOfDeviceParams();
102 }
103
106 //Parser of parameter name
107 {
108 if (config.check("name"))
109 {
110 m_name = config.find("name").asString();
111 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'name' using value:" << m_name;
112 }
113 else
114 {
115 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'name' using DEFAULT value:" << m_name;
116 }
117 prop_check.unput("name");
118 }
119
120 //Parser of parameter getmap
121 {
122 if (config.check("getmap"))
123 {
124 m_getmap = config.find("getmap").asString();
125 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'getmap' using value:" << m_getmap;
126 }
127 else
128 {
129 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'getmap' using DEFAULT value:" << m_getmap;
130 }
131 prop_check.unput("getmap");
132 }
133
134 //Parser of parameter getmapbyname
135 {
136 if (config.check("getmapbyname"))
137 {
138 m_getmapbyname = config.find("getmapbyname").asString();
139 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'getmapbyname' using value:" << m_getmapbyname;
140 }
141 else
142 {
143 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'getmapbyname' using DEFAULT value:" << m_getmapbyname;
144 }
145 prop_check.unput("getmapbyname");
146 }
147
148 //Parser of parameter roscmdparser
149 {
150 if (config.check("roscmdparser"))
151 {
152 m_roscmdparser = config.find("roscmdparser").asString();
153 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'roscmdparser' using value:" << m_roscmdparser;
154 }
155 else
156 {
157 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'roscmdparser' using DEFAULT value:" << m_roscmdparser;
158 }
159 prop_check.unput("roscmdparser");
160 }
161
162 //Parser of parameter markers_pub
163 {
164 if (config.check("markers_pub"))
165 {
166 m_markers_pub = config.find("markers_pub").asString();
167 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'markers_pub' using value:" << m_markers_pub;
168 }
169 else
170 {
171 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'markers_pub' using DEFAULT value:" << m_markers_pub;
172 }
173 prop_check.unput("markers_pub");
174 }
175
176 //Parser of parameter node_name
177 {
178 if (config.check("node_name"))
179 {
180 m_node_name = config.find("node_name").asString();
181 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'node_name' using value:" << m_node_name;
182 }
183 else
184 {
185 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'node_name' using DEFAULT value:" << m_node_name;
186 }
187 prop_check.unput("node_name");
188 }
189
190 //Parser of parameter namespace
191 {
192 if (config.check("namespace"))
193 {
194 m_namespace = config.find("namespace").asString();
195 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'namespace' using value:" << m_namespace;
196 }
197 else
198 {
199 yCInfo(Map2D_nws_ros2ParamsCOMPONENT) << "Parameter 'namespace' using DEFAULT value:" << m_namespace;
200 }
201 prop_check.unput("namespace");
202 }
203
204 /*
205 //This code check if the user set some parameter which are not check by the parser
206 //If the parser is set in strict mode, this will generate an error
207 if (prop_check.size() > 0)
208 {
209 bool extra_params_found = false;
210 for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
211 {
212 if (m_parser_is_strict)
213 {
214 yCError(Map2D_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
215 extra_params_found = true;
216 }
217 else
218 {
219 yCWarning(Map2D_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
220 }
221 }
222
223 if (m_parser_is_strict && extra_params_found)
224 {
225 return false;
226 }
227 }
228 */
229 return true;
230}
231
232
234{
235 std::string doc;
236 doc = doc + std::string("\n=============================================\n");
237 doc = doc + std::string("This is the help for device: Map2D_nws_ros2\n");
238 doc = doc + std::string("\n");
239 doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
240 doc = doc + std::string("'name': Device name prefix\n");
241 doc = doc + std::string("'getmap': The \"GetMap\" ROS service name\n");
242 doc = doc + std::string("'getmapbyname': The \"GetMapByName\" ROS2 custom service name\n");
243 doc = doc + std::string("'roscmdparser': The \"BasicTypes\" ROS service name\n");
244 doc = doc + std::string("'markers_pub': The visual markers array publisher name\n");
245 doc = doc + std::string("'node_name': The ROS2 node name. If absent, the device name will be used\n");
246 doc = doc + std::string("'namespace': optional namespace for ros2 node\n");
247 doc = doc + std::string("\n");
248 doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
249 doc = doc + " yarpdev --device map2D_nws_ros2 --name map2D_nws_ros2 --getmap getMap --getmapbyname getMapByName --roscmdparser rosCmdParser --markers_pub locationServerMarkers --node_name map2D_nws_ros2 --namespace <optional_value>\n";
250 doc = doc + std::string("Using only mandatory params:\n");
251 doc = doc + " yarpdev --device map2D_nws_ros2\n";
252 doc = doc + std::string("=============================================\n\n"); return doc;
253}
#define yError(...)
Definition Log.h:361
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.
std::string getDocumentationOfDeviceParams() const override
Get the documentation of the DeviceDriver's parameters.
bool getParamValue(const std::string &paramName, std::string &paramValue) const override
Return the value (represented as a string) of the requested parameter.
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 YARP_LOG_COMPONENT(name,...)