include/opencascade/Interface_CopyMap.hxx

0001 // Created on: 1993-03-16
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1993-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 _Interface_CopyMap_HeaderFile
0018 #define _Interface_CopyMap_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 #include <NCollection_Array1.hxx>
0025 #include <Interface_CopyControl.hxx>
0026 class Interface_InterfaceModel;
0027 class Standard_Transient;
0028
0029 //! Manages a Map for the need of single Transfers, such as Copies
0030 //! In such transfer, Starting Entities are read from a unique
0031 //! Starting Model, and each transferred Entity is bound to one
0032 //! and only one Result, which cannot be changed later.
0033 class Interface_CopyMap : public Interface_CopyControl
0034 {
0035
0036 public:
0037   //! Creates a CopyMap adapted to work from a Model
0038   Standard_EXPORT Interface_CopyMap(const occ::handle<Interface_InterfaceModel>& amodel);
0039
0040   //! Clears Transfer List. Gets Ready to begin another Transfer
0041   Standard_EXPORT void Clear() override;
0042
0043   //! Returns the InterfaceModel used at Creation time
0044   Standard_EXPORT occ::handle<Interface_InterfaceModel> Model() const;
0045
0046   //! Binds a Starting Entity identified by its Number <num> in the
0047   //! Starting Model, to a Result of Transfer <res>
0048   Standard_EXPORT void Bind(const occ::handle<Standard_Transient>& ent,
0049                             const occ::handle<Standard_Transient>& res) override;
0050
0051   //! Search for the result of a Starting Object (i.e. an Entity,
0052   //! identified by its Number <num> in the Starting Model)
0053   //! Returns True  if a  Result is Bound (and fills <res>)
0054   //! Returns False if no result is Bound (and nullifies <res>)
0055   Standard_EXPORT bool Search(const occ::handle<Standard_Transient>& ent,
0056                               occ::handle<Standard_Transient>&       res) const override;
0057
0058   DEFINE_STANDARD_RTTIEXT(Interface_CopyMap, Interface_CopyControl)
0059
0060 private:
0061   occ::handle<Interface_InterfaceModel>               themod;
0062   NCollection_Array1<occ::handle<Standard_Transient>> theres;
0063 };
0064
0065 #endif // _Interface_CopyMap_HeaderFile