Nav2 Navigation Stack - humble  humble
ROS 2 Navigation Stack
path_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__PATH_ALIGN_HPP_
35 #define DWB_CRITICS__PATH_ALIGN_HPP_
36 
37 #include <vector>
38 #include <string>
39 #include "dwb_critics/path_dist.hpp"
40 
41 namespace dwb_critics
42 {
57 {
58 public:
60  : zero_scale_(false), forward_point_distance_(0.0) {}
61  void onInit() override;
62  bool prepare(
63  const geometry_msgs::msg::Pose2D & pose, const nav_2d_msgs::msg::Twist2D & vel,
64  const geometry_msgs::msg::Pose2D & goal, const nav_2d_msgs::msg::Path2D & global_plan) override;
65  double getScale() const override;
66  double scorePose(const geometry_msgs::msg::Pose2D & pose) override;
67 
68 protected:
69  bool zero_scale_;
70  double forward_point_distance_;
71 };
72 
73 } // namespace dwb_critics
74 #endif // DWB_CRITICS__PATH_ALIGN_HPP_
Scores trajectories based on how far from the global path the front of the robot ends up.
Definition: path_align.hpp:57
bool prepare(const geometry_msgs::msg::Pose2D &pose, const nav_2d_msgs::msg::Twist2D &vel, const geometry_msgs::msg::Pose2D &goal, const nav_2d_msgs::msg::Path2D &global_plan) override
Prior to evaluating any trajectories, look at contextual information constant across all trajectories...
Definition: path_align.cpp:60
double scorePose(const geometry_msgs::msg::Pose2D &pose) override
Retrieve the score for a single pose.
Definition: path_align.cpp:88
Scores trajectories based on how far from the global path they end up.
Definition: path_dist.hpp:46