forked from robotology/yarp-devices-ros2
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added ParamsParser to FrameTransformGet_nws_ros2
Signed-off-by: Ettore Landini <[email protected]>
- Loading branch information
1 parent
4e10399
commit fdb6f33
Showing
6 changed files
with
254 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
159 changes: 159 additions & 0 deletions
159
src/devices/frameTransformGet_nwc_ros2/FrameTransformGet_nwc_ros2_ParamsParser.cpp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| /* | ||
| * SPDX-FileCopyrightText: 2023-2023 Istituto Italiano di Tecnologia (IIT) | ||
| * SPDX-License-Identifier: LGPL-2.1-or-later | ||
| */ | ||
|
|
||
|
|
||
| // Generated by yarpDeviceParamParserGenerator (1.0) | ||
| // This is an automatically generated file. Please do not edit it. | ||
| // It will be re-generated if the cmake flag ALLOW_DEVICE_PARAM_PARSER_GERNERATION is ON. | ||
|
|
||
| // Generated on: Mon Aug 26 14:52:35 2024 | ||
|
|
||
|
|
||
| #include "FrameTransformGet_nwc_ros2_ParamsParser.h" | ||
| #include <yarp/os/LogStream.h> | ||
| #include <yarp/os/Value.h> | ||
|
|
||
| namespace { | ||
| YARP_LOG_COMPONENT(FrameTransformGet_nwc_ros2ParamsCOMPONENT, "yarp.device.FrameTransformGet_nwc_ros2") | ||
| } | ||
|
|
||
|
|
||
| FrameTransformGet_nwc_ros2_ParamsParser::FrameTransformGet_nwc_ros2_ParamsParser() | ||
| { | ||
| } | ||
|
|
||
|
|
||
| std::vector<std::string> FrameTransformGet_nwc_ros2_ParamsParser::getListOfParams() const | ||
| { | ||
| std::vector<std::string> params; | ||
| params.push_back("GENERAL::refresh_interval"); | ||
| params.push_back("ROS2::ft_node"); | ||
| params.push_back("ROS2::ft_topic"); | ||
| params.push_back("ROS2::ft_topic_static"); | ||
| return params; | ||
| } | ||
|
|
||
|
|
||
| bool FrameTransformGet_nwc_ros2_ParamsParser::parseParams(const yarp::os::Searchable & config) | ||
| { | ||
| //Check for --help option | ||
| if (config.check("help")) | ||
| { | ||
| yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << getDocumentationOfDeviceParams(); | ||
| } | ||
|
|
||
| std::string config_string = config.toString(); | ||
| yarp::os::Property prop_check(config_string.c_str()); | ||
| //Parser of parameter GENERAL::refresh_interval | ||
| { | ||
| yarp::os::Bottle sectionp; | ||
| sectionp = config.findGroup("GENERAL"); | ||
| if (sectionp.check("refresh_interval")) | ||
| { | ||
| m_GENERAL_refresh_interval = sectionp.find("refresh_interval").asFloat64(); | ||
| yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'GENERAL::refresh_interval' using value:" << m_GENERAL_refresh_interval; | ||
| } | ||
| else | ||
| { | ||
| yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'GENERAL::refresh_interval' using DEFAULT value:" << m_GENERAL_refresh_interval; | ||
| } | ||
| prop_check.unput("GENERAL::refresh_interval"); | ||
| } | ||
|
|
||
| //Parser of parameter ROS2::ft_node | ||
| { | ||
| yarp::os::Bottle sectionp; | ||
| sectionp = config.findGroup("ROS2"); | ||
| if (sectionp.check("ft_node")) | ||
| { | ||
| m_ROS2_ft_node = sectionp.find("ft_node").asString(); | ||
| yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_node' using value:" << m_ROS2_ft_node; | ||
| } | ||
| else | ||
| { | ||
| yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_node' using DEFAULT value:" << m_ROS2_ft_node; | ||
| } | ||
| prop_check.unput("ROS2::ft_node"); | ||
| } | ||
|
|
||
| //Parser of parameter ROS2::ft_topic | ||
| { | ||
| yarp::os::Bottle sectionp; | ||
| sectionp = config.findGroup("ROS2"); | ||
| if (sectionp.check("ft_topic")) | ||
| { | ||
| m_ROS2_ft_topic = sectionp.find("ft_topic").asString(); | ||
| yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic' using value:" << m_ROS2_ft_topic; | ||
| } | ||
| else | ||
| { | ||
| yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic' using DEFAULT value:" << m_ROS2_ft_topic; | ||
| } | ||
| prop_check.unput("ROS2::ft_topic"); | ||
| } | ||
|
|
||
| //Parser of parameter ROS2::ft_topic_static | ||
| { | ||
| yarp::os::Bottle sectionp; | ||
| sectionp = config.findGroup("ROS2"); | ||
| if (sectionp.check("ft_topic_static")) | ||
| { | ||
| m_ROS2_ft_topic_static = sectionp.find("ft_topic_static").asString(); | ||
| yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic_static' using value:" << m_ROS2_ft_topic_static; | ||
| } | ||
| else | ||
| { | ||
| yCInfo(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "Parameter 'ROS2::ft_topic_static' using DEFAULT value:" << m_ROS2_ft_topic_static; | ||
| } | ||
| prop_check.unput("ROS2::ft_topic_static"); | ||
| } | ||
|
|
||
| /* | ||
| //This code check if the user set some parameter which are not check by the parser | ||
| //If the parser is set in strict mode, this will generate an error | ||
| if (prop_check.size() > 0) | ||
| { | ||
| bool extra_params_found = false; | ||
| for (auto it=prop_check.begin(); it!=prop_check.end(); it++) | ||
| { | ||
| if (m_parser_is_strict) | ||
| { | ||
| yCError(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!"; | ||
| extra_params_found = true; | ||
| } | ||
| else | ||
| { | ||
| yCWarning(FrameTransformGet_nwc_ros2ParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!"; | ||
| } | ||
| } | ||
| if (m_parser_is_strict && extra_params_found) | ||
| { | ||
| return false; | ||
| } | ||
| } | ||
| */ | ||
| return true; | ||
| } | ||
|
|
||
|
|
||
| std::string FrameTransformGet_nwc_ros2_ParamsParser::getDocumentationOfDeviceParams() const | ||
| { | ||
| std::string doc; | ||
| doc = doc + std::string("\n=============================================\n"); | ||
| doc = doc + std::string("This is the help for device: FrameTransformGet_nwc_ros2\n"); | ||
| doc = doc + std::string("\n"); | ||
| doc = doc + std::string("This is the list of the parameters accepted by the device:\n"); | ||
| doc = doc + std::string("'GENERAL::refresh_interval': The time interval outside which timed ft will be deleted\n"); | ||
| doc = doc + std::string("'ROS2::ft_node': The name of the ROS2 node\n"); | ||
| doc = doc + std::string("'ROS2::ft_topic': The name of the ROS2 topic from which fts will be received\n"); | ||
| doc = doc + std::string("'ROS2::ft_topic_static': The name of the ROS2 topic from which static fts will be received\n"); | ||
| doc = doc + std::string("\n"); | ||
| doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n"); | ||
| doc = doc + " yarpdev --device frameTransformGet_nwc_ros2 --GENERAL::refresh_interval 0.1 --ROS2::ft_node tfNodeGet --ROS2::ft_topic /tf --ROS2::ft_topic_static /tf_static\n"; | ||
| doc = doc + std::string("Using only mandatory params:\n"); | ||
| doc = doc + " yarpdev --device frameTransformGet_nwc_ros2\n"; | ||
| doc = doc + std::string("=============================================\n\n"); return doc; | ||
| } |
78 changes: 78 additions & 0 deletions
78
src/devices/frameTransformGet_nwc_ros2/FrameTransformGet_nwc_ros2_ParamsParser.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * SPDX-FileCopyrightText: 2023-2023 Istituto Italiano di Tecnologia (IIT) | ||
| * SPDX-License-Identifier: LGPL-2.1-or-later | ||
| */ | ||
|
|
||
|
|
||
| // Generated by yarpDeviceParamParserGenerator (1.0) | ||
| // This is an automatically generated file. Please do not edit it. | ||
| // It will be re-generated if the cmake flag ALLOW_DEVICE_PARAM_PARSER_GERNERATION is ON. | ||
|
|
||
| // Generated on: Mon Aug 26 14:52:35 2024 | ||
|
|
||
|
|
||
| #ifndef FRAMETRANSFORMGET_NWC_ROS2_PARAMSPARSER_H | ||
| #define FRAMETRANSFORMGET_NWC_ROS2_PARAMSPARSER_H | ||
|
|
||
| #include <yarp/os/Searchable.h> | ||
| #include <yarp/dev/IDeviceDriverParams.h> | ||
| #include <string> | ||
| #include <cmath> | ||
|
|
||
| /** | ||
| * This class is the parameters parser for class FrameTransformGet_nwc_ros2. | ||
| * | ||
| * These are the used parameters: | ||
| * | Group name | Parameter name | Type | Units | Default Value | Required | Description | Notes | | ||
| * |:----------:|:----------------:|:------:|:-------:|:-------------:|:--------:|:-----------------------------------------------------------------:|:-----:| | ||
| * | GENERAL | refresh_interval | double | seconds | 0.1 | 0 | The time interval outside which timed ft will be deleted | - | | ||
| * | ROS2 | ft_node | string | - | tfNodeGet | 0 | The name of the ROS2 node | - | | ||
| * | ROS2 | ft_topic | string | - | /tf | 0 | The name of the ROS2 topic from which fts will be received | - | | ||
| * | ROS2 | ft_topic_static | string | - | /tf_static | 0 | The name of the ROS2 topic from which static fts will be received | - | | ||
| * | ||
| * The device can be launched by yarpdev using one of the following examples (with and without all optional parameters): | ||
| * \code{.unparsed} | ||
| * yarpdev --device frameTransformGet_nwc_ros2 --GENERAL::refresh_interval 0.1 --ROS2::ft_node tfNodeGet --ROS2::ft_topic /tf --ROS2::ft_topic_static /tf_static | ||
| * \endcode | ||
| * | ||
| * \code{.unparsed} | ||
| * yarpdev --device frameTransformGet_nwc_ros2 | ||
| * \endcode | ||
| * | ||
| */ | ||
|
|
||
| class FrameTransformGet_nwc_ros2_ParamsParser : public yarp::dev::IDeviceDriverParams | ||
| { | ||
| public: | ||
| FrameTransformGet_nwc_ros2_ParamsParser(); | ||
| ~FrameTransformGet_nwc_ros2_ParamsParser() override = default; | ||
|
|
||
| public: | ||
| const std::string m_device_classname = {"FrameTransformGet_nwc_ros2"}; | ||
| const std::string m_device_name = {"frameTransformGet_nwc_ros2"}; | ||
| bool m_parser_is_strict = false; | ||
| struct parser_version_type | ||
| { | ||
| int major = 1; | ||
| int minor = 0; | ||
| }; | ||
| const parser_version_type m_parser_version = {}; | ||
|
|
||
| const std::string m_GENERAL_refresh_interval_defaultValue = {"0.1"}; | ||
| const std::string m_ROS2_ft_node_defaultValue = {"tfNodeGet"}; | ||
| const std::string m_ROS2_ft_topic_defaultValue = {"/tf"}; | ||
| const std::string m_ROS2_ft_topic_static_defaultValue = {"/tf_static"}; | ||
|
|
||
| double m_GENERAL_refresh_interval = {0.1}; | ||
| std::string m_ROS2_ft_node = {"tfNodeGet"}; | ||
| std::string m_ROS2_ft_topic = {"/tf"}; | ||
| std::string m_ROS2_ft_topic_static = {"/tf_static"}; | ||
|
|
||
| bool parseParams(const yarp::os::Searchable & config) override; | ||
| std::string getDeviceClassName() const override { return m_device_classname; } | ||
| std::string getDeviceName() const override { return m_device_name; } | ||
| std::string getDocumentationOfDeviceParams() const override; | ||
| std::vector<std::string> getListOfParams() const override; | ||
| }; | ||
|
|
||
| #endif |
4 changes: 4 additions & 0 deletions
4
src/devices/frameTransformGet_nwc_ros2/FrameTransformGet_nwc_ros2_params.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| | GENERAL | refresh_interval | double | seconds | 0.1 | No | The time interval outside which timed ft will be deleted | | ||
| | ROS2 | ft_node | string | - | tfNodeGet | No | The name of the ROS2 node | | ||
| | ROS2 | ft_topic | string | - | /tf | No | The name of the ROS2 topic from which fts will be received | | ||
| | ROS2 | ft_topic_static | string | - | /tf_static | No | The name of the ROS2 topic from which static fts will be received | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters