include/opencascade/TDF_ClosureMode.hxx

0001 // Created by: DAUTRY Philippe
0002 // Copyright (c) 1997-1999 Matra Datavision
0003 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _TDF_ClosureMode_HeaderFile
0017 #define _TDF_ClosureMode_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_DefineAlloc.hxx>
0021 #include <Standard_Handle.hxx>
0022
0023 #include <Standard_Boolean.hxx>
0024
0025 //! This class provides options closure management.
0026 class TDF_ClosureMode
0027 {
0028 public:
0029   DEFINE_STANDARD_ALLOC
0030
0031   //! Creates an object with all modes set to <aMode>.
0032   Standard_EXPORT TDF_ClosureMode(const Standard_Boolean aMode = Standard_True);
0033
0034   //! Sets the mode "Descendants" to <aStatus>.
0035   //!
0036   //! "Descendants" mode means we add to the data set
0037   //! the children labels of each USER GIVEN label. We
0038   //! do not do that with the labels found applying
0039   //! UpToFirstLevel option.
0040   void Descendants(const Standard_Boolean aStatus);
0041
0042   //! Returns true if the mode "Descendants" is set.
0043   Standard_Boolean Descendants() const;
0044
0045   //! Sets the mode "References" to <aStatus>.
0046   //!
0047   //! "References" mode means we add to the data set
0048   //! the descendants of an attribute, by calling the
0049   //! attribute method Descendants().
0050   void References(const Standard_Boolean aStatus);
0051
0052   //! Returns true if the mode "References" is set.
0053   Standard_Boolean References() const;
0054
0055 protected:
0056 private:
0057   Standard_Integer myFlags;
0058 };
0059
0060 #include <TDF_ClosureMode.lxx>
0061
0062 #endif // _TDF_ClosureMode_HeaderFile