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 //! Root class for all commands in BRepBuilderAPI.
0027 //!
0028 //! Provides :
0029 //!
0030 //! * Managements of the notDone flag.
0031 //!
0032 //! * Catching of exceptions (not implemented).
0033 //!
0034 //! * Logging (not implemented).
0035 class BRepBuilderAPI_Command
0036 {
0037 public:
0038   DEFINE_STANDARD_ALLOC
0039
0040   Standard_EXPORT virtual ~BRepBuilderAPI_Command();
0041
0042   Standard_EXPORT virtual bool IsDone() const;
0043
0044   //! Raises NotDone if done is false.
0045   Standard_EXPORT void Check() const;
0046
0047 protected:
0048   //! Set done to False.
0049   Standard_EXPORT BRepBuilderAPI_Command();
0050
0051   //! Set done to true.
0052   Standard_EXPORT void Done();
0053
0054   //! Set done to false.
0055   Standard_EXPORT void NotDone();
0056
0057 private:
0058   bool myDone;
0059 };
0060
0061 #endif // _BRepBuilderAPI_Command_HeaderFile