YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Odometry2D_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(Odometry2D_nws_ros2ParamsCOMPONENT, "yarp.device.Odometry2D_nws_ros2")
20}
21
22
26
27
29{
30 std::vector<std::string> params;
31 params.push_back("period");
32 params.push_back("node_name");
33 params.push_back("namespace");
34 params.push_back("topic_name");
35 params.push_back("odom_frame");
36 params.push_back("base_frame");
37 return params;
38}
39
40
41bool Odometry2D_nws_ros2_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
42{
43 if (paramName =="period")
44 {
45 paramValue = std::to_string(m_period);
46 return true;
47 }
48 if (paramName =="node_name")
49 {
50 paramValue = m_node_name;
51 return true;
52 }
53 if (paramName =="namespace")
54 {
55 paramValue = m_namespace;
56 return true;
57 }
58 if (paramName =="topic_name")
59 {
60 paramValue = m_topic_name;
61 return true;
62 }
63 if (paramName =="odom_frame")
64 {
65 paramValue = m_odom_frame;
66 return true;
67 }
68 if (paramName =="base_frame")
69 {
70 paramValue = m_base_frame;
71 return true;
72 }
73
74 yError() <<"parameter '" << paramName << "' was not found";
75 return false;
76
77}
78
79
81{
82 //This is a sub-optimal solution.
83 //Ideally getConfiguration() should return all parameters but it is currently
84 //returning only user provided parameters (excluding default values)
85 //This behaviour will be fixed in the near future.
86 std::string s_cfg = m_provided_configuration;
87 return s_cfg;
88}
89
91{
92 //Check for --help option
93 if (config.check("help"))
94 {
95 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) << getDocumentationOfDeviceParams();
96 }
97
100 //Parser of parameter period
101 {
102 if (config.check("period"))
103 {
104 m_period = config.find("period").asFloat64();
105 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) << "Parameter 'period' using value:" << m_period;
106 }
107 else
108 {
109 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) << "Parameter 'period' using DEFAULT value:" << m_period;
110 }
111 prop_check.unput("period");
112 }
113
114 //Parser of parameter node_name
115 {
116 if (config.check("node_name"))
117 {
118 m_node_name = config.find("node_name").asString();
119 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) << "Parameter 'node_name' using value:" << m_node_name;
120 }
121 else
122 {
123 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'node_name' not found!";
124 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) << "Description of the parameter: name of the ros2 node";
125 return false;
126 }
127 prop_check.unput("node_name");
128 }
129
130 //Parser of parameter namespace
131 {
132 if (config.check("namespace"))
133 {
134 m_namespace = config.find("namespace").asString();
135 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) << "Parameter 'namespace' using value:" << m_namespace;
136 }
137 else
138 {
139 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) << "Parameter 'namespace' using DEFAULT value:" << m_namespace;
140 }
141 prop_check.unput("namespace");
142 }
143
144 //Parser of parameter topic_name
145 {
146 if (config.check("topic_name"))
147 {
148 m_topic_name = config.find("topic_name").asString();
149 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) << "Parameter 'topic_name' using value:" << m_topic_name;
150 }
151 else
152 {
153 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'topic_name' not found!";
154 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) << "Description of the parameter: name of the topic where the device must publish the data";
155 return false;
156 }
157 prop_check.unput("topic_name");
158 }
159
160 //Parser of parameter odom_frame
161 {
162 if (config.check("odom_frame"))
163 {
164 m_odom_frame = config.find("odom_frame").asString();
165 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) << "Parameter 'odom_frame' using value:" << m_odom_frame;
166 }
167 else
168 {
169 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'odom_frame' not found!";
170 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) << "Description of the parameter: name of the reference frame for odometry";
171 return false;
172 }
173 prop_check.unput("odom_frame");
174 }
175
176 //Parser of parameter base_frame
177 {
178 if (config.check("base_frame"))
179 {
180 m_base_frame = config.find("base_frame").asString();
181 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) << "Parameter 'base_frame' using value:" << m_base_frame;
182 }
183 else
184 {
185 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'base_frame' not found!";
186 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) << "Description of the parameter: name of the base frame for odometry";
187 return false;
188 }
189 prop_check.unput("base_frame");
190 }
191
192 /*
193 //This code check if the user set some parameter which are not check by the parser
194 //If the parser is set in strict mode, this will generate an error
195 if (prop_check.size() > 0)
196 {
197 bool extra_params_found = false;
198 for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
199 {
200 if (m_parser_is_strict)
201 {
202 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
203 extra_params_found = true;
204 }
205 else
206 {
207 yCWarning(Odometry2D_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
208 }
209 }
210
211 if (m_parser_is_strict && extra_params_found)
212 {
213 return false;
214 }
215 }
216 */
217 return true;
218}
219
220
222{
223 std::string doc;
224 doc = doc + std::string("\n=============================================\n");
225 doc = doc + std::string("This is the help for device: Odometry2D_nws_ros2\n");
226 doc = doc + std::string("\n");
227 doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
228 doc = doc + std::string("'period': refresh period of the broadcasted values in s\n");
229 doc = doc + std::string("'node_name': name of the ros2 node\n");
230 doc = doc + std::string("'namespace': optional namespace for ros2 node\n");
231 doc = doc + std::string("'topic_name': name of the topic where the device must publish the data\n");
232 doc = doc + std::string("'odom_frame': name of the reference frame for odometry\n");
233 doc = doc + std::string("'base_frame': name of the base frame for odometry\n");
234 doc = doc + std::string("\n");
235 doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
236 doc = doc + " yarpdev --device odometry2D_nws_ros2 --period 0.02 --node_name <mandatory_value> --namespace <optional_value> --topic_name <mandatory_value> --odom_frame <mandatory_value> --base_frame <mandatory_value>\n";
237 doc = doc + std::string("Using only mandatory params:\n");
238 doc = doc + " yarpdev --device odometry2D_nws_ros2 --node_name <mandatory_value> --topic_name <mandatory_value> --odom_frame <mandatory_value> --base_frame <mandatory_value>\n";
239 doc = doc + std::string("=============================================\n\n"); return doc;
240}
#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.
bool parseParams(const yarp::os::Searchable &config) override
Parse the DeviceDriver parameters.
std::string getDocumentationOfDeviceParams() const override
Get the documentation of the DeviceDriver's parameters.
std::string getConfiguration() const override
Return the configuration of the device.
std::vector< std::string > getListOfParams() const override
Return a list of all params used by 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 yCError(component,...)
#define YARP_LOG_COMPONENT(name,...)