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
0026 class Interface_CopyControl;
0027 DEFINE_STANDARD_HANDLE(Interface_CopyControl, Standard_Transient)
0028
0029 //! This deferred class describes the services required by
0030 //! CopyTool to work. They are very simple and correspond
0031 //! basically to the management of an indexed map.
0032 //! But they can be provided by various classes which can
0033 //! control a Transfer. Each Starting Entity have at most
0034 //! one Result (Mapping one-one)
0035 class Interface_CopyControl : public Standard_Transient
0036 {
0037
0038 public:
0039
0040
0041   //! Clears List of Copy Results. Gets Ready to begin another Copy
0042   //! Process.
0043   Standard_EXPORT virtual void Clear() = 0;
0044
0045   //! Bind a Result to a Starting Entity identified by its Number
0046   Standard_EXPORT virtual void Bind (const Handle(Standard_Transient)& ent, const Handle(Standard_Transient)& res) = 0;
0047
0048   //! Searches for the Result bound to a Startingf Entity identified
0049   //! by its Number.
0050   //! If Found, returns True and fills <res>
0051   //! Else, returns False and nullifies <res>
0052   Standard_EXPORT virtual Standard_Boolean Search (const Handle(Standard_Transient)& ent, Handle(Standard_Transient)& res) const = 0;
0053
0054
0055
0056
0057   DEFINE_STANDARD_RTTIEXT(Interface_CopyControl,Standard_Transient)
0058
0059 protected:
0060
0061
0062
0063
0064 private:
0065
0066
0067
0068
0069 };
0070
0071
0072
0073
0074
0075
0076
0077 #endif // _Interface_CopyControl_HeaderFile