moveit2
The MoveIt Motion Planning Framework for ROS 2.
setup_step.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 
37 #pragma once
38 #include <rclcpp/node.hpp>
40 
41 namespace moveit_setup
42 {
46 class SetupStep
47 {
48 public:
49  SetupStep() = default;
50  SetupStep(const SetupStep&) = default;
51  SetupStep(SetupStep&&) = default;
52  SetupStep& operator=(const SetupStep&) = default;
53  SetupStep& operator=(SetupStep&&) = default;
54  virtual ~SetupStep() = default;
55 
60  void initialize(const rclcpp::Node::SharedPtr& parent_node, const DataWarehousePtr& config_data)
61  {
62  parent_node_ = parent_node;
63  config_data_ = config_data;
64  logger_ = std::make_shared<rclcpp::Logger>(parent_node->get_logger().get_child(getName()));
65  onInit();
66  }
67 
71  virtual void onInit()
72  {
73  }
74 
78  virtual std::string getName() const = 0;
79 
83  virtual bool isReady() const
84  {
85  return true;
86  }
87 
91  const rclcpp::Logger& getLogger() const
92  {
93  return *logger_;
94  }
95 
96 protected:
97  DataWarehousePtr config_data_;
98  rclcpp::Node::SharedPtr parent_node_;
99  std::shared_ptr<rclcpp::Logger> logger_;
100 };
101 } // namespace moveit_setup
Contains all of the non-GUI code necessary for doing one "screen" worth of setup.
Definition: setup_step.hpp:47
SetupStep & operator=(SetupStep &&)=default
rclcpp::Node::SharedPtr parent_node_
Definition: setup_step.hpp:98
SetupStep & operator=(const SetupStep &)=default
DataWarehousePtr config_data_
Definition: setup_step.hpp:97
virtual std::string getName() const =0
Returns the name of the setup step.
virtual ~SetupStep()=default
SetupStep(SetupStep &&)=default
SetupStep(const SetupStep &)=default
virtual void onInit()
Overridable initialization method.
Definition: setup_step.hpp:71
const rclcpp::Logger & getLogger() const
Makes a namespaced logger for this step available to the widget.
Definition: setup_step.hpp:91
std::shared_ptr< rclcpp::Logger > logger_
Definition: setup_step.hpp:99
void initialize(const rclcpp::Node::SharedPtr &parent_node, const DataWarehousePtr &config_data)
Called after construction to initialize the step.
Definition: setup_step.hpp:60
virtual bool isReady() const
Return true if the data necessary to proceed with this step has been configured.
Definition: setup_step.hpp:83