1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
// C++ informative line for the emacs editor: -*- C++ -*-
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#ifndef H5Exception_H
#define H5Exception_H
#include <string>
namespace H5 {
#define H5std_string std::string
/*! \class Exception
\brief Exception provides wrappers of HDF5 error handling functions.
Many classes are derived from Exception for specific HDF5 C interfaces.
*/
class H5_DLLCPP Exception {
public:
// Creates an exception with a function name where the failure occurs
// and an optional detailed message
Exception(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
// Returns a character string that describes the error specified by
// a major error number.
H5std_string getMajorString(hid_t err_major_id) const;
// Returns a character string that describes the error specified by
// a minor error number.
H5std_string getMinorString(hid_t err_minor_id) const;
// Returns the detailed message set at the time the exception is thrown
H5std_string getDetailMsg() const;
const char * getCDetailMsg() const; // C string of detailed message
H5std_string getFuncName() const; // function name as a string object
const char * getCFuncName() const; // function name as a char string
// Turns on the automatic error printing.
static void setAutoPrint(H5E_auto2_t &func, void *client_data);
// Turns off the automatic error printing.
static void dontPrint();
// Retrieves the current settings for the automatic error stack
// traversal function and its data.
static void getAutoPrint(H5E_auto2_t &func, void **client_data);
// Clears the error stack for the current thread.
static void clearErrorStack();
// Walks the error stack for the current thread, calling the
// specified function.
static void walkErrorStack(H5E_direction_t direction, H5E_walk2_t func, void *client_data);
// Prints the error stack in a default manner.
static void printErrorStack(FILE *stream = stderr, hid_t err_stack = H5E_DEFAULT);
// Deprecated in favor of printErrorStack.
// Removed from code. -BMR, 2017/08/11 1.8.20 and 1.10.2
// virtual void printError(FILE* stream = NULL) const;
// Default constructor
Exception();
// copy constructor
Exception(const Exception &orig);
// virtual Destructor
virtual ~Exception() throw();
protected:
// Default value for detail_message
static const char DEFAULT_MSG[];
private:
H5std_string detail_message;
H5std_string func_name;
};
class H5_DLLCPP FileIException : public Exception {
public:
FileIException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
FileIException();
virtual ~FileIException() throw() H5_OVERRIDE;
};
class H5_DLLCPP GroupIException : public Exception {
public:
GroupIException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
GroupIException();
virtual ~GroupIException() throw() H5_OVERRIDE;
};
class H5_DLLCPP DataSpaceIException : public Exception {
public:
DataSpaceIException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
DataSpaceIException();
virtual ~DataSpaceIException() throw() H5_OVERRIDE;
};
class H5_DLLCPP DataTypeIException : public Exception {
public:
DataTypeIException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
DataTypeIException();
virtual ~DataTypeIException() throw() H5_OVERRIDE;
};
class H5_DLLCPP ObjHeaderIException : public Exception {
public:
ObjHeaderIException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
ObjHeaderIException();
virtual ~ObjHeaderIException() throw() H5_OVERRIDE;
};
class H5_DLLCPP PropListIException : public Exception {
public:
PropListIException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
PropListIException();
virtual ~PropListIException() throw() H5_OVERRIDE;
};
class H5_DLLCPP DataSetIException : public Exception {
public:
DataSetIException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
DataSetIException();
virtual ~DataSetIException() throw() H5_OVERRIDE;
};
class H5_DLLCPP AttributeIException : public Exception {
public:
AttributeIException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
AttributeIException();
virtual ~AttributeIException() throw() H5_OVERRIDE;
};
class H5_DLLCPP ReferenceException : public Exception {
public:
ReferenceException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
ReferenceException();
virtual ~ReferenceException() throw() H5_OVERRIDE;
};
class H5_DLLCPP LibraryIException : public Exception {
public:
LibraryIException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
LibraryIException();
virtual ~LibraryIException() throw() H5_OVERRIDE;
};
class H5_DLLCPP LocationException : public Exception {
public:
LocationException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
LocationException();
virtual ~LocationException() throw() H5_OVERRIDE;
};
class H5_DLLCPP IdComponentException : public Exception {
public:
IdComponentException(const H5std_string &func_name, const H5std_string &message = DEFAULT_MSG);
IdComponentException();
virtual ~IdComponentException() throw() H5_OVERRIDE;
}; // end of IdComponentException
} // namespace H5
#endif // H5Exception_H
|
