19 YARP_LOG_COMPONENT(Odometry2D_nws_ros2ParamsCOMPONENT,
"yarp.device.Odometry2D_nws_ros2")
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 params.push_back(
"odom_frame");
36 params.push_back(
"base_frame");
43 if (paramName ==
"period")
45 paramValue = std::to_string(
m_period);
48 if (paramName ==
"node_name")
53 if (paramName ==
"namespace")
58 if (paramName ==
"topic_name")
63 if (paramName ==
"odom_frame")
68 if (paramName ==
"base_frame")
74 yError() <<
"parameter '" << paramName <<
"' was not found";
93 if (config.
check(
"help"))
102 if (config.
check(
"period"))
105 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Parameter 'period' using value:" <<
m_period;
109 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Parameter 'period' using DEFAULT value:" <<
m_period;
111 prop_check.
unput(
"period");
116 if (config.
check(
"node_name"))
119 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Parameter 'node_name' using value:" <<
m_node_name;
123 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Mandatory parameter 'node_name' not found!";
124 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Description of the parameter: name of the ros2 node";
127 prop_check.
unput(
"node_name");
132 if (config.
check(
"namespace"))
135 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Parameter 'namespace' using value:" <<
m_namespace;
139 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Parameter 'namespace' using DEFAULT value:" <<
m_namespace;
141 prop_check.
unput(
"namespace");
146 if (config.
check(
"topic_name"))
149 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Parameter 'topic_name' using value:" <<
m_topic_name;
153 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Mandatory parameter 'topic_name' not found!";
154 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Description of the parameter: name of the topic where the device must publish the data";
157 prop_check.
unput(
"topic_name");
162 if (config.
check(
"odom_frame"))
165 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Parameter 'odom_frame' using value:" <<
m_odom_frame;
169 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Mandatory parameter 'odom_frame' not found!";
170 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Description of the parameter: name of the reference frame for odometry";
173 prop_check.
unput(
"odom_frame");
178 if (config.
check(
"base_frame"))
181 yCInfo(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Parameter 'base_frame' using value:" <<
m_base_frame;
185 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Mandatory parameter 'base_frame' not found!";
186 yCError(Odometry2D_nws_ros2ParamsCOMPONENT) <<
"Description of the parameter: name of the base frame for odometry";
189 prop_check.
unput(
"base_frame");
224 doc = doc + std::string(
"\n=============================================\n");
225 doc = doc + std::string(
"This is the help for device: Odometry2D_nws_ros2\n");
226 doc = doc + std::string(
"\n");
227 doc = doc + std::string(
"This is the list of the parameters accepted by the device:\n");
228 doc = doc + std::string(
"'period': refresh period of the broadcasted values in s\n");
229 doc = doc + std::string(
"'node_name': name of the ros2 node\n");
230 doc = doc + std::string(
"'namespace': optional namespace for ros2 node\n");
231 doc = doc + std::string(
"'topic_name': name of the topic where the device must publish the data\n");
232 doc = doc + std::string(
"'odom_frame': name of the reference frame for odometry\n");
233 doc = doc + std::string(
"'base_frame': name of the base frame for odometry\n");
234 doc = doc + std::string(
"\n");
235 doc = doc + std::string(
"Here are some examples of invocation command with yarpdev, with all params:\n");
236 doc = doc +
" yarpdev --device odometry2D_nws_ros2 --period 0.02 --node_name <mandatory_value> --namespace <optional_value> --topic_name <mandatory_value> --odom_frame <mandatory_value> --base_frame <mandatory_value>\n";
237 doc = doc + std::string(
"Using only mandatory params:\n");
238 doc = doc +
" yarpdev --device odometry2D_nws_ros2 --node_name <mandatory_value> --topic_name <mandatory_value> --odom_frame <mandatory_value> --base_frame <mandatory_value>\n";
239 doc = doc + std::string(
"=============================================\n\n");
return doc;
Odometry2D_nws_ros2_ParamsParser()
bool getParamValue(const std::string ¶mName, std::string ¶mValue) 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 m_provided_configuration
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.
A class for storing options and configuration information.
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.
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,...)