include/opencascade/TDF_ClosureTool.hxx

0001 // Created by: DAUTRY Philippe
0002 // Copyright (c) 1998-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_ClosureTool_HeaderFile
0017 #define _TDF_ClosureTool_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_DefineAlloc.hxx>
0021 #include <Standard_Handle.hxx>
0022
0023 #include <TDF_Label.hxx>
0024 #include <NCollection_Map.hxx>
0025 #include <TDF_Attribute.hxx>
0026 class TDF_DataSet;
0027 class TDF_IDFilter;
0028 class TDF_ClosureMode;
0029 class TDF_Label;
0030
0031 //! This class provides services to build the closure
0032 //! of an information set.
0033 //! This class gives services around the transitive
0034 //! enclosure of a set of information, starting from a
0035 //! list of label.
0036 //! You can set closure options by using IDFilter
0037 //! (to select or exclude specific attribute IDs) and
0038 //! CopyOption objects and by giving to Closure
0039 //! method.
0040 class TDF_ClosureTool
0041 {
0042 public:
0043   DEFINE_STANDARD_ALLOC
0044
0045   //! Builds the transitive closure of label and
0046   //! attribute sets into <aDataSet>.
0047   Standard_EXPORT static void Closure(const occ::handle<TDF_DataSet>& aDataSet);
0048
0049   //! Builds the transitive closure of label and
0050   //! attribute sets into <aDataSet>. Uses <aFilter> to
0051   //! determine if an attribute has to be taken in
0052   //! account or not. Uses <aMode> for various way of
0053   //! closing.
0054   Standard_EXPORT static void Closure(const occ::handle<TDF_DataSet>& aDataSet,
0055                                       const TDF_IDFilter&             aFilter,
0056                                       const TDF_ClosureMode&          aMode);
0057
0058   //! Builds the transitive closure of <aLabel>.
0059   Standard_EXPORT static void Closure(const TDF_Label&                             aLabel,
0060                                       NCollection_Map<TDF_Label>&                  aLabMap,
0061                                       NCollection_Map<occ::handle<TDF_Attribute>>& anAttMap,
0062                                       const TDF_IDFilter&                          aFilter,
0063                                       const TDF_ClosureMode&                       aMode);
0064
0065 private:
0066   //! Adds label attributes and dependences.
0067   Standard_EXPORT static void LabelAttributes(const TDF_Label&                             aLabel,
0068                                               NCollection_Map<TDF_Label>&                  aLabMap,
0069                                               NCollection_Map<occ::handle<TDF_Attribute>>& anAttMap,
0070                                               const TDF_IDFilter&                          aFilter,
0071                                               const TDF_ClosureMode&                       aMode);
0072 };
0073
0074 #endif // _TDF_ClosureTool_HeaderFile