YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
FrameTransformGet_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(FrameTransformGet_nwc_ros2ParamsCOMPONENT, "yarp.device.FrameTransformGet_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("ROS2::ft_node");
33 params.push_back("ROS2::namespace");
34 params.push_back("ROS2::ft_topic");
35 params.push_back("ROS2::ft_topic_static");
36 return params;
37}
38
39
40bool FrameTransformGet_nwc_ros2_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
41{
42 if (paramName =="GENERAL::refresh_interval")
43 {
44 paramValue = std::to_string(m_GENERAL_refresh_interval);
45 return true;
46 }
47 if (paramName =="ROS2::ft_node")
48 {
49 paramValue = m_ROS2_ft_node;
50 return true;
51 }
52 if (paramName =="ROS2::namespace")
53 {
54 paramValue = m_ROS2_namespace;
55 return true;
56 }
57 if (paramName =="ROS2::ft_topic")
58 {
59 paramValue = m_ROS2_ft_topic;
60 return true;
61 }
62 if (paramName =="ROS2::ft_topic_static")
63 {
64 paramValue = m_ROS2_ft_topic_static;
65 return true;
66 }
67
68 yError() <<"parameter '" << paramName << "' was not found";
69 return false;
70
71}
72
73
75{
76 //This is a sub-optimal solution.
77 //Ideally getConfiguration() should return all parameters but it is currently
78 //returning only user provided parameters (excluding default values)
79 //This behaviour will be fixed in the near future.
80 std::string s_cfg = m_provided_configuration;
81 return s_cfg;
82}
83
85{
86 //Check for --help option
87 if (config.check("help"))
88 {
89 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << getDocumentationOfDeviceParams();
90 }
91
94 //Parser of parameter GENERAL::refresh_interval
95 {
96 yarp::os::Bottle sectionp;
97 sectionp = config.findGroup("GENERAL");
98 if (sectionp.check("refresh_interval"))
99 {
100 m_GENERAL_refresh_interval = sectionp.find("refresh_interval").asFloat64();
101 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'GENERAL::refresh_interval' using value:" << m_GENERAL_refresh_interval;
102 }
103 else
104 {
105 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'GENERAL::refresh_interval' using DEFAULT value:" << m_GENERAL_refresh_interval;
106 }
107 prop_check.unput("GENERAL::refresh_interval");
108 }
109
110 //Parser of parameter ROS2::ft_node
111 {
112 yarp::os::Bottle sectionp;
113 sectionp = config.findGroup("ROS2");
114 if (sectionp.check("ft_node"))
115 {
116 m_ROS2_ft_node = sectionp.find("ft_node").asString();
117 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_node' using value:" << m_ROS2_ft_node;
118 }
119 else
120 {
121 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_node' using DEFAULT value:" << m_ROS2_ft_node;
122 }
123 prop_check.unput("ROS2::ft_node");
124 }
125
126 //Parser of parameter ROS2::namespace
127 {
128 yarp::os::Bottle sectionp;
129 sectionp = config.findGroup("ROS2");
130 if (sectionp.check("namespace"))
131 {
132 m_ROS2_namespace = sectionp.find("namespace").asString();
133 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::namespace' using value:" << m_ROS2_namespace;
134 }
135 else
136 {
137 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::namespace' using DEFAULT value:" << m_ROS2_namespace;
138 }
139 prop_check.unput("ROS2::namespace");
140 }
141
142 //Parser of parameter ROS2::ft_topic
143 {
144 yarp::os::Bottle sectionp;
145 sectionp = config.findGroup("ROS2");
146 if (sectionp.check("ft_topic"))
147 {
148 m_ROS2_ft_topic = sectionp.find("ft_topic").asString();
149 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic' using value:" << m_ROS2_ft_topic;
150 }
151 else
152 {
153 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic' using DEFAULT value:" << m_ROS2_ft_topic;
154 }
155 prop_check.unput("ROS2::ft_topic");
156 }
157
158 //Parser of parameter ROS2::ft_topic_static
159 {
160 yarp::os::Bottle sectionp;
161 sectionp = config.findGroup("ROS2");
162 if (sectionp.check("ft_topic_static"))
163 {
164 m_ROS2_ft_topic_static = sectionp.find("ft_topic_static").asString();
165 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic_static' using value:" << m_ROS2_ft_topic_static;
166 }
167 else
168 {
169 yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic_static' using DEFAULT value:" << m_ROS2_ft_topic_static;
170 }
171 prop_check.unput("ROS2::ft_topic_static");
172 }
173
174 /*
175 //This code check if the user set some parameter which are not check by the parser
176 //If the parser is set in strict mode, this will generate an error
177 if (prop_check.size() > 0)
178 {
179 bool extra_params_found = false;
180 for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
181 {
182 if (m_parser_is_strict)
183 {
184 yCError(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
185 extra_params_found = true;
186 }
187 else
188 {
189 yCWarning(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
190 }
191 }
192
193 if (m_parser_is_strict && extra_params_found)
194 {
195 return false;
196 }
197 }
198 */
199 return true;
200}
201
202
204{
205 std::string doc;
206 doc = doc + std::string("\n=============================================\n");
207 doc = doc + std::string("This is the help for device: FrameTransformGet_nwc_ros2\n");
208 doc = doc + std::string("\n");
209 doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
210 doc = doc + std::string("'GENERAL::refresh_interval': The time interval outside which timed ft will be deleted\n");
211 doc = doc + std::string("'ROS2::ft_node': The name of the ROS2 node\n");
212 doc = doc + std::string("'ROS2::namespace': optional namespace for ros2 node\n");
213 doc = doc + std::string("'ROS2::ft_topic': The name of the ROS2 topic from which fts will be received\n");
214 doc = doc + std::string("'ROS2::ft_topic_static': The name of the ROS2 topic from which static fts will be received\n");
215 doc = doc + std::string("\n");
216 doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
217 doc = doc + " yarpdev --device frameTransformGet_nwc_ros2 --GENERAL::refresh_interval 0.1 --ROS2::ft_node tfNodeGet --ROS2::namespace <optional_value> --ROS2::ft_topic /tf --ROS2::ft_topic_static /tf_static\n";
218 doc = doc + std::string("Using only mandatory params:\n");
219 doc = doc + " yarpdev --device frameTransformGet_nwc_ros2\n";
220 doc = doc + std::string("=============================================\n\n"); return doc;
221}
#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 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.
std::string getConfiguration() const override
Return the configuration of the device.
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::string asString() const
Get string value.
Definition Value.cpp:246
#define yCInfo(component,...)
#define YARP_LOG_COMPONENT(name,...)