VTK: Common/Misc/vtkErrorCode.h Source File

| VTK 9.3.1

vtkErrorCode.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
14 #ifndef vtkErrorCode_h
15 #define vtkErrorCode_h
16 #include "vtkCommonMiscModule.h" // For export macro
17 #include "vtkSystemIncludes.h"
18
19 // The superclass that all commands should be subclasses of
20 VTK_ABI_NAMESPACE_BEGIN
21 class VTKCOMMONMISC_EXPORT vtkErrorCode
22 {
23 public:
24 static const char* GetStringFromErrorCode(unsigned long error);
25 static unsigned long GetErrorCodeFromString(const char* error);
26 static unsigned long GetLastSystemError();
27
28 // all the currently defined error codes
29 // developers can use -- vtkErrorCode::UserError + int to
30 // specify their own errors.
31 // if this list is adjusted, be sure to adjust vtkErrorCodeErrorStrings
32 // in vtkErrorCode.cxx to match.
33 enum ErrorIds
34 {
35 NoError = 0,
36 FirstVTKErrorCode = 20000,
37 FileNotFoundError,
38 CannotOpenFileError,
39 UnrecognizedFileTypeError,
40 PrematureEndOfFileError,
41 FileFormatError,
42 NoFileNameError,
43 OutOfDiskSpaceError,
44 UnknownError,
45 UserError = 40000
46 };
47 };
48
49 VTK_ABI_NAMESPACE_END
50 #endif /* vtkErrorCode_h */
51
52 // VTK-HeaderTest-Exclude: vtkErrorCode.h
vtkErrorCode
superclass for error codes
Definition: vtkErrorCode.h:22
vtkErrorCode::GetLastSystemError
static unsigned long GetLastSystemError()
vtkErrorCode::GetErrorCodeFromString
static unsigned long GetErrorCodeFromString(const char *error)
vtkErrorCode::ErrorIds
ErrorIds
Definition: vtkErrorCode.h:34
vtkErrorCode::OutOfDiskSpaceError
@ OutOfDiskSpaceError
Definition: vtkErrorCode.h:43
vtkErrorCode::UnknownError
@ UnknownError
Definition: vtkErrorCode.h:44
vtkErrorCode::CannotOpenFileError
@ CannotOpenFileError
Definition: vtkErrorCode.h:38
vtkErrorCode::FileFormatError
@ FileFormatError
Definition: vtkErrorCode.h:41
vtkErrorCode::UnrecognizedFileTypeError
@ UnrecognizedFileTypeError
Definition: vtkErrorCode.h:39
vtkErrorCode::PrematureEndOfFileError
@ PrematureEndOfFileError
Definition: vtkErrorCode.h:40
vtkErrorCode::NoFileNameError
@ NoFileNameError
Definition: vtkErrorCode.h:42
vtkErrorCode::FileNotFoundError
@ FileNotFoundError
Definition: vtkErrorCode.h:37
vtkErrorCode::GetStringFromErrorCode
static const char * GetStringFromErrorCode(unsigned long error)
vtkSystemIncludes.h