ament_index_cpp
master
C++ API to access the ament resource index.
include
ament_index_cpp
get_package_prefix.hpp
1
// Copyright 2017 Open Source Robotics Foundation, Inc.
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
// http://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14
15
#ifndef AMENT_INDEX_CPP__GET_PACKAGE_PREFIX_HPP_
16
#define AMENT_INDEX_CPP__GET_PACKAGE_PREFIX_HPP_
17
18
#include <stdexcept>
19
#include <string>
20
21
#include "ament_index_cpp/visibility_control.h"
22
23
namespace
ament_index_cpp
24
{
25
27
class
PackageNotFoundError
:
public
std::out_of_range
28
{
29
public
:
31
/*
32
* \param[in] package_name used in the exception message
33
*/
34
AMENT_INDEX_CPP_PUBLIC
35
explicit
PackageNotFoundError
(
const
std::string
&
package_name
);
36
37
AMENT_INDEX_CPP_PUBLIC
38
virtual
~
PackageNotFoundError
();
39
41
const
std::string
package_name
;
42
};
43
45
50
AMENT_INDEX_CPP_PUBLIC
51
std::string
52
get_package_prefix(
const
std::string
& package_name);
53
54
}
// namespace ament_index_cpp
55
56
#endif // AMENT_INDEX_CPP__GET_PACKAGE_PREFIX_HPP_
ament_index_cpp::PackageNotFoundError
Thrown when a package is not found.
Definition:
get_package_prefix.hpp:27
ament_index_cpp::PackageNotFoundError::package_name
const std::string package_name
package name used in the exception message
Definition:
get_package_prefix.hpp:41
std::string
ament_index_cpp::PackageNotFoundError::PackageNotFoundError
PackageNotFoundError(const std::string &package_name)
Constuctor of an exception class to notify that a pacakge is not found.
std::out_of_range
Generated by
1.8.17