global_planner.h
Go to the documentation of this file.
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 NAV_CORE2_GLOBAL_PLANNER_H
35 #define NAV_CORE2_GLOBAL_PLANNER_H
36 
37 #include <nav_core2/common.h>
38 #include <nav_core2/costmap.h>
39 #include <nav_2d_msgs/Path2D.h>
40 #include <nav_2d_msgs/Pose2DStamped.h>
41 #include <string>
42 
43 namespace nav_core2
44 {
45 
51 {
52 public:
56  virtual ~GlobalPlanner() {}
57 
69  virtual void initialize(const ros::NodeHandle& parent, const std::string& name,
70  TFListenerPtr tf, Costmap::Ptr costmap) = 0;
71 
78  virtual nav_2d_msgs::Path2D makePlan(const nav_2d_msgs::Pose2DStamped& start,
79  const nav_2d_msgs::Pose2DStamped& goal) = 0;
80 };
81 } // namespace nav_core2
82 
83 #endif // NAV_CORE2_GLOBAL_PLANNER_H
virtual void initialize(const ros::NodeHandle &parent, const std::string &name, TFListenerPtr tf, Costmap::Ptr costmap)=0
Initialization function for the GlobalPlanner.
Provides an interface for global planners used in navigation.
virtual ~GlobalPlanner()
Virtual Destructor.
virtual nav_2d_msgs::Path2D makePlan(const nav_2d_msgs::Pose2DStamped &start, const nav_2d_msgs::Pose2DStamped &goal)=0
Run the global planner to make a plan starting at the start and ending at the goal.
std::shared_ptr< Costmap > Ptr
Definition: costmap.h:55
std::shared_ptr< tf::TransformListener > TFListenerPtr
Definition: common.h:40


nav_core2
Author(s):
autogenerated on Wed Jun 26 2019 20:06:06