costmap_planner.h
Go to the documentation of this file.
1 /*
2  * Copyright 2018, Sebastian Pütz
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  * abstract_global_planner.h
34  *
35  * author: Sebastian Pütz <spuetz@uni-osnabrueck.de>
36  *
37  */
38 
39 #ifndef MBF_COSTMAP_CORE__COSTMAP_PLANNER_H_
40 #define MBF_COSTMAP_CORE__COSTMAP_PLANNER_H_
41 
44 
45 namespace mbf_costmap_core {
53  public:
54 
56 
82  virtual uint32_t makePlan(const geometry_msgs::PoseStamped &start, const geometry_msgs::PoseStamped &goal,
83  double tolerance, std::vector<geometry_msgs::PoseStamped> &plan, double &cost,
84  std::string &message) = 0;
85 
91  virtual bool cancel() = 0;
92 
98  virtual void initialize(std::string name, costmap_2d::Costmap2DROS *costmap_ros) = 0;
99 
103  virtual ~CostmapPlanner(){}
104 
105  protected:
107 
108  };
109 } /* namespace mbf_costmap_core */
110 
111 #endif /* MBF_COSTMAP_CORE__COSTMAP_PLANNER_H_ */
boost::shared_ptr
mbf_costmap_core::CostmapPlanner::~CostmapPlanner
virtual ~CostmapPlanner()
Virtual destructor for the interface.
Definition: costmap_planner.h:103
costmap_2d_ros.h
mbf_costmap_core::CostmapPlanner::makePlan
virtual uint32_t makePlan(const geometry_msgs::PoseStamped &start, const geometry_msgs::PoseStamped &goal, double tolerance, std::vector< geometry_msgs::PoseStamped > &plan, double &cost, std::string &message)=0
Given a goal pose in the world, compute a plan.
mbf_costmap_core::CostmapPlanner::initialize
virtual void initialize(std::string name, costmap_2d::Costmap2DROS *costmap_ros)=0
Initialization function for the CostmapPlanner.
mbf_costmap_core::CostmapPlanner
Provides an interface for global planners used in navigation. All global planners written to work as ...
Definition: costmap_planner.h:52
abstract_planner.h
mbf_abstract_core::AbstractPlanner
mbf_costmap_core::CostmapPlanner::cancel
virtual bool cancel()=0
Requests the planner to cancel, e.g. if it takes too much time.
mbf_costmap_core
Definition: costmap_controller.h:46
mbf_costmap_core::CostmapPlanner::CostmapPlanner
CostmapPlanner()
Definition: costmap_planner.h:106
costmap_2d::Costmap2DROS
mbf_costmap_core::CostmapPlanner::Ptr
boost::shared_ptr< ::mbf_costmap_core::CostmapPlanner > Ptr
Definition: costmap_planner.h:55


mbf_costmap_core
Author(s): Jorge Santos , Sebastian Pütz
autogenerated on Wed Mar 2 2022 00:33:52