include/opencascade/Interface_CopyControl.hxx

0001 // Created on: 1993-04-08
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_CopyControl_HeaderFile
0018 #define _Interface_CopyControl_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024
0025 //! This deferred class describes the services required by
0026 //! CopyTool to work. They are very simple and correspond
0027 //! basically to the management of an indexed map.
0028 //! But they can be provided by various classes which can
0029 //! control a Transfer. Each Starting Entity have at most
0030 //! one Result (Mapping one-one)
0031 class Interface_CopyControl : public Standard_Transient
0032 {
0033
0034 public:
0035   //! Clears List of Copy Results. Gets Ready to begin another Copy
0036   //! Process.
0037   Standard_EXPORT virtual void Clear() = 0;
0038
0039   //! Bind a Result to a Starting Entity identified by its Number
0040   Standard_EXPORT virtual void Bind(const occ::handle<Standard_Transient>& ent,
0041                                     const occ::handle<Standard_Transient>& res) = 0;
0042
0043   //! Searches for the Result bound to a Startingf Entity identified
0044   //! by its Number.
0045   //! If Found, returns True and fills <res>
0046   //! Else, returns False and nullifies <res>
0047   Standard_EXPORT virtual bool Search(const occ::handle<Standard_Transient>& ent,
0048                                       occ::handle<Standard_Transient>&       res) const = 0;
0049
0050   DEFINE_STANDARD_RTTIEXT(Interface_CopyControl, Standard_Transient)
0051 };
0052
0053 #endif // _Interface_CopyControl_HeaderFile