PlannerNode.hpp

Go to the documentation of this file.

// Copyright 2025 Intelligent Robotics Lab
//
// This file is part of the project Easy Navigation (EasyNav in short)
// licensed under the GNU General Public License v3.0.
// See <http://www.gnu.org/licenses/> for details.
//
// Easy Navigation program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

 
#ifndef EASYNAV_PLANNER__PLANNERNODE_HPP_
#define EASYNAV_PLANNER__PLANNERNODE_HPP_
 
#include "rclcpp/macros.hpp"
#include "rclcpp_lifecycle/lifecycle_node.hpp"
#include "easynav_core/PlannerMethodBase.hpp"
#include "pluginlib/class_loader.hpp"
#include "nav_msgs/msg/path.hpp"
#include "easynav_common/types/NavState.hpp"
 
namespace easynav
{

class PlannerNode : public rclcpp_lifecycle::LifecycleNode
{
public:
  RCLCPP_SMART_PTR_DEFINITIONS(PlannerNode)
  using CallbackReturnT = rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn;

  explicit PlannerNode(
    const rclcpp::NodeOptions & options = rclcpp::NodeOptions());

  ~PlannerNode();

  CallbackReturnT on_configure(const rclcpp_lifecycle::State & state);

  CallbackReturnT on_activate(const rclcpp_lifecycle::State & state);

  CallbackReturnT on_deactivate(const rclcpp_lifecycle::State & state);

  CallbackReturnT on_cleanup(const rclcpp_lifecycle::State & state);

  CallbackReturnT on_shutdown(const rclcpp_lifecycle::State & state);

  CallbackReturnT on_error(const rclcpp_lifecycle::State & state);

  [[nodiscard]] nav_msgs::msg::Path get_path() const;

  void cycle(std::shared_ptr<NavState> nav_state);
 
private:
  std::unique_ptr<pluginlib::ClassLoader<PlannerMethodBase>> planner_loader_;

  std::shared_ptr<PlannerMethodBase> planner_method_ {nullptr};
};
 
}  // namespace easynav
 
#endif  // EASYNAV_PLANNER__PLANNERNODE_HPP_