openPMD-api
ThrowError.hpp
1 /* Copyright 2022 Franz Poeschel
2  *
3  * This file is part of openPMD-api.
4  *
5  * openPMD-api is free software: you can redistribute it and/or modify
6  * it under the terms of of either the GNU General Public License or
7  * the GNU Lesser General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * openPMD-api is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License and the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * and the GNU Lesser General Public License along with openPMD-api.
19  * If not, see <http://www.gnu.org/licenses/>.
20  */
21 
22 #pragma once
23 
24 #include "openPMD/auxiliary/Export.hpp"
25 
26 #include <optional>
27 #include <string>
28 #include <vector>
29 
30 namespace openPMD::error
31 {
32 enum class AffectedObject
33 {
34  Attribute,
35  Dataset,
36  File,
37  Group,
38  Other
39 };
40 
41 enum class Reason
42 {
43  NotFound,
44  CannotRead,
45  UnexpectedContent,
46  Inaccessible,
47  Other
48 };
49 
50 [[noreturn]] OPENPMDAPI_EXPORT void
51 throwBackendConfigSchema(std::vector<std::string> jsonPath, std::string what);
52 
53 [[noreturn]] OPENPMDAPI_EXPORT void throwOperationUnsupportedInBackend(
54  std::string backend, std::string const &what);
55 
56 [[noreturn]] OPENPMDAPI_EXPORT void throwReadError(
57  AffectedObject affectedObject,
58  Reason reason_in,
59  std::optional<std::string> backend,
60  std::string description_in);
61 
62 [[noreturn]] OPENPMDAPI_EXPORT void
63 throwNoSuchAttribute(std::string attributeName);
64 } // namespace openPMD::error