YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Battery_nwc_yarp_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.2)
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_GENERATION is ON.
10
11// Generated on: Tue Jul 28 23:33:25 2026
12
13
15#include <yarp/os/LogStream.h>
16#include <yarp/os/Value.h>
17
18namespace {
19 YARP_LOG_COMPONENT(Battery_nwc_yarpParamsCOMPONENT, "yarp.device.Battery_nwc_yarp")
20}
21
22
26
27
28std::vector<std::string> Battery_nwc_yarp_ParamsParser::getListOfParams() const
29{
30 std::vector<std::string> params;
31 params.push_back("local");
32 params.push_back("remote");
33 params.push_back("rpc_carrier");
34 params.push_back("rpc_timeout");
35 params.push_back("carrier");
36 return params;
37}
38
39
40bool Battery_nwc_yarp_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
41{
42 if (paramName =="local")
43 {
44 paramValue = m_local;
45 return true;
46 }
47 if (paramName =="remote")
48 {
49 paramValue = m_remote;
50 return true;
51 }
52 if (paramName =="rpc_carrier")
53 {
54 paramValue = m_rpc_carrier;
55 return true;
56 }
57 if (paramName =="rpc_timeout")
58 {
59 paramValue = std::to_string(m_rpc_timeout);
60 return true;
61 }
62 if (paramName =="carrier")
63 {
64 paramValue = m_carrier;
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(Battery_nwc_yarpParamsCOMPONENT) << getDocumentationOfDeviceParams();
90 }
91
94 //Parser of parameter local
95 {
96 if (config.check("local"))
97 {
98 m_local = config.find("local").asString();
99 yCInfo(Battery_nwc_yarpParamsCOMPONENT) << "Parameter 'local' using value:" << m_local;
100 }
101 else
102 {
103 yCError(Battery_nwc_yarpParamsCOMPONENT) << "Mandatory parameter 'local' not found!";
104 yCError(Battery_nwc_yarpParamsCOMPONENT) << "Description of the parameter: Full port name opened by the nwc device.";
105 return false;
106 }
107 prop_check.unput("local");
108 }
109
110 //Parser of parameter remote
111 {
112 if (config.check("remote"))
113 {
114 m_remote = config.find("remote").asString();
115 yCInfo(Battery_nwc_yarpParamsCOMPONENT) << "Parameter 'remote' using value:" << m_remote;
116 }
117 else
118 {
119 yCError(Battery_nwc_yarpParamsCOMPONENT) << "Mandatory parameter 'remote' not found!";
120 yCError(Battery_nwc_yarpParamsCOMPONENT) << "Description of the parameter: Full port name of the port remotely opened by the nws device, to which the nwc connects to.";
121 return false;
122 }
123 prop_check.unput("remote");
124 }
125
126 //Parser of parameter rpc_carrier
127 {
128 if (config.check("rpc_carrier"))
129 {
130 m_rpc_carrier = config.find("rpc_carrier").asString();
131 yCInfo(Battery_nwc_yarpParamsCOMPONENT) << "Parameter 'rpc_carrier' using value:" << m_rpc_carrier;
132 }
133 else
134 {
135 yCInfo(Battery_nwc_yarpParamsCOMPONENT) << "Parameter 'rpc_carrier' using DEFAULT value:" << m_rpc_carrier;
136 }
137 prop_check.unput("rpc_carrier");
138 }
139
140 //Parser of parameter rpc_timeout
141 {
142 if (config.check("rpc_timeout"))
143 {
144 m_rpc_timeout = config.find("rpc_timeout").asFloat64();
145 yCInfo(Battery_nwc_yarpParamsCOMPONENT) << "Parameter 'rpc_timeout' using value:" << m_rpc_timeout;
146 }
147 else
148 {
149 yCInfo(Battery_nwc_yarpParamsCOMPONENT) << "Parameter 'rpc_timeout' using DEFAULT value:" << m_rpc_timeout;
150 }
151 prop_check.unput("rpc_timeout");
152 }
153
154 //Parser of parameter carrier
155 {
156 if (config.check("carrier"))
157 {
158 m_carrier = config.find("carrier").asString();
159 yCInfo(Battery_nwc_yarpParamsCOMPONENT) << "Parameter 'carrier' using value:" << m_carrier;
160 }
161 else
162 {
163 yCInfo(Battery_nwc_yarpParamsCOMPONENT) << "Parameter 'carrier' using DEFAULT value:" << m_carrier;
164 }
165 prop_check.unput("carrier");
166 }
167
168 /*
169 //This code check if the user set some parameter which are not check by the parser
170 //If the parser is set in strict mode, this will generate an error
171 if (prop_check.size() > 0)
172 {
173 bool extra_params_found = false;
174 for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
175 {
176 if (m_parser_is_strict)
177 {
178 yCError(Battery_nwc_yarpParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
179 extra_params_found = true;
180 }
181 else
182 {
183 yCWarning(Battery_nwc_yarpParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
184 }
185 }
186
187 if (m_parser_is_strict && extra_params_found)
188 {
189 return false;
190 }
191 }
192 */
193 return true;
194}
195
196
198{
199 std::string doc;
200 doc = doc + std::string("\n=============================================\n");
201 doc = doc + std::string("This is the help for device: Battery_nwc_yarp\n");
202 doc = doc + std::string("\n");
203 doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
204 doc = doc + std::string("'local': Full port name opened by the nwc device.\n");
205 doc = doc + std::string("'remote': Full port name of the port remotely opened by the nws device, to which the nwc connects to.\n");
206 doc = doc + std::string("'rpc_carrier': The carrier used for the RPC connection with the server.\n");
207 doc = doc + std::string("'rpc_timeout': Timeout for RPC calls. Default value: -1 = infinite\n");
208 doc = doc + std::string("'carrier': The carrier used for the streaming connection with the server.\n");
209 doc = doc + std::string("\n");
210 doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
211 doc = doc + " yarpdev --device battery_nwc_yarp --local <mandatory_value> --remote <mandatory_value> --rpc_carrier fast_tcp --rpc_timeout -1 --carrier fast_tcp\n";
212 doc = doc + std::string("Using only mandatory params:\n");
213 doc = doc + " yarpdev --device battery_nwc_yarp --local <mandatory_value> --remote <mandatory_value>\n";
214 doc = doc + std::string("=============================================\n\n"); return doc;
215}
#define yError(...)
Definition Log.h:361
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.
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.
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,...)