src/BRepBuilderAPI/BRepBuilderAPI_Command.hxx

   1 // Created on: 1993-07-21
   2 // Created by: Remi LEQUETTE
   3 // Copyright (c) 1993-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 _BRepBuilderAPI_Command_HeaderFile
  18 #define _BRepBuilderAPI_Command_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Boolean.hxx>
  25 class StdFail_NotDone;
  26
  27
  28 //! Root class for all commands in BRepBuilderAPI.
  29 //!
  30 //! Provides :
  31 //!
  32 //! * Managements of the notDone flag.
  33 //!
  34 //! * Catching of exceptions (not implemented).
  35 //!
  36 //! * Logging (not implemented).
  37 class BRepBuilderAPI_Command
  38 {
  39 public:
  40
  41   DEFINE_STANDARD_ALLOC
  42
  43
  44   Standard_EXPORT virtual void Delete();
  45 Standard_EXPORT virtual ~BRepBuilderAPI_Command(){Delete() ; }
  46
  47   Standard_EXPORT virtual Standard_Boolean IsDone() const;
  48
  49   //! Raises NotDone if done is false.
  50   Standard_EXPORT void Check() const;
  51
  52
  53
  54
  55 protected:
  56
  57
  58   //! Set done to False.
  59   Standard_EXPORT BRepBuilderAPI_Command();
  60
  61   //! Set done to true.
  62   Standard_EXPORT void Done();
  63
  64   //! Set done to false.
  65   Standard_EXPORT void NotDone();
  66
  67
  68
  69
  70 private:
  71
  72
  73
  74   Standard_Boolean myDone;
  75
  76
  77 };
  78
  79
  80
  81
  82
  83
  84
  85 #endif // _BRepBuilderAPI_Command_HeaderFile