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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
// 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 _Interface_CheckIterator_HeaderFile
#define _Interface_CheckIterator_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif
#ifndef _Handle_Interface_HSequenceOfCheck_HeaderFile
#include <Handle_Interface_HSequenceOfCheck.hxx>
#endif
#ifndef _Handle_TColStd_HSequenceOfInteger_HeaderFile
#include <Handle_TColStd_HSequenceOfInteger.hxx>
#endif
#ifndef _Handle_Interface_InterfaceModel_HeaderFile
#include <Handle_Interface_InterfaceModel.hxx>
#endif
#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _Handle_Interface_IntVal_HeaderFile
#include <Handle_Interface_IntVal.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Handle_Interface_Check_HeaderFile
#include <Handle_Interface_Check.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_Standard_Transient_HeaderFile
#include <Handle_Standard_Transient.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Interface_CheckStatus_HeaderFile
#include <Interface_CheckStatus.hxx>
#endif
#ifndef _Handle_TColStd_HSequenceOfTransient_HeaderFile
#include <Handle_TColStd_HSequenceOfTransient.hxx>
#endif
#ifndef _Handle_Message_Messenger_HeaderFile
#include <Handle_Message_Messenger.hxx>
#endif
class Interface_HSequenceOfCheck;
class TColStd_HSequenceOfInteger;
class Interface_InterfaceModel;
class Interface_IntVal;
class Standard_NoSuchObject;
class Interface_Check;
class Standard_Transient;
class TColStd_HSequenceOfTransient;
class Message_Messenger;
//! Result of a Check operation (especially from InterfaceModel) <br>
class Interface_CheckIterator {
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 an empty CheckIterator <br>
Standard_EXPORT Interface_CheckIterator();
//! Creates a CheckIterator with a name (displayed by Print as a <br>
//! title) <br>
Standard_EXPORT Interface_CheckIterator(const Standard_CString name);
//! Sets / Changes the name <br>
Standard_EXPORT void SetName(const Standard_CString name) ;
//! Returns the recorded name (can be empty) <br>
Standard_EXPORT Standard_CString Name() const;
//! Defines a Model, used to locate entities (not required, if it <br>
//! is absent, entities are simply less documented) <br>
Standard_EXPORT void SetModel(const Handle(Interface_InterfaceModel)& model) ;
//! Returns the stored model (can be a null handle) <br>
Standard_EXPORT Handle_Interface_InterfaceModel Model() const;
//! Clears the list of checks <br>
Standard_EXPORT void Clear() ;
//! Merges another CheckIterator into <me>, i.e. adds each of its <br>
//! Checks. Content of <other> remains unchanged. <br>
//! Takes also the Model but not the Name <br>
Standard_EXPORT void Merge(Interface_CheckIterator& other) ;
//! Adds a Check to the list to be iterated <br>
//! This Check is Accompanied by Entity Number in the Model <br>
//! (0 for Global Check or Entity unknown in the Model), if 0 and <br>
//! Model is recorded in <me>, it is computed <br>
Standard_EXPORT void Add(const Handle(Interface_Check)& ach,const Standard_Integer num = 0) ;
//! Returns the Check which was attached to an Entity given its <br>
//! Number in the Model. <num>=0 is for the Global Check. <br>
//! If no Check was recorded for this Number, returns an empty <br>
//! Check. <br>
//! Remark : Works apart from the iteration methods (no interference) <br>
Standard_EXPORT const Handle_Interface_Check& Check(const Standard_Integer num) const;
//! Returns the Check attached to an Entity <br>
//! If no Check was recorded for this Entity, returns an empty <br>
//! Check. <br>
//! Remark : Works apart from the iteration methods (no interference) <br>
Standard_EXPORT const Handle_Interface_Check& Check(const Handle(Standard_Transient)& ent) const;
//! Returns the Check bound to an Entity Number (0 : Global) <br>
//! in order to be consulted or completed on the spot <br>
//! I.e. returns the Check if is already exists, or adds it then <br>
//! returns the new empty Check <br>
Standard_EXPORT Handle_Interface_Check& CCheck(const Standard_Integer num) ;
//! Returns the Check bound to an Entity, in order to be consulted <br>
//! or completed on the spot <br>
//! I.e. returns the Check if is already exists, or adds it then <br>
//! returns the new empty Check <br>
Standard_EXPORT Handle_Interface_Check& CCheck(const Handle(Standard_Transient)& ent) ;
//! Returns True if : no Fail has been recorded if <failsonly> is <br>
//! True, no Check at all if <failsonly> is False <br>
Standard_EXPORT Standard_Boolean IsEmpty(const Standard_Boolean failsonly) const;
//! Returns worst status among : OK, Warning, Fail <br>
Standard_EXPORT Interface_CheckStatus Status() const;
//! Tells if this check list complies with a given status : <br>
//! OK (i.e. empty), Warning (at least one Warning, but no Fail), <br>
//! Fail (at least one), Message (not OK), NoFail, Any <br>
Standard_EXPORT Standard_Boolean Complies(const Interface_CheckStatus status) const;
//! Returns a CheckIterator which contains the checks which comply <br>
//! with a given status <br>
//! Each check is added completely (no split Warning/Fail) <br>
Standard_EXPORT Interface_CheckIterator Extract(const Interface_CheckStatus status) const;
//! Returns a CheckIterator which contains the check which comply <br>
//! with a message, plus some conditions as follows : <br>
//! <incl> = 0 : <mess> exactly matches one of the messages <br>
//! <incl> < 0 : <mess> is contained by one of the messages <br>
//! <incl> > 0 : <mess> contains one of the messages <br>
//! For <status> : for CheckWarning and CheckFail, considers only <br>
//! resp. Warning or Check messages. for CheckAny, considers all <br>
//! other values are ignored (answer will be false) <br>
//! Each Check which complies is entirely taken <br>
Standard_EXPORT Interface_CheckIterator Extract(const Standard_CString mess,const Standard_Integer incl,const Interface_CheckStatus status) const;
//! Removes the messages of all Checks, under these conditions : <br>
//! <incl> = 0 : <mess> exactly matches one of the messages <br>
//! <incl> < 0 : <mess> is contained by one of the messages <br>
//! <incl> > 0 : <mess> contains one of the messages <br>
//! For <status> : for CheckWarning and CheckFail, considers only <br>
//! resp. Warning or Check messages. for CheckAny, considers all <br>
//! other values are ignored (nothing is done) <br>
//! Returns True if at least one message has been removed, False else <br>
Standard_EXPORT Standard_Boolean Remove(const Standard_CString mess,const Standard_Integer incl,const Interface_CheckStatus status) ;
//! Returns the list of entities concerned by a Check <br>
//! Only fails if <failsonly> is True, else all non-empty checks <br>
//! If <global> is true, adds the model for a global check <br>
//! Else, global check is ignored <br>
Standard_EXPORT Handle_TColStd_HSequenceOfTransient Checkeds(const Standard_Boolean failsonly,const Standard_Boolean global) const;
//! Starts Iteration. Thus, it is possible to restart it <br>
//! Remark : an iteration may be done with a const Iterator <br>
//! While its content is modified (through a pointer), this allows <br>
//! to give it as a const argument to a function <br>
Standard_EXPORT void Start() const;
//! Returns True if there are more Checks to get <br>
Standard_EXPORT Standard_Boolean More() const;
//! Sets Iteration to next Item <br>
Standard_EXPORT void Next() const;
//! Returns Check currently Iterated <br>
//! It brings all other informations (status, messages, ...) <br>
//! The Number of the Entity in the Model is given by Number below <br>
Standard_EXPORT const Handle_Interface_Check& Value() const;
//! Returns Number of Entity for the Check currently iterated <br>
//! or 0 for GlobalCheck <br>
Standard_EXPORT Standard_Integer Number() const;
//! Prints the list of Checks with their attached Numbers <br>
//! If <failsonly> is True, prints only Fail messages <br>
//! If <failsonly> is False, prints all messages <br>
//! If <final> = 0 (D), prints also original messages if different <br>
//! If <final> < 0, prints only original messages <br>
//! If <final> > 0, prints only final messages <br>
//! It uses the recorded Model if it is defined <br>
//! Remark : Works apart from the iteration methods (no interference) <br>
Standard_EXPORT void Print(const Handle(Message_Messenger)& S,const Standard_Boolean failsonly,const Standard_Integer final = 0) const;
//! Works as Print without a model, but for entities which have <br>
//! no attached number (Number not positive), tries to compute <br>
//! this Number from <model> and displays "original" or "computed" <br>
Standard_EXPORT void Print(const Handle(Message_Messenger)& S,const Handle(Interface_InterfaceModel)& model,const Standard_Boolean failsonly,const Standard_Integer final = 0) const;
//! Clears data of iteration <br>
Standard_EXPORT void Destroy() ;
~Interface_CheckIterator()
{
Destroy();
}
protected:
private:
Handle_Interface_HSequenceOfCheck thelist;
Handle_TColStd_HSequenceOfInteger thenums;
Handle_Interface_InterfaceModel themod;
TCollection_AsciiString thename;
Handle_Interface_IntVal thecurr;
};
// other Inline functions and methods (like "C++: function call" methods)
#endif
|
