moveit2
The MoveIt Motion Planning Framework for ROS 2.
perception_config.hpp
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2021, PickNik Robotics
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of PickNik Robotics nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *********************************************************************/
34 
35 /* Author: David V. Lu!! */
36 #pragma once
37 
40 
41 namespace moveit_setup
42 {
43 namespace app
44 {
45 using SensorParameters = std::map<std::string, std::string>;
46 
48 {
49 public:
50  void loadPrevious(const std::filesystem::path& package_path, const YAML::Node& node) override;
51 
53  static std::vector<SensorParameters> load3DSensorsYAML(const std::filesystem::path& file_path);
54 
55  bool isConfigured() const override
56  {
58  }
59 
63  const std::vector<SensorParameters>& getSensorPluginConfig()
64  {
66  }
67 
72 
73  void setConfig(const SensorParameters& parameters);
74 
76  {
77  public:
78  GeneratedSensorConfig(const std::filesystem::path& package_path, const GeneratedTime& last_gen_time,
79  PerceptionConfig& parent)
80  : YamlGeneratedFile(package_path, last_gen_time), parent_(parent)
81  {
82  }
83 
84  bool hasChanges() const override
85  {
86  return parent_.changed_;
87  }
88 
89  std::filesystem::path getRelativePath() const override
90  {
91  return "config/sensors_3d.yaml";
92  }
93 
94  std::string getDescription() const override
95  {
96  return "Configuration for perception with 3d sensors.";
97  }
98 
99  bool writeYaml(YAML::Emitter& emitter) override;
100 
101  protected:
103  };
104 
105  void collectFiles(const std::filesystem::path& package_path, const GeneratedTime& last_gen_time,
106  std::vector<GeneratedFilePtr>& files) override
107  {
108  files.push_back(std::make_shared<GeneratedSensorConfig>(package_path, last_gen_time, *this));
109  }
110 
111 protected:
113  std::vector<SensorParameters> sensors_plugin_config_parameter_list_;
114  bool changed_{ false };
115 };
116 } // namespace app
117 } // namespace moveit_setup
where all the data for each part of the configuration is stored.
Definition: config.hpp:58
std::string getDescription() const override
Returns an English description of this file's purpose.
GeneratedSensorConfig(const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, PerceptionConfig &parent)
bool hasChanges() const override
Returns true if this file will have changes when it is written to file.
std::filesystem::path getRelativePath() const override
Returns the path relative to the configuration package root.
const std::vector< SensorParameters > & getSensorPluginConfig()
Used for adding a sensor plugin configuration parameter to the sensor plugin configuration parameter ...
void setConfig(const SensorParameters &parameters)
void collectFiles(const std::filesystem::path &package_path, const GeneratedTime &last_gen_time, std::vector< GeneratedFilePtr > &files) override
Collect the files generated by this configuration and add them to the vector.
bool isConfigured() const override
Return true if this part of the configuration is completely set up.
static std::vector< SensorParameters > load3DSensorsYAML(const std::filesystem::path &file_path)
Load perception sensor config.
std::vector< SensorParameters > sensors_plugin_config_parameter_list_
Sensor plugin configuration parameter list, each sensor plugin type is a map of string pairs.
void loadPrevious(const std::filesystem::path &package_path, const YAML::Node &node) override
Loads the configuration from an existing MoveIt configuration.
void clearSensorPluginConfig()
Clear the sensor plugin configuration parameter list.
std::map< std::string, std::string > SensorParameters
std::filesystem::file_time_type GeneratedTime