summaryrefslogtreecommitdiff
path: root/inc/IFSelect_SelectSuite.hxx
blob: 943c5f444ca405328b574d03900e57ca44871e11 (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
// 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 _IFSelect_SelectSuite_HeaderFile
#define _IFSelect_SelectSuite_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_IFSelect_SelectSuite_HeaderFile
#include <Handle_IFSelect_SelectSuite.hxx>
#endif

#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _TColStd_SequenceOfTransient_HeaderFile
#include <TColStd_SequenceOfTransient.hxx>
#endif
#ifndef _IFSelect_SelectDeduct_HeaderFile
#include <IFSelect_SelectDeduct.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Handle_IFSelect_Selection_HeaderFile
#include <Handle_IFSelect_Selection.hxx>
#endif
#ifndef _Handle_IFSelect_SelectDeduct_HeaderFile
#include <Handle_IFSelect_SelectDeduct.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
class Interface_InterfaceError;
class IFSelect_Selection;
class IFSelect_SelectDeduct;
class Interface_EntityIterator;
class Interface_Graph;
class TCollection_AsciiString;


//! A SelectSuite can describe a suite of SelectDeduct as a unique <br>
//!           one : in other words, it can be seen as a "macro selection" <br>
//! <br>
//!           It works by applying each of its items (which is a <br>
//!           SelectDeduct) on the result computed by the previous one <br>
//!           (by using Alternate Input) <br>
//! <br>
//!           But each of these Selections used as items may be used <br>
//!           independently, it will then give its own result <br>
//! <br>
//!           Hence, SelectSuite gives a way of defining a new Selection <br>
//!           from existing ones, without having to do copies or saves <br>
class IFSelect_SelectSuite : public IFSelect_SelectDeduct {

public:

  //! Creates an empty SelectSuite <br>
  Standard_EXPORT   IFSelect_SelectSuite();
  //! Adds an input selection. I.E. : <br>
//!           If <item> is a SelectDeduct, adds it as Previous, not as Input <br>
//!           Else, sets it as Input <br>
//!           Returns True when done <br>
//!           Returns False and refuses to work if Input is already defined <br>
  Standard_EXPORT     Standard_Boolean AddInput(const Handle(IFSelect_Selection)& item) ;
  //! Adds a new first item (prepends to the list). The Input is not <br>
//!           touched <br>
//!           If <item> is null, does nothing <br>
  Standard_EXPORT     void AddPrevious(const Handle(IFSelect_SelectDeduct)& item) ;
  //! Adds a new last item (prepends to the list) <br>
//!           If <item> is null, does nothing <br>
  Standard_EXPORT     void AddNext(const Handle(IFSelect_SelectDeduct)& item) ;
  //! Returns the count of Items <br>
  Standard_EXPORT     Standard_Integer NbItems() const;
  //! Returns an item from its rank in the list <br>
//!           (the Input is always apart) <br>
  Standard_EXPORT     Handle_IFSelect_SelectDeduct Item(const Standard_Integer num) const;
  //! Sets a value for the Label <br>
  Standard_EXPORT     void SetLabel(const Standard_CString lab) ;
  //! Returns the list of selected entities <br>
//!           To do this, once InputResult has been taken (if Input or <br>
//!           Alternate has been defined, else the first Item gives it) : <br>
//!           this result is set as alternate input for the first item, <br>
//!           which computes its result : this result is set as alternate <br>
//!           input for the second item, etc... <br>
  Standard_EXPORT     Interface_EntityIterator RootResult(const Interface_Graph& G) const;
  //! Returns the Label <br>
//!           Either it has been defined by SetLabel, or it will give <br>
//!           "Suite of nn Selections" <br>
  Standard_EXPORT     TCollection_AsciiString Label() const;




  DEFINE_STANDARD_RTTI(IFSelect_SelectSuite)

protected:




private: 


TCollection_AsciiString thelab;
TColStd_SequenceOfTransient thesel;


};





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


#endif