include/opencascade/gce_ErrorType.hxx

0001 // Created on: 1992-04-30
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_ErrorType_HeaderFile
0018 #define _gce_ErrorType_HeaderFile
0019
0020 //! Defines status codes returned by `gce` construction algorithms.
0021 //! - `gce_Done`: construction completed successfully.
0022 //! - `gce_ConfusedPoints`: two points are coincident.
0023 //! - `gce_NegativeRadius`: a radius value is negative.
0024 //! - `gce_ColinearPoints`: three points are collinear.
0025 //! - `gce_IntersectionError`: intersection cannot be computed.
0026 //! - `gce_NullAxis`: axis is undefined.
0027 //! - `gce_NullAngle`: angle value is invalid (usually null).
0028 //! - `gce_NullRadius`: radius is null.
0029 //! - `gce_InvertAxis`: axis value is invalid.
0030 //! - `gce_BadAngle`: angle value is invalid.
0031 //! - `gce_InvertRadius`: radius values are inconsistent.
0032 //! - `gce_NullFocusLength`: focal distance is null.
0033 //! - `gce_NullVector`: vector is null.
0034 //! - `gce_BadEquation`: coefficients of an equation are invalid.
0035 enum gce_ErrorType
0036 {
0037   gce_Done,
0038   gce_ConfusedPoints,
0039   gce_NegativeRadius,
0040   gce_ColinearPoints,
0041   gce_IntersectionError,
0042   gce_NullAxis,
0043   gce_NullAngle,
0044   gce_NullRadius,
0045   gce_InvertAxis,
0046   gce_BadAngle,
0047   gce_InvertRadius,
0048   gce_NullFocusLength,
0049   gce_NullVector,
0050   gce_BadEquation
0051 };
0052
0053 #endif // _gce_ErrorType_HeaderFile