src/TDF/TDF_ClosureMode.hxx

   1 // Created by: DAUTRY Philippe
   2 // Copyright (c) 1997-1999 Matra Datavision
   3 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _TDF_ClosureMode_HeaderFile
  17 #define _TDF_ClosureMode_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_DefineAlloc.hxx>
  21 #include <Standard_Handle.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 #include <Standard_Boolean.hxx>
  25
  26
  27 //! This class provides options closure management.
  28 class TDF_ClosureMode
  29 {
  30 public:
  31
  32   DEFINE_STANDARD_ALLOC
  33
  34
  35   //! Creates an objet with all modes set to <aMode>.
  36   Standard_EXPORT TDF_ClosureMode(const Standard_Boolean aMode = Standard_True);
  37
  38   //! Sets the mode "Descendants" to <aStatus>.
  39   //!
  40   //! "Descendants" mode means we add to the data set
  41   //! the children labels of each USER GIVEN label. We
  42   //! do not do that with the labels found applying
  43   //! UpToFirstLevel option.
  44     void Descendants (const Standard_Boolean aStatus);
  45
  46   //! Returns true if the mode "Descendants" is set.
  47     Standard_Boolean Descendants() const;
  48
  49   //! Sets the mode "References" to <aStatus>.
  50   //!
  51   //! "References" mode means we add to the data set
  52   //! the descendants of an attribute, by calling the
  53   //! attribute method Descendants().
  54     void References (const Standard_Boolean aStatus);
  55
  56   //! Returns true if the mode "References" is set.
  57     Standard_Boolean References() const;
  58
  59
  60
  61
  62 protected:
  63
  64
  65
  66
  67
  68 private:
  69
  70
  71
  72   Standard_Integer myFlags;
  73
  74
  75 };
  76
  77
  78 #include <TDF_ClosureMode.lxx>
  79
  80
  81
  82
  83
  84 #endif // _TDF_ClosureMode_HeaderFile