wrapper_local_planner.h
Go to the documentation of this file.
1 /*
2  * Copyright 2018, Magazino GmbH, Sebastian Pütz, Jorge Santos Simón
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following
13  * disclaimer in the documentation and/or other materials provided
14  * with the distribution.
15  *
16  * 3. Neither the name of the copyright holder nor the names of its
17  * contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * wrapper_local_planner.cpp
34  *
35  * authors:
36  * Sebastian Pütz <spuetz@uni-osnabrueck.de>
37  * Jorge Santos Simón <santos@magazino.eu>
38  *
39  */
40 
41 #ifndef MBF_COSTMAP_NAV__WRAPPER_LOCAL_PLANNER_H_
42 #define MBF_COSTMAP_NAV__WRAPPER_LOCAL_PLANNER_H_
43 
46 
47 #include <mbf_utility/types.h>
48 
49 namespace mbf_nav_core_wrapper {
57  public:
58 
68  virtual uint32_t computeVelocityCommands(
69  const geometry_msgs::PoseStamped &robot_pose,
70  const geometry_msgs::TwistStamped &robot_velocity,
71  geometry_msgs::TwistStamped &cmd_vel,
72  std::string &message);
73 
78  virtual bool isGoalReached();
79 
87  virtual bool isGoalReached(double xy_tolerance, double yaw_tolerance);
88 
94  virtual bool setPlan(const std::vector<geometry_msgs::PoseStamped> &plan);
95 
101  virtual bool cancel();
102 
109  virtual void initialize(std::string name, TF *tf, costmap_2d::Costmap2DROS *costmap_ros);
110 
116 
120  virtual ~WrapperLocalPlanner();
121 
122  private:
124  };
125 } /* namespace mbf_nav_core_wrapper */
126 
127 #endif /* MBF_COSTMAP_NAV__WRAPPER_LOCAL_PLANNER_H_ */
mbf_costmap_core::CostmapController
mbf_nav_core_wrapper::WrapperLocalPlanner::cancel
virtual bool cancel()
Requests the planner to cancel, e.g. if it takes too much time.
Definition: wrapper_local_planner.cpp:72
boost::shared_ptr< nav_core::BaseLocalPlanner >
mbf_nav_core_wrapper
Definition: wrapper_global_planner.h:47
mbf_nav_core_wrapper::WrapperLocalPlanner::setPlan
virtual bool setPlan(const std::vector< geometry_msgs::PoseStamped > &plan)
Set the plan that the local planner is following.
Definition: wrapper_local_planner.cpp:67
mbf_nav_core_wrapper::WrapperLocalPlanner::nav_core_plugin_
boost::shared_ptr< nav_core::BaseLocalPlanner > nav_core_plugin_
Definition: wrapper_local_planner.h:123
mbf_nav_core_wrapper::WrapperLocalPlanner::WrapperLocalPlanner
WrapperLocalPlanner(boost::shared_ptr< nav_core::BaseLocalPlanner >plugin)
Public constructor used for handling a nav_core-based plugin.
Definition: wrapper_local_planner.cpp:87
base_local_planner.h
mbf_nav_core_wrapper::WrapperLocalPlanner::isGoalReached
virtual bool isGoalReached()
Check if the goal pose has been achieved by the local planner.
Definition: wrapper_local_planner.cpp:57
mbf_nav_core_wrapper::WrapperLocalPlanner::computeVelocityCommands
virtual uint32_t computeVelocityCommands(const geometry_msgs::PoseStamped &robot_pose, const geometry_msgs::TwistStamped &robot_velocity, geometry_msgs::TwistStamped &cmd_vel, std::string &message)
Given the current position, orientation, and velocity of the robot, compute velocity commands to send...
Definition: wrapper_local_planner.cpp:46
mbf_nav_core_wrapper::WrapperLocalPlanner::~WrapperLocalPlanner
virtual ~WrapperLocalPlanner()
Virtual destructor for the interface.
Definition: wrapper_local_planner.cpp:91
mbf_nav_core_wrapper::WrapperLocalPlanner
Definition: wrapper_local_planner.h:56
mbf_nav_core_wrapper::WrapperLocalPlanner::initialize
virtual void initialize(std::string name, TF *tf, costmap_2d::Costmap2DROS *costmap_ros)
Constructs the local planner.
Definition: wrapper_local_planner.cpp:80
tf::TransformListener
tf
costmap_controller.h
types.h
costmap_2d::Costmap2DROS


mbf_costmap_nav
Author(s): Sebastian Pütz
autogenerated on Wed Mar 2 2022 00:33:55