summaryrefslogtreecommitdiff
path: root/inc/OSD_Error.hxx
blob: a3a4d0166a902242a2b956a3dc4b0f50745e5345 (plain)
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
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _OSD_Error_HeaderFile
#define _OSD_Error_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _OSD_WhoAmI_HeaderFile
#include <OSD_WhoAmI.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class OSD_OSDError;
class TCollection_AsciiString;


//! Management of OSD errors <br>
class OSD_Error  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Initializes Error to be without any Error. <br>
//!          This is only used by OSD, not by programmer. <br>
  Standard_EXPORT   OSD_Error();
  //! Raises OSD_Error with accurate error message. <br>
  Standard_EXPORT     void Perror() ;
  //! Instantiates error <br>
//!          This is only used by OSD methods to instantiates an error code. <br>
//!          No description is done for the programmer. <br>
  Standard_EXPORT     void SetValue(const Standard_Integer Errcode,const Standard_Integer From,const TCollection_AsciiString& Message) ;
  //! Returns an accurate error code. <br>
//!          To test these values, you must include "OSD_ErrorList.hxx" <br>
  Standard_EXPORT     Standard_Integer Error() const;
  //! Returns TRUE if an error occurs <br>
//!          This is a way to test if a system call succeeded or not. <br>
  Standard_EXPORT     Standard_Boolean Failed() const;
  //! Resets error counter to zero <br>
//!          This allows the user to ignore an error (WARNING). <br>
  Standard_EXPORT     void Reset() ;





protected:





private:



TCollection_AsciiString myMessage;
Standard_Integer myErrno;
OSD_WhoAmI myCode;
Standard_Integer extCode;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif