include/opencascade/gce_Root.hxx

0001 // Created on: 1992-09-29
0002 // Created by: Remi GILET
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _gce_Root_HeaderFile
0018 #define _gce_Root_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <gce_ErrorType.hxx>
0025 #include <Standard_Boolean.hxx>
0026
0027 // resolve name collisions with X11 headers
0028 #ifdef Status
0029   #undef Status
0030 #endif
0031
0032 //! This class implements the common services for
0033 //! all classes of gce which report error.
0034 class gce_Root
0035 {
0036 public:
0037   DEFINE_STANDARD_ALLOC
0038
0039   //! Returns true if the construction is successful.
0040   Standard_Boolean IsDone() const;
0041
0042   //! Returns the status of the construction:
0043   //! -   gce_Done, if the construction is successful, or
0044   //! -   another value of the gce_ErrorType enumeration
0045   //! indicating why the construction failed.
0046   gce_ErrorType Status() const;
0047
0048 protected:
0049   gce_ErrorType TheError;
0050
0051 private:
0052 };
0053
0054 #include <gce_Root.lxx>
0055
0056 #endif // _gce_Root_HeaderFile