YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
HapticDevice_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: Wed Apr 22 17:50:17 2026
12
13
15#include <yarp/os/LogStream.h>
16#include <yarp/os/Value.h>
17
18namespace {
19 YARP_LOG_COMPONENT(HapticDevice_nws_ros2ParamsCOMPONENT, "yarp.device.HapticDevice_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 return params;
36}
37
38
39bool HapticDevice_nws_ros2_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
40{
41 if (paramName =="period")
42 {
43 paramValue = std::to_string(m_period);
44 return true;
45 }
46 if (paramName =="node_name")
47 {
48 paramValue = m_node_name;
49 return true;
50 }
51 if (paramName =="namespace")
52 {
53 paramValue = m_namespace;
54 return true;
55 }
56 if (paramName =="topic_name")
57 {
58 paramValue = m_topic_name;
59 return true;
60 }
61
62 yError() <<"parameter '" << paramName << "' was not found";
63 return false;
64
65}
66
67
69{
70 //This is a sub-optimal solution.
71 //Ideally getConfiguration() should return all parameters but it is currently
72 //returning only user provided parameters (excluding default values)
73 //This behaviour will be fixed in the near future.
74 std::string s_cfg = m_provided_configuration;
75 return s_cfg;
76}
77
79{
80 //Check for --help option
81 if (config.check("help"))
82 {
83 yCInfo(HapticDevice_nws_ros2ParamsCOMPONENT) << getDocumentationOfDeviceParams();
84 }
85
88 //Parser of parameter period
89 {
90 if (config.check("period"))
91 {
92 m_period = config.find("period").asFloat64();
93 yCInfo(HapticDevice_nws_ros2ParamsCOMPONENT) << "Parameter 'period' using value:" << m_period;
94 }
95 else
96 {
97 yCInfo(HapticDevice_nws_ros2ParamsCOMPONENT) << "Parameter 'period' using DEFAULT value:" << m_period;
98 }
99 prop_check.unput("period");
100 }
101
102 //Parser of parameter node_name
103 {
104 if (config.check("node_name"))
105 {
106 m_node_name = config.find("node_name").asString();
107 yCInfo(HapticDevice_nws_ros2ParamsCOMPONENT) << "Parameter 'node_name' using value:" << m_node_name;
108 }
109 else
110 {
111 yCInfo(HapticDevice_nws_ros2ParamsCOMPONENT) << "Parameter 'node_name' using DEFAULT value:" << m_node_name;
112 }
113 prop_check.unput("node_name");
114 }
115
116 //Parser of parameter namespace
117 {
118 if (config.check("namespace"))
119 {
120 m_namespace = config.find("namespace").asString();
121 yCInfo(HapticDevice_nws_ros2ParamsCOMPONENT) << "Parameter 'namespace' using value:" << m_namespace;
122 }
123 else
124 {
125 yCInfo(HapticDevice_nws_ros2ParamsCOMPONENT) << "Parameter 'namespace' using DEFAULT value:" << m_namespace;
126 }
127 prop_check.unput("namespace");
128 }
129
130 //Parser of parameter topic_name
131 {
132 if (config.check("topic_name"))
133 {
134 m_topic_name = config.find("topic_name").asString();
135 yCInfo(HapticDevice_nws_ros2ParamsCOMPONENT) << "Parameter 'topic_name' using value:" << m_topic_name;
136 }
137 else
138 {
139 yCInfo(HapticDevice_nws_ros2ParamsCOMPONENT) << "Parameter 'topic_name' using DEFAULT value:" << m_topic_name;
140 }
141 prop_check.unput("topic_name");
142 }
143
144 /*
145 //This code check if the user set some parameter which are not check by the parser
146 //If the parser is set in strict mode, this will generate an error
147 if (prop_check.size() > 0)
148 {
149 bool extra_params_found = false;
150 for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
151 {
152 if (m_parser_is_strict)
153 {
154 yCError(HapticDevice_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
155 extra_params_found = true;
156 }
157 else
158 {
159 yCWarning(HapticDevice_nws_ros2ParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
160 }
161 }
162
163 if (m_parser_is_strict && extra_params_found)
164 {
165 return false;
166 }
167 }
168 */
169 return true;
170}
171
172
174{
175 std::string doc;
176 doc = doc + std::string("\n=============================================\n");
177 doc = doc + std::string("This is the help for device: HapticDevice_nws_ros2\n");
178 doc = doc + std::string("\n");
179 doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
180 doc = doc + std::string("'period': refresh period\n");
181 doc = doc + std::string("'node_name': name of node\n");
182 doc = doc + std::string("'namespace': optional namespace for ros2 node\n");
183 doc = doc + std::string("'topic_name': topic name where publish (not '/')\n");
184 doc = doc + std::string("\n");
185 doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
186 doc = doc + " yarpdev --device hapticDevice_nws_ros2 --period 0.02 --node_name hapticDevice_nws_ros2 --namespace <optional_value> --topic_name <optional_value>\n";
187 doc = doc + std::string("Using only mandatory params:\n");
188 doc = doc + " yarpdev --device hapticDevice_nws_ros2\n";
189 doc = doc + std::string("=============================================\n\n"); return doc;
190}
#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 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,...)