Nav2 Navigation Stack - kilted  kilted
ROS 2 Navigation Stack
planner_exceptions.hpp
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2017, Locus Robotics
5  * Copyright (c) 2019, Intel Corporation
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 #ifndef NAV2_CORE__PLANNER_EXCEPTIONS_HPP_
37 #define NAV2_CORE__PLANNER_EXCEPTIONS_HPP_
38 
39 #include <stdexcept>
40 #include <string>
41 #include <memory>
42 
43 namespace nav2_core
44 {
45 
46 class PlannerException : public std::runtime_error
47 {
48 public:
49  explicit PlannerException(const std::string & description)
50  : std::runtime_error(description) {}
51 };
52 
54 {
55 public:
56  explicit InvalidPlanner(const std::string & description)
57  : PlannerException(description) {}
58 };
59 
61 {
62 public:
63  explicit StartOccupied(const std::string & description)
64  : PlannerException(description) {}
65 };
66 
68 {
69 public:
70  explicit GoalOccupied(const std::string & description)
71  : PlannerException(description) {}
72 };
73 
75 {
76 public:
77  explicit StartOutsideMapBounds(const std::string & description)
78  : PlannerException(description) {}
79 };
80 
82 {
83 public:
84  explicit GoalOutsideMapBounds(const std::string & description)
85  : PlannerException(description) {}
86 };
87 
89 {
90 public:
91  explicit NoValidPathCouldBeFound(const std::string & description)
92  : PlannerException(description) {}
93 };
94 
96 {
97 public:
98  explicit PlannerTimedOut(const std::string & description)
99  : PlannerException(description) {}
100 };
101 
103 {
104 public:
105  explicit PlannerTFError(const std::string & description)
106  : PlannerException(description) {}
107 };
108 
110 {
111 public:
112  explicit NoViapointsGiven(const std::string & description)
113  : PlannerException(description) {}
114 };
115 
117 {
118 public:
119  explicit PlannerCancelled(const std::string & description)
120  : PlannerException(description) {}
121 };
122 
123 } // namespace nav2_core
124 
125 #endif // NAV2_CORE__PLANNER_EXCEPTIONS_HPP_