Nav2 Navigation Stack - rolling  main
ROS 2 Navigation Stack
goal_align.hpp
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2017, Locus 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 the copyright holder 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 HOLDER 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 #ifndef DWB_CRITICS__GOAL_ALIGN_HPP_
35 #define DWB_CRITICS__GOAL_ALIGN_HPP_
36 
37 #include <vector>
38 #include <string>
39 #include "dwb_critics/goal_dist.hpp"
40 
41 namespace dwb_critics
42 {
43 
53 {
54 public:
56  : forward_point_distance_(0.0) {}
57  void onInit() override;
58  bool prepare(
59  const geometry_msgs::msg::Pose & pose, const nav_2d_msgs::msg::Twist2D & vel,
60  const geometry_msgs::msg::Pose & goal, const nav_msgs::msg::Path & global_plan) override;
61  double scorePose(const geometry_msgs::msg::Pose & pose) override;
62 
63 protected:
64  double forward_point_distance_;
65 };
66 
67 } // namespace dwb_critics
68 #endif // DWB_CRITICS__GOAL_ALIGN_HPP_
Scores trajectories based on whether the robot ends up pointing toward the eventual goal.
Definition: goal_align.hpp:53
bool prepare(const geometry_msgs::msg::Pose &pose, const nav_2d_msgs::msg::Twist2D &vel, const geometry_msgs::msg::Pose &goal, const nav_msgs::msg::Path &global_plan) override
Prior to evaluating any trajectories, look at contextual information constant across all trajectories...
Definition: goal_align.cpp:58
double scorePose(const geometry_msgs::msg::Pose &pose) override
Retrieve the score for a single pose.
Definition: goal_align.cpp:78
Scores trajectories based on how far along the global path they end up.
Definition: goal_dist.hpp:51