YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
RgbdToPointCloudSensor_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(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT, "yarp.device.RgbdToPointCloudSensor_nws_ros2")
20}
21
22
26
27
29{
30 std::vector<std::string> params;
31 params.push_back("period");
32 params.push_back("topic_name");
33 params.push_back("frame_id");
34 params.push_back("node_name");
35 params.push_back("namespace");
36 return params;
37}
38
39
40bool RgbdToPointCloudSensor_nws_ros2_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
41{
42 if (paramName =="period")
43 {
44 paramValue = std::to_string(m_period);
45 return true;
46 }
47 if (paramName =="topic_name")
48 {
49 paramValue = m_topic_name;
50 return true;
51 }
52 if (paramName =="frame_id")
53 {
54 paramValue = m_frame_id;
55 return true;
56 }
57 if (paramName =="node_name")
58 {
59 paramValue = m_node_name;
60 return true;
61 }
62 if (paramName =="namespace")
63 {
64 paramValue = m_namespace;
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(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << getDocumentationOfDeviceParams();
90 }
91
94 //Parser of parameter period
95 {
96 if (config.check("period"))
97 {
98 m_period = config.find("period").asFloat64();
99 yCInfo(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'period' using value:" << m_period;
100 }
101 else
102 {
103 yCInfo(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'period' using DEFAULT value:" << m_period;
104 }
105 prop_check.unput("period");
106 }
107
108 //Parser of parameter topic_name
109 {
110 if (config.check("topic_name"))
111 {
112 m_topic_name = config.find("topic_name").asString();
113 yCInfo(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'topic_name' using value:" << m_topic_name;
114 }
115 else
116 {
117 yCError(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'topic_name' not found!";
118 yCError(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Description of the parameter: set the name for ROS point cloud topic";
119 return false;
120 }
121 prop_check.unput("topic_name");
122 }
123
124 //Parser of parameter frame_id
125 {
126 if (config.check("frame_id"))
127 {
128 m_frame_id = config.find("frame_id").asString();
129 yCInfo(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'frame_id' using value:" << m_frame_id;
130 }
131 else
132 {
133 yCError(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'frame_id' not found!";
134 yCError(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Description of the parameter: set the name of the reference frame";
135 return false;
136 }
137 prop_check.unput("frame_id");
138 }
139
140 //Parser of parameter node_name
141 {
142 if (config.check("node_name"))
143 {
144 m_node_name = config.find("node_name").asString();
145 yCInfo(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'node_name' using value:" << m_node_name;
146 }
147 else
148 {
149 yCError(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Mandatory parameter 'node_name' not found!";
150 yCError(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Description of the parameter: set the name for ROS node";
151 return false;
152 }
153 prop_check.unput("node_name");
154 }
155
156 //Parser of parameter namespace
157 {
158 if (config.check("namespace"))
159 {
160 m_namespace = config.find("namespace").asString();
161 yCInfo(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'namespace' using value:" << m_namespace;
162 }
163 else
164 {
165 yCInfo(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "Parameter 'namespace' using DEFAULT value:" << m_namespace;
166 }
167 prop_check.unput("namespace");
168 }
169
170 /*
171 //This code check if the user set some parameter which are not check by the parser
172 //If the parser is set in strict mode, this will generate an error
173 if (prop_check.size() > 0)
174 {
175 bool extra_params_found = false;
176 for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
177 {
178 if (m_parser_is_strict)
179 {
180 yCError(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
181 extra_params_found = true;
182 }
183 else
184 {
185 yCWarning(RgbdToPointCloudSensor_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
186 }
187 }
188
189 if (m_parser_is_strict && extra_params_found)
190 {
191 return false;
192 }
193 }
194 */
195 return true;
196}
197
198
200{
201 std::string doc;
202 doc = doc + std::string("\n=============================================\n");
203 doc = doc + std::string("This is the help for device: RgbdToPointCloudSensor_nws_ros2\n");
204 doc = doc + std::string("\n");
205 doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
206 doc = doc + std::string("'period': refresh period of the broadcasted values in ms\n");
207 doc = doc + std::string("'topic_name': set the name for ROS point cloud topic\n");
208 doc = doc + std::string("'frame_id': set the name of the reference frame\n");
209 doc = doc + std::string("'node_name': set the name for ROS node\n");
210 doc = doc + std::string("'namespace': optional namespace for ros2 node\n");
211 doc = doc + std::string("\n");
212 doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
213 doc = doc + " yarpdev --device rgbdToPointCloudSensor_nws_ros2 --period 0.03 --topic_name <mandatory_value> --frame_id <mandatory_value> --node_name <mandatory_value> --namespace <optional_value>\n";
214 doc = doc + std::string("Using only mandatory params:\n");
215 doc = doc + " yarpdev --device rgbdToPointCloudSensor_nws_ros2 --topic_name <mandatory_value> --frame_id <mandatory_value> --node_name <mandatory_value>\n";
216 doc = doc + std::string("=============================================\n\n"); return doc;
217}
#define yError(...)
Definition Log.h:361
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.
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:32
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,...)