include/opencascade/ShapeExtend_Status.hxx

0001 // Created on: 1998-07-21
0002 // Created by: data exchange team
0003 // Copyright (c) 1998-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 _ShapeExtend_Status_HeaderFile
0018 #define _ShapeExtend_Status_HeaderFile
0019
0020 //! This enumeration is used in
0021 //! ShapeHealing toolkit for representing flags in the
0022 //! return statuses of class methods.
0023 //! The status is a field of the class which is set by one or
0024 //! several methods of that class.
0025 //! It is used for reporting about errors and other situations
0026 //! encountered during execution of the method.
0027 //! There are defined 8 values for DONE and 8 for FAIL flags:
0028 //! ShapeExtend_DONE1 ...      ShapeExtend_DONE8,
0029 //! ShapeExtend_FAIL1 ...      ShapeExtend_FAIL8
0030 //! and also enumerations for representing combinations of flags:
0031 //! ShapeExtend_OK - no flags at all,
0032 //! ShapeExtend_DONE - any of flags DONEi,
0033 //! ShapeExtend_FAIL - any of flags FAILi.
0034 //! The class that uses statuses provides a method(s) which
0035 //! answers whether the flag corresponding to a given
0036 //! enumerative value is (are) set:
0037 //! Standard_Boolean Status(const ShapeExtend_Status test);
0038 //! Note that status can have several flags set simultaneously.
0039 //! Status(ShapeExtend_OK) gives True when no flags are set.
0040 //! Nothing done, everything OK
0041 //! Something was done, case 1
0042 //! Something was done, case 2
0043 //! Something was done, case 3
0044 //! Something was done, case 4
0045 //! Something was done, case 5
0046 //! Something was done, case 6
0047 //! Something was done, case 7
0048 //! Something was done, case 8
0049 //! Something was done (any of DONE#)
0050 //! The method failed, case 1
0051 //! The method failed, case 2
0052 //! The method failed, case 3
0053 //! The method failed, case 4
0054 //! The method failed, case 5
0055 //! The method failed, case 6
0056 //! The method failed, case 7
0057 //! The method failed, case 8
0058 //! The method failed (any of FAIL# occurred)
0059 enum ShapeExtend_Status
0060 {
0061 ShapeExtend_OK,
0062 ShapeExtend_DONE1,
0063 ShapeExtend_DONE2,
0064 ShapeExtend_DONE3,
0065 ShapeExtend_DONE4,
0066 ShapeExtend_DONE5,
0067 ShapeExtend_DONE6,
0068 ShapeExtend_DONE7,
0069 ShapeExtend_DONE8,
0070 ShapeExtend_DONE,
0071 ShapeExtend_FAIL1,
0072 ShapeExtend_FAIL2,
0073 ShapeExtend_FAIL3,
0074 ShapeExtend_FAIL4,
0075 ShapeExtend_FAIL5,
0076 ShapeExtend_FAIL6,
0077 ShapeExtend_FAIL7,
0078 ShapeExtend_FAIL8,
0079 ShapeExtend_FAIL
0080 };
0081
0082 #endif // _ShapeExtend_Status_HeaderFile