-
Notifications
You must be signed in to change notification settings - Fork 12
/
bag_exceptions.h
455 lines (386 loc) · 12.2 KB
/
bag_exceptions.h
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
#ifndef BAG_EXCEPTIONS_H
#define BAG_EXCEPTIONS_H
#include "bag_config.h"
#include "bag_errors.h"
#include "bag_types.h"
#include <exception>
#include <sstream>
namespace BAG {
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4275)
#pragma warning(disable: 4251) // class 'std::basic_string<char,std::char_traits<char>,std::allocator<char>>' needs to have dll-interface to be used by clients of struct 'BAG::UknownMetadataProfile'
#endif
// General
//! Compression was requested, but no chunking was specified.
struct BAG_API CompressionNeedsChunkingSet final : virtual std::exception
{
const char* what() const noexcept override
{
return "If compression is desired, a chunk positive chunk size must be set.";
}
};
// Attribute related.
//! Attribute type not supported (yet)
struct BAG_API UnsupportedAttributeType final : virtual std::exception
{
const char* what() const noexcept override
{
return "The H5 type of this attribute is not float. Not supported (yet).";
}
};
// CompoundDataType related.
//! Layer not found.
struct BAG_API InvalidType final : virtual std::exception
{
const char* what() const noexcept override
{
return "The type specified does not match what is stored.";
}
};
//! Invalid descriptor found.
struct BAG_API InvalidDescriptor final : virtual std::exception
{
const char* what() const noexcept override
{
return "The descriptor is not a CompoundDataDescriptor.";
}
};
//! Invalid key type specified.
struct BAG_API InvalidKeyType final : virtual std::exception
{
const char* what() const noexcept override
{
return "The type specified for the key type is not valid.";
}
};
//! A name is required to find a unique georeferenced metadata layer.
struct BAG_API NameRequired final : virtual std::exception
{
const char* what() const noexcept override
{
return "A name is required to find a unique georeferenced metadata layer.";
}
};
// Dataset related.
//! Layer not found.
struct BAG_API DatasetNotFound final : virtual std::exception
{
const char* what() const noexcept override
{
return "There is no dataset to work with.";
}
};
//! Invalid layer id.
struct BAG_API InvalidLayerId final : virtual std::exception
{
const char* what() const noexcept override
{
return "Invalid layer id specified.";
}
};
// Group related.
//! Attempt to use an unknown layer type.
struct BAG_API UnsupportedGroupType final : virtual std::exception
{
const char* what() const noexcept override
{
return "An unsupported group type was specified.";
}
};
// Layer related.
//! Invalid buffer provided for the write.
struct BAG_API InvalidBuffer final : virtual std::exception
{
const char* what() const noexcept override
{
return "The specified buffer is NULL.";
}
};
//! Invalid dimensions specified for the read.
struct BAG_API InvalidReadSize final : virtual std::exception
{
const char* what() const noexcept override
{
return "The dimensions specified for reading are not valid.";
}
};
//! Invalid dimensions specified for the write.
struct BAG_API InvalidWriteSize final : virtual std::exception
{
const char* what() const noexcept override
{
return "The dimensions specified for writing are not valid.";
}
};
//! Layer already exists.
struct BAG_API LayerExists final : virtual std::exception
{
const char* what() const noexcept override
{
return "The specified layer already exists.";
}
};
//! Layer not found.
struct BAG_API LayerNotFound final : virtual std::exception
{
const char* what() const noexcept override
{
return "The specified layer was not found.";
}
};
//! Attempted to modify a read only Dataset.
struct BAG_API ReadOnlyError final : virtual std::exception
{
const char* what() const noexcept override
{
return "Attempted to modify a read only Dataset.";
}
};
//! Attempt to use get the element size of an unsupported layer type.
struct BAG_API UnsupportedElementSize final : virtual std::exception
{
const char* what() const noexcept override
{
return "Element size not supported for this type of layer.";
}
};
//! Attempt to use an unknown layer type.
struct BAG_API UnsupportedLayerType final : virtual std::exception
{
const char* what() const noexcept override
{
return "An unsupported layer type was specified.";
}
};
//! Attempt to use an incorrect layer type.
struct BAG_API UnsupportedSimpleLayerType final : virtual std::exception
{
const char* what() const noexcept override
{
return "Attempted to specify an unsupported combination of group and "
"layer type when making an interleaved layer.";
}
};
//! Attempt to make an unsupported interleaved layer.
struct BAG_API UnsupportedInterleavedLayer final : virtual std::exception
{
const char* what() const noexcept override
{
return "Attempted to specify an unsupported combination of group and "
"layer type when making an interleaved layer.";
}
};
// LayerDescriptor related.
//! The layer descriptor is not valid.
struct BAG_API InvalidLayerDescriptor final : virtual std::exception
{
const char* what() const noexcept override
{
return "The specified layer descriptor is not valid.";
}
};
// LayerItems related.
//! The type cannot be cast to the specified type.
struct BAG_API InvalidCast final : virtual std::exception
{
const char* what() const noexcept override
{
return "The LayerItems cannot be cast to the specified type.";
}
};
//! Legacy CRS related.
//! Ran into a problem (internal).
struct CoordSysError : virtual std::exception
{
const char* what() const noexcept override
{
return "Conversion Error";
};
};
//! Can not convert the datum.
struct InvalidDatumError final : virtual CoordSysError {};
//! Can not convert the ellipsoid.
struct InvalidEllipsoidError final : virtual CoordSysError {};
// Metadata related.
//! Attempt to make an unsupported interleaved layer.
struct BAG_API MetadataNotFound final : virtual std::exception
{
const char* what() const noexcept override
{
return "The mandatory Metadata dataset was not found.";
}
};
//! An unknown metadata profile was specified when a known profile was expected.
struct BAG_API UknownMetadataProfile final : virtual std::exception
{
UknownMetadataProfile(std::string profile)
{
m_message = "Metadata profile '" + profile +
"' is unknown, but a known profile was expected.";
}
const char* what() const noexcept override
{
return m_message.c_str();
}
std::string m_message;
};
//! An unrecognized metadata profile was specified.
struct BAG_API UnrecognizedMetadataProfile final : virtual std::exception
{
UnrecognizedMetadataProfile(std::string profile)
{
m_message = "Metadata profile '" + profile +
"' is not recognized.";
}
const char* what() const noexcept override
{
return m_message.c_str();
}
std::string m_message;
};
//! An error occurred loading metadata.
struct BAG_API ErrorLoadingMetadata final : virtual std::exception
{
ErrorLoadingMetadata(BagError bagError) : m_error(bagError)
{
m_message = "While importing metadata as XML, an error value " +
std::to_string(m_error) + " was returned.";
}
const char* what() const noexcept override
{
return m_message.c_str();
}
// TODO: Shouldn't this be non-zero?
BagError m_error = BAG_SUCCESS;
std::string m_message;
};
// SimpleLayer related.
//! Cannot convert DataType to an HDF5 DataType.
struct BAG_API UnsupportedDataType final : virtual std::exception
{
const char* what() const noexcept override
{
return "The specified DataType cannot be converted to an HDF5 DataType.";
}
};
// SurfaceCorrections related.
//! Too many corrections specified.
struct BAG_API TooManyCorrections final : virtual std::exception
{
const char* what() const noexcept override
{
return "Too many corrections specified. The limit is 10.";
}
};
//! Attempt to use an unknown surface type.
struct BAG_API UnknownSurfaceType final : virtual std::exception
{
const char* what() const noexcept override
{
return "Unknown surface type specified.";
}
};
//! Unknown reason why number of corrections could not be read from the BAG.
struct BAG_API CannotReadNumCorrections final : virtual std::exception
{
const char* what() const noexcept override
{
return "Cannot read the number of corrections from the surface "
"corrections dataset.";
}
};
//! Invalid corrector specified (1-10).
struct BAG_API InvalidCorrector final : virtual std::exception
{
const char* what() const noexcept override
{
return "Invalid corrector specified. The range is 1-10, but a Surface "
"Corrections layer may contain less.";
}
};
//! The surface type is not supported for this operation.
struct BAG_API UnsupportedSurfaceType final : virtual std::exception
{
const char* what() const noexcept override
{
return "The type of Surface Correction layer (gridded or sparse) is not"
" support for this operation.";
}
};
// Value Table related.
//! The specified field does not exist.
struct BAG_API FieldNotFound final : virtual std::exception
{
const char* what() const noexcept override
{
return "The specified field does not exist.";
}
};
//! Attempt to use an invalid value.
struct BAG_API InvalidValue final : virtual std::exception
{
const char* what() const noexcept override
{
return "Invalid value encountered. Either an unknown type is present "
"or it does not match the definition";
}
};
//! The dimensions of the values in the GeorefMetadataLayer are invalid.
struct BAG_API InvalidValueSize final : virtual std::exception
{
const char* what() const noexcept override
{
return "Invalid dimensions of the values in the spatial data has been "
"encountered.";
}
};
//! Layer requires chunking set because it is dynamically sized.
struct BAG_API LayerRequiresChunkingSet final : virtual std::exception
{
const char* what() const noexcept override
{
return "This layer requires a chunk size because it is dynamically "
"sized.";
}
};
//! The dataset must use variable resolution to read or write variable resolution metadata using the GeorefMetadataLayer.
struct BAG_API DatasetRequiresVariableResolution final : virtual std::exception
{
const char* what() const noexcept override
{
return "The dataset must use variable resolution to read or write "
"variable resolution metadata using the GeorefMetadataLayer.";
}
};
//! Attempt to write a value to an invalid key.
struct BAG_API InvalidValueKey final : virtual std::exception
{
const char* what() const noexcept override
{
return "Invalid key specified while writing a spatial metadata value.";
}
};
//! Attempt to use an invalid key.
struct BAG_API ValueNotFound final : virtual std::exception
{
const char* what() const noexcept override
{
return "Invalid key specified. The key must be greater "
"than 0, and less than the number of existing values.";
}
};
// VRRefinement related.
//! VR Refinements are the wrong dimensions.
struct BAG_API InvalidVRRefinementDimensions final : virtual std::exception
{
const char* what() const noexcept override
{
return "The variable resolution refinement layer is not 1 dimensional.";
}
};
#ifdef _MSC_VER
#pragma warning(pop)
#endif
} // namespace BAG
#endif // BAG_EXCEPTIONS_H