42cf5bc1 |
1 | // Created on: 1992-02-04 |
2 | // Created by: Christian CAILLET |
3 | // Copyright (c) 1992-1999 Matra Datavision |
4 | // Copyright (c) 1999-2014 OPEN CASCADE SAS |
5 | // |
6 | // This file is part of Open CASCADE Technology software library. |
7 | // |
8 | // This library is free software; you can redistribute it and/or modify it under |
9 | // the terms of the GNU Lesser General Public License version 2.1 as published |
10 | // by the Free Software Foundation, with special exception defined in the file |
11 | // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
12 | // distribution for complete text of the license and disclaimer of any warranty. |
13 | // |
14 | // Alternatively, this file may be used under the terms of Open CASCADE |
15 | // commercial license or contractual agreement. |
16 | |
17 | #ifndef _Transfer_TransferInput_HeaderFile |
18 | #define _Transfer_TransferInput_HeaderFile |
19 | |
20 | #include <Standard.hxx> |
21 | #include <Standard_DefineAlloc.hxx> |
22 | #include <Standard_Handle.hxx> |
23 | |
24 | #include <Standard_Boolean.hxx> |
25 | class Transfer_TransferFailure; |
26 | class Interface_EntityIterator; |
27 | class Transfer_TransferIterator; |
28 | class Transfer_TransientProcess; |
29 | class Interface_InterfaceModel; |
30 | class Interface_Protocol; |
31 | class Transfer_FinderProcess; |
32 | |
33 | |
34 | //! A TransferInput is a Tool which fills an InterfaceModel with |
35 | //! the result of the Transfer of CasCade Objects, once determined |
36 | //! The Result comes from a TransferProcess, either from |
37 | //! Transient (the Complete Result is considered, it must contain |
38 | //! only Transient Objects) |
39 | class Transfer_TransferInput |
40 | { |
41 | public: |
42 | |
43 | DEFINE_STANDARD_ALLOC |
44 | |
45 | |
46 | //! Creates a TransferInput ready to use |
47 | Standard_EXPORT Transfer_TransferInput(); |
48 | |
49 | //! Takes the transient items stored in a TransferIterator |
50 | Standard_EXPORT Interface_EntityIterator Entities (Transfer_TransferIterator& list) const; |
51 | |
52 | //! Fills an InterfaceModel with the Complete Result of a Transfer |
53 | //! stored in a TransientProcess (Starting Objects are Transient) |
54 | //! The complete result is exactly added to the model |
55 | Standard_EXPORT void FillModel (const Handle(Transfer_TransientProcess)& proc, const Handle(Interface_InterfaceModel)& amodel) const; |
56 | |
57 | //! Fills an InterfaceModel with results of the Transfer recorded |
58 | //! in a TransientProcess (Starting Objects are Transient) : |
59 | //! Root Result if <roots> is True (Default), Complete Result else |
60 | //! The entities added to the model are determined from the result |
61 | //! by by adding the referenced entities |
62 | 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; |
63 | |
64 | //! Fills an InterfaceModel with the Complete Result of a Transfer |
65 | //! stored in a TransientProcess (Starting Objects are Transient) |
66 | //! The complete result is exactly added to the model |
67 | Standard_EXPORT void FillModel (const Handle(Transfer_FinderProcess)& proc, const Handle(Interface_InterfaceModel)& amodel) const; |
68 | |
69 | //! Fills an InterfaceModel with results of the Transfer recorded |
70 | //! in a TransientProcess (Starting Objects are Transient) : |
71 | //! Root Result if <roots> is True (Default), Complete Result else |
72 | //! The entities added to the model are determined from the result |
73 | //! by by adding the referenced entities |
74 | 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; |
75 | |
76 | |
77 | |
78 | |
79 | protected: |
80 | |
81 | |
82 | |
83 | |
84 | |
85 | private: |
86 | |
87 | |
88 | |
89 | |
90 | |
91 | }; |
92 | |
93 | |
94 | |
95 | |
96 | |
97 | |
98 | |
99 | #endif // _Transfer_TransferInput_HeaderFile |