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
0032 //! A TransferInput is a Tool which fills an InterfaceModel with
0033 //! the result of the Transfer of CasCade Objects, once determined
0034 //! The Result comes from a TransferProcess, either from
0035 //! Transient (the Complete Result is considered, it must contain
0036 //! only Transient Objects)
0037 class Transfer_TransferInput
0038 {
0039 public:
0040
0041   DEFINE_STANDARD_ALLOC
0042
0043
0044   //! Creates a TransferInput ready to use
0045   Standard_EXPORT Transfer_TransferInput();
0046
0047   //! Takes the transient items stored in a TransferIterator
0048   Standard_EXPORT Interface_EntityIterator Entities (Transfer_TransferIterator& list) const;
0049
0050   //! Fills an InterfaceModel with the Complete Result of a Transfer
0051   //! stored in a TransientProcess (Starting Objects are Transient)
0052   //! The complete result is exactly added to the model
0053   Standard_EXPORT void FillModel (const Handle(Transfer_TransientProcess)& proc, const Handle(Interface_InterfaceModel)& amodel) const;
0054
0055   //! Fills an InterfaceModel with results of the Transfer recorded
0056   //! in a TransientProcess (Starting Objects are Transient) :
0057   //! Root Result if <roots> is True (Default), Complete Result else
0058   //! The entities added to the model are determined from the result
0059   //! by by adding the referenced entities
0060   Standard_EXPORT void FillModel (const Handle(Transfer_TransientProcess)& proc, const Handle(Interface_InterfaceModel)& amodel, const Handle(Interface_Protocol)& proto, const Standard_Boolean roots = Standard_True) const;
0061
0062   //! Fills an InterfaceModel with the Complete Result of a Transfer
0063   //! stored in a TransientProcess (Starting Objects are Transient)
0064   //! The complete result is exactly added to the model
0065   Standard_EXPORT void FillModel (const Handle(Transfer_FinderProcess)& proc, const Handle(Interface_InterfaceModel)& amodel) const;
0066
0067   //! Fills an InterfaceModel with results of the Transfer recorded
0068   //! in a TransientProcess (Starting Objects are Transient) :
0069   //! Root Result if <roots> is True (Default), Complete Result else
0070   //! The entities added to the model are determined from the result
0071   //! by by adding the referenced entities
0072   Standard_EXPORT void FillModel (const Handle(Transfer_FinderProcess)& proc, const Handle(Interface_InterfaceModel)& amodel, const Handle(Interface_Protocol)& proto, const Standard_Boolean roots = Standard_True) const;
0073
0074
0075
0076
0077 protected:
0078
0079
0080
0081
0082
0083 private:
0084
0085
0086
0087
0088
0089 };
0090
0091
0092
0093
0094
0095
0096
0097 #endif // _Transfer_TransferInput_HeaderFile