YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
FrameTransformSet_nwc_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(FrameTransformSet_nwc_ros2ParamsCOMPONENT, "yarp.device.FrameTransformSet_nwc_ros2")
20}
21
22
26
27
29{
30 std::vector<std::string> params;
31 params.push_back("GENERAL::refresh_interval");
32 params.push_back("GENERAL::period");
33 params.push_back("GENERAL::asynch_pub");
34 params.push_back("ROS2::ft_node");
35 params.push_back("ROS2::namespace");
36 params.push_back("ROS2::ft_topic");
37 params.push_back("ROS2::ft_topic_static");
38 return params;
39}
40
41
42bool FrameTransformSet_nwc_ros2_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
43{
44 if (paramName =="GENERAL::refresh_interval")
45 {
46 paramValue = std::to_string(m_GENERAL_refresh_interval);
47 return true;
48 }
49 if (paramName =="GENERAL::period")
50 {
51 paramValue = std::to_string(m_GENERAL_period);
52 return true;
53 }
54 if (paramName =="GENERAL::asynch_pub")
55 {
56 paramValue = std::to_string(m_GENERAL_asynch_pub);
57 return true;
58 }
59 if (paramName =="ROS2::ft_node")
60 {
61 paramValue = m_ROS2_ft_node;
62 return true;
63 }
64 if (paramName =="ROS2::namespace")
65 {
66 paramValue = m_ROS2_namespace;
67 return true;
68 }
69 if (paramName =="ROS2::ft_topic")
70 {
71 paramValue = m_ROS2_ft_topic;
72 return true;
73 }
74 if (paramName =="ROS2::ft_topic_static")
75 {
76 paramValue = m_ROS2_ft_topic_static;
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(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << getDocumentationOfDeviceParams();
102 }
103
106 //Parser of parameter GENERAL::refresh_interval
107 {
108 yarp::os::Bottle sectionp;
109 sectionp = config.findGroup("GENERAL");
110 if (sectionp.check("refresh_interval"))
111 {
112 m_GENERAL_refresh_interval = sectionp.find("refresh_interval").asFloat64();
113 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'GENERAL::refresh_interval' using value:" << m_GENERAL_refresh_interval;
114 }
115 else
116 {
117 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'GENERAL::refresh_interval' using DEFAULT value:" << m_GENERAL_refresh_interval;
118 }
119 prop_check.unput("GENERAL::refresh_interval");
120 }
121
122 //Parser of parameter GENERAL::period
123 {
124 yarp::os::Bottle sectionp;
125 sectionp = config.findGroup("GENERAL");
126 if (sectionp.check("period"))
127 {
128 m_GENERAL_period = sectionp.find("period").asFloat64();
129 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'GENERAL::period' using value:" << m_GENERAL_period;
130 }
131 else
132 {
133 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'GENERAL::period' using DEFAULT value:" << m_GENERAL_period;
134 }
135 prop_check.unput("GENERAL::period");
136 }
137
138 //Parser of parameter GENERAL::asynch_pub
139 {
140 yarp::os::Bottle sectionp;
141 sectionp = config.findGroup("GENERAL");
142 if (sectionp.check("asynch_pub"))
143 {
144 m_GENERAL_asynch_pub = sectionp.find("asynch_pub").asInt64();
145 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'GENERAL::asynch_pub' using value:" << m_GENERAL_asynch_pub;
146 }
147 else
148 {
149 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'GENERAL::asynch_pub' using DEFAULT value:" << m_GENERAL_asynch_pub;
150 }
151 prop_check.unput("GENERAL::asynch_pub");
152 }
153
154 //Parser of parameter ROS2::ft_node
155 {
156 yarp::os::Bottle sectionp;
157 sectionp = config.findGroup("ROS2");
158 if (sectionp.check("ft_node"))
159 {
160 m_ROS2_ft_node = sectionp.find("ft_node").asString();
161 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_node' using value:" << m_ROS2_ft_node;
162 }
163 else
164 {
165 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_node' using DEFAULT value:" << m_ROS2_ft_node;
166 }
167 prop_check.unput("ROS2::ft_node");
168 }
169
170 //Parser of parameter ROS2::namespace
171 {
172 yarp::os::Bottle sectionp;
173 sectionp = config.findGroup("ROS2");
174 if (sectionp.check("namespace"))
175 {
176 m_ROS2_namespace = sectionp.find("namespace").asString();
177 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::namespace' using value:" << m_ROS2_namespace;
178 }
179 else
180 {
181 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::namespace' using DEFAULT value:" << m_ROS2_namespace;
182 }
183 prop_check.unput("ROS2::namespace");
184 }
185
186 //Parser of parameter ROS2::ft_topic
187 {
188 yarp::os::Bottle sectionp;
189 sectionp = config.findGroup("ROS2");
190 if (sectionp.check("ft_topic"))
191 {
192 m_ROS2_ft_topic = sectionp.find("ft_topic").asString();
193 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic' using value:" << m_ROS2_ft_topic;
194 }
195 else
196 {
197 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic' using DEFAULT value:" << m_ROS2_ft_topic;
198 }
199 prop_check.unput("ROS2::ft_topic");
200 }
201
202 //Parser of parameter ROS2::ft_topic_static
203 {
204 yarp::os::Bottle sectionp;
205 sectionp = config.findGroup("ROS2");
206 if (sectionp.check("ft_topic_static"))
207 {
208 m_ROS2_ft_topic_static = sectionp.find("ft_topic_static").asString();
209 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic_static' using value:" << m_ROS2_ft_topic_static;
210 }
211 else
212 {
213 yCInfo(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic_static' using DEFAULT value:" << m_ROS2_ft_topic_static;
214 }
215 prop_check.unput("ROS2::ft_topic_static");
216 }
217
218 /*
219 //This code check if the user set some parameter which are not check by the parser
220 //If the parser is set in strict mode, this will generate an error
221 if (prop_check.size() > 0)
222 {
223 bool extra_params_found = false;
224 for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
225 {
226 if (m_parser_is_strict)
227 {
228 yCError(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
229 extra_params_found = true;
230 }
231 else
232 {
233 yCWarning(FrameTransformSet_nwc_ros2ParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
234 }
235 }
236
237 if (m_parser_is_strict && extra_params_found)
238 {
239 return false;
240 }
241 }
242 */
243 return true;
244}
245
246
248{
249 std::string doc;
250 doc = doc + std::string("\n=============================================\n");
251 doc = doc + std::string("This is the help for device: FrameTransformSet_nwc_ros2\n");
252 doc = doc + std::string("\n");
253 doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
254 doc = doc + std::string("'GENERAL::refresh_interval': The time interval outside which timed ft will be deleted\n");
255 doc = doc + std::string("'GENERAL::period': The PeriodicThread period in seconds\n");
256 doc = doc + std::string("'GENERAL::asynch_pub': If 1, the fts will be published not only every \"period\" seconds but also when set functions are called\n");
257 doc = doc + std::string("'ROS2::ft_node': The name of the ROS2 node\n");
258 doc = doc + std::string("'ROS2::namespace': optional namespace for ros2 node\n");
259 doc = doc + std::string("'ROS2::ft_topic': The name of the ROS2 topic from which fts will be received\n");
260 doc = doc + std::string("'ROS2::ft_topic_static': The name of the ROS2 topic from which static fts will be received\n");
261 doc = doc + std::string("\n");
262 doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
263 doc = doc + " yarpdev --device frameTransformSet_nwc_ros2 --GENERAL::refresh_interval 0.1 --GENERAL::period 0.01 --GENERAL::asynch_pub 1 --ROS2::ft_node tfNodeSet --ROS2::namespace <optional_value> --ROS2::ft_topic /tf --ROS2::ft_topic_static /tf_static\n";
264 doc = doc + std::string("Using only mandatory params:\n");
265 doc = doc + " yarpdev --device frameTransformSet_nwc_ros2\n";
266 doc = doc + std::string("=============================================\n\n"); return doc;
267}
#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.
bool parseParams(const yarp::os::Searchable &config) override
Parse the DeviceDriver parameters.
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.
A simple collection of objects that can be described and transmitted in a portable way.
Definition Bottle.h:65
bool check(const std::string &key) const override
Check if there exists a property of the given name.
Definition Bottle.cpp:283
Value & find(const std::string &key) const override
Gets a value corresponding to a given keyword.
Definition Bottle.cpp:293
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 Bottle & findGroup(const std::string &key) const =0
Gets a list corresponding to a given keyword.
virtual yarp::conf::float64_t asFloat64() const
Get 64-bit floating point value.
Definition Value.cpp:228
virtual std::int64_t asInt64() const
Get 64-bit integer value.
Definition Value.cpp:216
virtual std::string asString() const
Get string value.
Definition Value.cpp:246
#define yCInfo(component,...)
#define YARP_LOG_COMPONENT(name,...)