summaryrefslogtreecommitdiff
path: root/inc/XSControl_SelectForTransfer.hxx
blob: a2d20f1d04176ba00c75371b7ea34aef51d4e0b8 (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
// 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 _XSControl_SelectForTransfer_HeaderFile
#define _XSControl_SelectForTransfer_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_XSControl_SelectForTransfer_HeaderFile
#include <Handle_XSControl_SelectForTransfer.hxx>
#endif

#ifndef _Handle_XSControl_TransferReader_HeaderFile
#include <Handle_XSControl_TransferReader.hxx>
#endif
#ifndef _Handle_Transfer_ActorOfTransientProcess_HeaderFile
#include <Handle_Transfer_ActorOfTransientProcess.hxx>
#endif
#ifndef _IFSelect_SelectExtract_HeaderFile
#include <IFSelect_SelectExtract.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_Standard_Transient_HeaderFile
#include <Handle_Standard_Transient.hxx>
#endif
#ifndef _Handle_Interface_InterfaceModel_HeaderFile
#include <Handle_Interface_InterfaceModel.hxx>
#endif
class XSControl_TransferReader;
class Transfer_ActorOfTransientProcess;
class Standard_Transient;
class Interface_InterfaceModel;
class TCollection_AsciiString;


//! This selection selects the entities which are recognised for <br>
//!           transfer by an Actor for Read : current one or another one. <br>
//! <br>
//!           An Actor is an operator which runs transfers from interface <br>
//!           entities to objects for Imagine. It has a method to recognize <br>
//!           the entities it can process (by default, it recognises all, <br>
//!           this method can be redefined). <br>
//! <br>
//!           A TransferReader brings an Actor, according to the currently <br>
//!           selected norm and transfer conditions. <br>
//! <br>
//!           This selection considers, either the current Actor (brought by <br>
//!           the TransferReader, updated as required), or a precise one. <br>
class XSControl_SelectForTransfer : public IFSelect_SelectExtract {

public:

  //! Creates a SelectForTransfer, non initialised <br>
//!           it sorts nothing, unless an Actor has been defined <br>
  Standard_EXPORT   XSControl_SelectForTransfer();
  //! Creates a SelectForTransfer, which will work with the <br>
//!           currently defined Actor brought by the TransferReader <br>
  Standard_EXPORT   XSControl_SelectForTransfer(const Handle(XSControl_TransferReader)& TR);
  //! Sets a TransferReader to sort entities : it brings the Actor, <br>
//!           which may change, while the TransferReader does not <br>
  Standard_EXPORT     void SetReader(const Handle(XSControl_TransferReader)& TR) ;
  //! Sets a precise actor to sort entities <br>
//!           This definition oversedes the creation with a TransferReader <br>
  Standard_EXPORT     void SetActor(const Handle(Transfer_ActorOfTransientProcess)& act) ;
  //! Returns the Actor used as precised one. <br>
//!           Returns a Null Handle for a creation from a TransferReader <br>
//!           without any further setting <br>
  Standard_EXPORT     Handle_Transfer_ActorOfTransientProcess Actor() const;
  //! Returns the Reader (if created with a Reader) <br>
//!           Returns a Null Handle if not created with a Reader <br>
  Standard_EXPORT     Handle_XSControl_TransferReader Reader() const;
  //! Returns True for an Entity which is recognized by the Actor, <br>
//!           either the precised one, or the one defined by TransferReader <br>
  Standard_EXPORT     Standard_Boolean Sort(const Standard_Integer rank,const Handle(Standard_Transient)& ent,const Handle(Interface_InterfaceModel)& model) const;
  //! Returns a text defining the criterium : "Recognized for Transfer [(current actor)]" <br>
  Standard_EXPORT     TCollection_AsciiString ExtractLabel() const;




  DEFINE_STANDARD_RTTI(XSControl_SelectForTransfer)

protected:




private: 


Handle_XSControl_TransferReader theTR;
Handle_Transfer_ActorOfTransientProcess theAC;


};





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


#endif