include/opencascade/Transfer_TransferInput.hxx

0001 // Created on: 1992-02-04
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1992-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 _Transfer_TransferInput_HeaderFile
0018 #define _Transfer_TransferInput_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 class Interface_EntityIterator;
0025 class Transfer_TransferIterator;
0026 class Transfer_TransientProcess;
0027 class Interface_InterfaceModel;
0028 class Interface_Protocol;
0029 class Transfer_FinderProcess;
0030
0031 //! A TransferInput is a Tool which fills an InterfaceModel with
0032 //! the result of the Transfer of CasCade Objects, once determined
0033 //! The Result comes from a TransferProcess, either from
0034 //! Transient (the Complete Result is considered, it must contain
0035 //! only Transient Objects)
0036 class Transfer_TransferInput
0037 {
0038 public:
0039   DEFINE_STANDARD_ALLOC
0040
0041   //! Creates a TransferInput ready to use
0042   Standard_EXPORT Transfer_TransferInput();
0043
0044   //! Takes the transient items stored in a TransferIterator
0045   Standard_EXPORT Interface_EntityIterator Entities(Transfer_TransferIterator& list) const;
0046
0047   //! Fills an InterfaceModel with the Complete Result of a Transfer
0048   //! stored in a TransientProcess (Starting Objects are Transient)
0049   //! The complete result is exactly added to the model
0050   Standard_EXPORT void FillModel(const occ::handle<Transfer_TransientProcess>& proc,
0051                                  const occ::handle<Interface_InterfaceModel>&  amodel) const;
0052
0053   //! Fills an InterfaceModel with results of the Transfer recorded
0054   //! in a TransientProcess (Starting Objects are Transient) :
0055   //! Root Result if <roots> is True (Default), Complete Result else
0056   //! The entities added to the model are determined from the result
0057   //! by by adding the referenced entities
0058   Standard_EXPORT void FillModel(const occ::handle<Transfer_TransientProcess>& proc,
0059                                  const occ::handle<Interface_InterfaceModel>&  amodel,
0060                                  const occ::handle<Interface_Protocol>&        proto,
0061                                  const bool                                    roots = true) const;
0062
0063   //! Fills an InterfaceModel with the Complete Result of a Transfer
0064   //! stored in a TransientProcess (Starting Objects are Transient)
0065   //! The complete result is exactly added to the model
0066   Standard_EXPORT void FillModel(const occ::handle<Transfer_FinderProcess>&   proc,
0067                                  const occ::handle<Interface_InterfaceModel>& amodel) const;
0068
0069   //! Fills an InterfaceModel with results of the Transfer recorded
0070   //! in a TransientProcess (Starting Objects are Transient) :
0071   //! Root Result if <roots> is True (Default), Complete Result else
0072   //! The entities added to the model are determined from the result
0073   //! by by adding the referenced entities
0074   Standard_EXPORT void FillModel(const occ::handle<Transfer_FinderProcess>&   proc,
0075                                  const occ::handle<Interface_InterfaceModel>& amodel,
0076                                  const occ::handle<Interface_Protocol>&       proto,
0077                                  const bool                                   roots = true) const;
0078 };
0079
0080 #endif // _Transfer_TransferInput_HeaderFile