| 42cf5bc1 |
1 | // Created on: 1998-07-21 |
| 2 | // Created by: data exchange team |
| 3 | // Copyright (c) 1998-1999 Matra Datavision |
| 4 | // Copyright (c) 1999-2014 OPEN CASCADE SAS |
| 5 | // |
| 6 | // This file is part of Open CASCADE Technology software library. |
| 7 | // |
| 8 | // This library is free software; you can redistribute it and/or modify it under |
| 9 | // the terms of the GNU Lesser General Public License version 2.1 as published |
| 10 | // by the Free Software Foundation, with special exception defined in the file |
| 11 | // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
| 12 | // distribution for complete text of the license and disclaimer of any warranty. |
| 13 | // |
| 14 | // Alternatively, this file may be used under the terms of Open CASCADE |
| 15 | // commercial license or contractual agreement. |
| 16 | |
| 17 | #ifndef _ShapeExtend_Status_HeaderFile |
| 18 | #define _ShapeExtend_Status_HeaderFile |
| 19 | |
| 20 | //! This enumeration is used in |
| 21 | //! ShapeHealing toolkit for representing flags in the |
| 22 | //! return statuses of class methods. |
| 23 | //! The status is a field of the class which is set by one or |
| 24 | //! several methods of that class. |
| 25 | //! It is used for reporting about errors and other situations |
| 26 | //! encountered during execution of the method. |
| 27 | //! There are defined 8 values for DONE and 8 for FAIL flags: |
| 28 | //! ShapeExtend_DONE1 ... ShapeExtend_DONE8, |
| 29 | //! ShapeExtend_FAIL1 ... ShapeExtend_FAIL8 |
| 30 | //! and also enumerations for representing combinations of flags: |
| 31 | //! ShapeExtend_OK - no flags at all, |
| 32 | //! ShapeExtend_DONE - any of flags DONEi, |
| 33 | //! ShapeExtend_FAIL - any of flags FAILi. |
| 34 | //! The class that uses statuses provides a method(s) which |
| 35 | //! answers whether the flag corresponding to a given |
| 36 | //! enumerative value is (are) set: |
| 37 | //! Standard_Boolean Status(const ShapeExtend_Status test); |
| 38 | //! Note that status can have several flags set simultaneously. |
| 39 | //! Status(ShapeExtend_OK) gives True when no flags are set. |
| 40 | //! Nothing done, everything OK |
| 41 | //! Something was done, case 1 |
| 42 | //! Something was done, case 2 |
| 43 | //! Something was done, case 3 |
| 44 | //! Something was done, case 4 |
| 45 | //! Something was done, case 5 |
| 46 | //! Something was done, case 6 |
| 47 | //! Something was done, case 7 |
| 48 | //! Something was done, case 8 |
| 49 | //! Something was done (any of DONE#) |
| 50 | //! The method failed, case 1 |
| 51 | //! The method failed, case 2 |
| 52 | //! The method failed, case 3 |
| 53 | //! The method failed, case 4 |
| 54 | //! The method failed, case 5 |
| 55 | //! The method failed, case 6 |
| 56 | //! The method failed, case 7 |
| 57 | //! The method failed, case 8 |
| 58 | //! The mathod failed (any of FAIL# occured) |
| 59 | enum ShapeExtend_Status |
| 60 | { |
| 61 | ShapeExtend_OK, |
| 62 | ShapeExtend_DONE1, |
| 63 | ShapeExtend_DONE2, |
| 64 | ShapeExtend_DONE3, |
| 65 | ShapeExtend_DONE4, |
| 66 | ShapeExtend_DONE5, |
| 67 | ShapeExtend_DONE6, |
| 68 | ShapeExtend_DONE7, |
| 69 | ShapeExtend_DONE8, |
| 70 | ShapeExtend_DONE, |
| 71 | ShapeExtend_FAIL1, |
| 72 | ShapeExtend_FAIL2, |
| 73 | ShapeExtend_FAIL3, |
| 74 | ShapeExtend_FAIL4, |
| 75 | ShapeExtend_FAIL5, |
| 76 | ShapeExtend_FAIL6, |
| 77 | ShapeExtend_FAIL7, |
| 78 | ShapeExtend_FAIL8, |
| 79 | ShapeExtend_FAIL |
| 80 | }; |
| 81 | |
| 82 | #endif // _ShapeExtend_Status_HeaderFile |
projects / occt.git / blame