include/opencascade/BRepBuilderAPI_Command.hxx

0001 // Created on: 1993-07-21
0002 // Created by: Remi LEQUETTE
0003 // Copyright (c) 1993-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 _BRepBuilderAPI_Command_HeaderFile
0018 #define _BRepBuilderAPI_Command_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Boolean.hxx>
0025
0026
0027 //! Root class for all commands in BRepBuilderAPI.
0028 //!
0029 //! Provides :
0030 //!
0031 //! * Managements of the notDone flag.
0032 //!
0033 //! * Catching of exceptions (not implemented).
0034 //!
0035 //! * Logging (not implemented).
0036 class BRepBuilderAPI_Command
0037 {
0038 public:
0039
0040   DEFINE_STANDARD_ALLOC
0041
0042   Standard_EXPORT virtual ~BRepBuilderAPI_Command();
0043
0044   Standard_EXPORT virtual Standard_Boolean IsDone() const;
0045
0046   //! Raises NotDone if done is false.
0047   Standard_EXPORT void Check() const;
0048
0049
0050
0051
0052 protected:
0053
0054
0055   //! Set done to False.
0056   Standard_EXPORT BRepBuilderAPI_Command();
0057
0058   //! Set done to true.
0059   Standard_EXPORT void Done();
0060
0061   //! Set done to false.
0062   Standard_EXPORT void NotDone();
0063
0064
0065
0066
0067 private:
0068
0069
0070
0071   Standard_Boolean myDone;
0072
0073
0074 };
0075
0076
0077
0078
0079
0080
0081
0082 #endif // _BRepBuilderAPI_Command_HeaderFile