costmap_2d_publisher.hpp

/*********************************************************************
 *
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2008, 2013, Willow Garage, Inc.
 *  Copyright (c) 2019, Samsung Research America, Inc.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of Willow Garage, Inc. nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 * Author: Eitan Marder-Eppstein
 *         David V. Lu!!
 *********************************************************************/
#ifndef NAV2_COSTMAP_2D__COSTMAP_2D_PUBLISHER_HPP_
#define NAV2_COSTMAP_2D__COSTMAP_2D_PUBLISHER_HPP_
 
#include <algorithm>
#include <atomic>
#include <string>
#include <memory>
 
#include "rclcpp_lifecycle/lifecycle_node.hpp"
#include "nav2_costmap_2d/costmap_2d.hpp"
#include "nav_msgs/msg/occupancy_grid.hpp"
#include "map_msgs/msg/occupancy_grid_update.hpp"
#include "nav2_msgs/msg/costmap.hpp"
#include "nav2_msgs/msg/costmap_update.hpp"
#include "nav2_msgs/srv/get_costmap.hpp"
#include "tf2/transform_datatypes.hpp"
#include "nav2_ros_common/lifecycle_node.hpp"
#include "tf2/LinearMath/Quaternion.hpp"
#include "tf2_geometry_msgs/tf2_geometry_msgs.hpp"
#include "nav2_ros_common/service_server.hpp"
 
namespace nav2_costmap_2d
{
class Costmap2DPublisher
{
public:
  Costmap2DPublisher(
    const nav2::LifecycleNode::WeakPtr & parent,
    Costmap2D * costmap,
    std::string global_frame,
    std::string topic_name,
    bool always_send_full_costmap = false,
    double map_vis_z = 0.0);
 
  ~Costmap2DPublisher();
 
  void on_configure() {}
 
  void on_activate()
  {
    costmap_pub_->on_activate();
    costmap_update_pub_->on_activate();
    costmap_raw_pub_->on_activate();
    costmap_raw_update_pub_->on_activate();
  }
 
  void on_deactivate()
  {
    costmap_pub_->on_deactivate();
    costmap_update_pub_->on_deactivate();
    costmap_raw_pub_->on_deactivate();
    costmap_raw_update_pub_->on_deactivate();
  }
 
  void on_cleanup() {}
 
  void updateBounds(unsigned int x0, unsigned int xn, unsigned int y0, unsigned int yn)
  {
    x0_ = std::min(x0, x0_);
    xn_ = std::max(xn, xn_);
    y0_ = std::min(y0, y0_);
    yn_ = std::max(yn, yn_);
  }
 
  void publishCostmap();
 
  bool isRepublishRequested() const
  {
    return republish_costmap_.load();
  }
 
private:
  void prepareGrid();
  void prepareCostmap();
 
  std::unique_ptr<map_msgs::msg::OccupancyGridUpdate> createGridUpdateMsg();
  std::unique_ptr<nav2_msgs::msg::CostmapUpdate> createCostmapUpdateMsg();
 
  void updateGridParams();
 
  void costmap_service_callback(
    const std::shared_ptr<rmw_request_id_t> request_header,
    const std::shared_ptr<nav2_msgs::srv::GetCostmap::Request> request,
    const std::shared_ptr<nav2_msgs::srv::GetCostmap::Response> response);
 
  rclcpp::Clock::SharedPtr clock_;
  rclcpp::Logger logger_{rclcpp::get_logger("nav2_costmap_2d")};
 
  Costmap2D * costmap_;
  std::string global_frame_;
  std::string topic_name_;
  unsigned int x0_{0};
  unsigned int xn_{0};
  unsigned int y0_{0};
  unsigned int yn_{0};
  double saved_origin_x_{0.0};
  double saved_origin_y_{0.0};
  bool always_send_full_costmap_{false};
  bool costmap_published_once_{false};
  std::atomic<bool> republish_costmap_{false};
  double map_vis_z_{0.0};
 
  // Publisher for translated costmap values as msg::OccupancyGrid used in visualization
  nav2::Publisher<nav_msgs::msg::OccupancyGrid>::SharedPtr costmap_pub_;
  nav2::Publisher<map_msgs::msg::OccupancyGridUpdate>::SharedPtr
    costmap_update_pub_;
 
  // Publisher for raw costmap values as msg::Costmap from layered costmap
  nav2::Publisher<nav2_msgs::msg::Costmap>::SharedPtr costmap_raw_pub_;
  nav2::Publisher<nav2_msgs::msg::CostmapUpdate>::SharedPtr
    costmap_raw_update_pub_;
 
  // Service for getting the costmaps
  nav2::ServiceServer<nav2_msgs::srv::GetCostmap>::SharedPtr
    costmap_service_;
 
  float grid_resolution_{0.0};
  unsigned int grid_width_{0};
  unsigned int grid_height_{0};
  std::unique_ptr<nav_msgs::msg::OccupancyGrid> grid_;
  std::unique_ptr<nav2_msgs::msg::Costmap> costmap_raw_;
  // Translate from 0-255 values in costmap to -1 to 100 values in message.
  static char * cost_translation_table_;
};
 
}  // namespace nav2_costmap_2d
 
#endif  // NAV2_COSTMAP_2D__COSTMAP_2D_PUBLISHER_HPP_