summaryrefslogtreecommitdiff
path: root/inc/Transfer_TransferOutput.hxx
blob: 0644861f8698ea9bd9151b86d4ed1f039731ccdc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _Transfer_TransferOutput_HeaderFile
#define _Transfer_TransferOutput_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Handle_Transfer_TransientProcess_HeaderFile
#include <Handle_Transfer_TransientProcess.hxx>
#endif
#ifndef _Handle_Interface_InterfaceModel_HeaderFile
#include <Handle_Interface_InterfaceModel.hxx>
#endif
#ifndef _Handle_Transfer_ActorOfTransientProcess_HeaderFile
#include <Handle_Transfer_ActorOfTransientProcess.hxx>
#endif
#ifndef _Handle_Standard_Transient_HeaderFile
#include <Handle_Standard_Transient.hxx>
#endif
#ifndef _Handle_Interface_Protocol_HeaderFile
#include <Handle_Interface_Protocol.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Transfer_TransientProcess;
class Interface_InterfaceModel;
class Standard_NoSuchObject;
class Transfer_TransferFailure;
class Transfer_ActorOfTransientProcess;
class Standard_Transient;
class Interface_Protocol;
class Interface_Graph;
class Interface_EntityIterator;


//! A TransferOutput is a Tool which manages the transfer of <br>
//!           entities created by an Interface, stored in an InterfaceModel, <br>
//!           into a set of Objects suitable for an Application <br>
//!           Objects to be transferred are given, by method Transfer <br>
//!           (which calls Transfer from TransientProcess) <br>
//!           A default action is available to get all roots of the Model <br>
//!           Result is given as a TransferIterator (see TransferProcess) <br>
//!           Also, it is possible to pilot directly the TransientProcess <br>
class Transfer_TransferOutput  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Creates a TransferOutput ready to use, with a TransientProcess <br>
  Standard_EXPORT   Transfer_TransferOutput(const Handle(Transfer_ActorOfTransientProcess)& actor,const Handle(Interface_InterfaceModel)& amodel);
  //! Creates a TransferOutput from an already existing <br>
//!           TransientProcess, and a Model <br>//! Returns (by Reference, hence can be changed) the Mode for <br>
//!           Scope Management. False (D) means Scope is ignored. <br>
//!           True means that each individual Transfer (direct or through <br>
//!           TransferRoots) is regarded as one Scope <br>
  Standard_EXPORT   Transfer_TransferOutput(const Handle(Transfer_TransientProcess)& proc,const Handle(Interface_InterfaceModel)& amodel);
  //! Returns the Starting Model <br>
  Standard_EXPORT     Handle_Interface_InterfaceModel Model() const;
  //! Returns the TransientProcess used to work <br>
  Standard_EXPORT     Handle_Transfer_TransientProcess TransientProcess() const;
  //! Transfer checks that all taken Entities come from the same <br>
//!           Model, then calls Transfer from TransientProcess <br>
  Standard_EXPORT     void Transfer(const Handle(Standard_Transient)& obj) ;
  //! Runs transfer on the roots of the Interface Model <br>
//!           The Roots are computed with a ShareFlags created from a <br>
//!           Protocol given as Argument <br>
  Standard_EXPORT     void TransferRoots(const Handle(Interface_Protocol)& protocol) ;
  //! Runs transfer on the roots defined by a Graph of dependences <br>
//!           (which detains also a Model and its Entities) <br>
//!           Roots are computed with a ShareFlags created from the Graph <br>
  Standard_EXPORT     void TransferRoots(const Interface_Graph& G) ;
  //! Runs transfer on the roots of the Interface Model <br>
//!           Remark : the Roots are computed with a ShareFlags created <br>
//!           from the Active Protocol <br>
  Standard_EXPORT     void TransferRoots() ;
  //! Returns the list of Starting Entities with these criteria : <br>
//!         - <normal> False, gives the entities bound with ABNORMAL STATUS <br>
//!           (e.g. : Fail recorded, Exception raised during Transfer) <br>
//!         - <normal> True, gives Entities with or without a Result, but <br>
//!           with no Fail, no Exception (Warnings are not counted) <br>
//!         - <roots> False, considers all entities recorded (either for <br>
//!           Result, or for at least one Fail or Warning message) <br>
//!         - <roots> True (Default), considers only roots of Transfer <br>
//!           (the Entities recorded at highest level) <br>
//!          This method is based on AbnormalResult from TransferProcess <br>
  Standard_EXPORT     Interface_EntityIterator ListForStatus(const Standard_Boolean normal,const Standard_Boolean roots = Standard_True) const;
  //! Fills a Model with the list determined by ListForStatus <br>
//!           This model starts from scratch (made by NewEmptyModel from the <br>
//!           current Model), then is filled by AddWithRefs <br>
//! <br>
//!           Useful to get separately from a transfer, the entities which <br>
//!           have caused problem, in order to furtherly analyse them (with <br>
//!           normal = False), or the "good" entities, to obtain a data set <br>
//!           "which works well" (with normal = True) <br>
  Standard_EXPORT     Handle_Interface_InterfaceModel ModelForStatus(const Handle(Interface_Protocol)& protocol,const Standard_Boolean normal,const Standard_Boolean roots = Standard_True) const;





protected:





private:



Handle_Transfer_TransientProcess theproc;
Handle_Interface_InterfaceModel themodel;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif