include/opencascade/TDF_CopyLabel.hxx

0001 // Created on: 1999-06-24
0002 // Created by: Sergey ZARITCHNY
0003 // Copyright (c) 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 _TDF_CopyLabel_HeaderFile
0018 #define _TDF_CopyLabel_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TDF_Label.hxx>
0025 #include <TDF_IDFilter.hxx>
0026 #include <TDF_Attribute.hxx>
0027 #include <NCollection_Map.hxx>
0028 class TDF_RelocationTable;
0029 class TDF_DataSet;
0030
0031 //! This class gives copy of source label hierarchy
0032 class TDF_CopyLabel
0033 {
0034 public:
0035   DEFINE_STANDARD_ALLOC
0036
0037   //! Empty constructor
0038   Standard_EXPORT TDF_CopyLabel();
0039
0040   //! CopyTool
0041   Standard_EXPORT TDF_CopyLabel(const TDF_Label& aSource, const TDF_Label& aTarget);
0042
0043   //! Loads src and tgt labels
0044   Standard_EXPORT void Load(const TDF_Label& aSource, const TDF_Label& aTarget);
0045
0046   //! Sets filter
0047   Standard_EXPORT void UseFilter(const TDF_IDFilter& aFilter);
0048
0049   //! Check external references and if exist fills the aExternals Map
0050   Standard_EXPORT static bool ExternalReferences(
0051     const TDF_Label&                             Lab,
0052     NCollection_Map<occ::handle<TDF_Attribute>>& aExternals,
0053     const TDF_IDFilter&                          aFilter);
0054
0055   //! Check external references and if exist fills the aExternals Map
0056   Standard_EXPORT static void ExternalReferences(
0057     const TDF_Label&                             aRefLab,
0058     const TDF_Label&                             Lab,
0059     NCollection_Map<occ::handle<TDF_Attribute>>& aExternals,
0060     const TDF_IDFilter&                          aFilter,
0061     occ::handle<TDF_DataSet>&                    aDataSet);
0062
0063   //! performs algorithm of selfcontained copy
0064   Standard_EXPORT void Perform();
0065
0066   bool IsDone() const;
0067
0068   //! returns relocation table
0069   Standard_EXPORT const occ::handle<TDF_RelocationTable>& RelocationTable() const;
0070
0071 private:
0072   occ::handle<TDF_RelocationTable>            myRT;
0073   TDF_Label                                   mySL;
0074   TDF_Label                                   myTL;
0075   TDF_IDFilter                                myFilter;
0076   NCollection_Map<occ::handle<TDF_Attribute>> myMapOfExt;
0077   bool                                        myIsDone;
0078 };
0079
0080 #include <TDF_CopyLabel.lxx>
0081
0082 #endif // _TDF_CopyLabel_HeaderFile