19 YARP_LOG_COMPONENT(ControlBoard_nws_ros2ParamsCOMPONENT,
"yarp.device.ControlBoard_nws_ros2")
30 std::vector<std::string> params;
31 params.push_back(
"node_name");
32 params.push_back(
"namespace");
33 params.push_back(
"topic_name");
34 params.push_back(
"msgs_name");
35 params.push_back(
"period");
42 if (paramName ==
"node_name")
47 if (paramName ==
"namespace")
52 if (paramName ==
"topic_name")
57 if (paramName ==
"msgs_name")
62 if (paramName ==
"period")
64 paramValue = std::to_string(
m_period);
68 yError() <<
"parameter '" << paramName <<
"' was not found";
87 if (config.
check(
"help"))
96 if (config.
check(
"node_name"))
99 yCInfo(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Parameter 'node_name' using value:" <<
m_node_name;
103 yCError(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Mandatory parameter 'node_name' not found!";
104 yCError(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Description of the parameter: set the name for ROS node";
107 prop_check.
unput(
"node_name");
112 if (config.
check(
"namespace"))
115 yCInfo(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Parameter 'namespace' using value:" <<
m_namespace;
119 yCInfo(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Parameter 'namespace' using DEFAULT value:" <<
m_namespace;
121 prop_check.
unput(
"namespace");
126 if (config.
check(
"topic_name"))
129 yCInfo(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Parameter 'topic_name' using value:" <<
m_topic_name;
133 yCError(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Mandatory parameter 'topic_name' not found!";
134 yCError(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Description of the parameter: set the name for ROS topic";
137 prop_check.
unput(
"topic_name");
142 if (config.
check(
"msgs_name"))
145 yCInfo(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Parameter 'msgs_name' using value:" <<
m_msgs_name;
149 yCInfo(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Parameter 'msgs_name' using DEFAULT value:" <<
m_msgs_name;
151 prop_check.
unput(
"msgs_name");
156 if (config.
check(
"period"))
159 yCInfo(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Parameter 'period' using value:" <<
m_period;
163 yCInfo(ControlBoard_nws_ros2ParamsCOMPONENT) <<
"Parameter 'period' using DEFAULT value:" <<
m_period;
165 prop_check.
unput(
"period");
200 doc = doc + std::string(
"\n=============================================\n");
201 doc = doc + std::string(
"This is the help for device: ControlBoard_nws_ros2\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(
"'node_name': set the name for ROS node\n");
205 doc = doc + std::string(
"'namespace': optional namespace for ros2 node\n");
206 doc = doc + std::string(
"'topic_name': set the name for ROS topic\n");
207 doc = doc + std::string(
"'msgs_name': set the base name for the topics and interfaces\n");
208 doc = doc + std::string(
"'period': refresh period of the broadcasted values in s\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 controlBoard_nws_ros2 --node_name <mandatory_value> --namespace <optional_value> --topic_name <mandatory_value> --msgs_name <optional_value> --period 0.02\n";
212 doc = doc + std::string(
"Using only mandatory params:\n");
213 doc = doc +
" yarpdev --device controlBoard_nws_ros2 --node_name <mandatory_value> --topic_name <mandatory_value>\n";
214 doc = doc + std::string(
"=============================================\n\n");
return doc;
bool getParamValue(const std::string ¶mName, std::string ¶mValue) const override
Return the value (represented as a string) of the requested parameter.
ControlBoard_nws_ros2_ParamsParser()
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.
std::string m_provided_configuration
bool parseParams(const yarp::os::Searchable &config) override
Parse the DeviceDriver parameters.
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,...)