1 // Created on: 1992-12-15
2 // Created by: Christian CAILLET
3 // Copyright (c) 1992-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _IFSelect_WorkSession_HeaderFile
18 #define _IFSelect_WorkSession_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
23 #include <Standard_Boolean.hxx>
24 #include <TCollection_AsciiString.hxx>
25 #include <Interface_CheckIterator.hxx>
26 #include <TColStd_IndexedDataMapOfTransientTransient.hxx>
27 #include <Standard_Transient.hxx>
28 #include <NCollection_Vector.hxx>
29 #include <NCollection_DataMap.hxx>
30 #include <Standard_CString.hxx>
31 #include <IFSelect_ReturnStatus.hxx>
32 #include <Standard_Integer.hxx>
33 #include <TColStd_HSequenceOfTransient.hxx>
34 #include <TColStd_HSequenceOfInteger.hxx>
35 #include <Standard_Type.hxx>
36 #include <Standard_Transient.hxx>
37 #include <TColStd_HSequenceOfHAsciiString.hxx>
38 #include <IFSelect_RemainMode.hxx>
39 #include <TColStd_SequenceOfTransient.hxx>
40 #include <TColStd_SequenceOfInteger.hxx>
41 #include <IFSelect_PrintCount.hxx>
42 #include <TCollection_AsciiString.hxx>
43 class IFSelect_ShareOut;
44 class IFSelect_WorkLibrary;
45 class Interface_Protocol;
46 class Interface_InterfaceModel;
47 class Interface_HGraph;
48 class Interface_GTool;
50 class IFSelect_ModelCopier;
51 class Standard_DomainError;
52 class IFSelect_Signature;
53 class TCollection_HAsciiString;
54 class Interface_Graph;
55 class Interface_CheckIterator;
56 class IFSelect_IntParam;
57 class IFSelect_Selection;
58 class Interface_EntityIterator;
59 class IFSelect_SelectionIterator;
60 class IFSelect_SignCounter;
61 class IFSelect_Dispatch;
62 class IFSelect_GeneralModifier;
63 class IFSelect_Modifier;
64 class IFSelect_Transformer;
65 class IFSelect_PacketList;
66 class Message_Messenger;
67 class IFSelect_SignatureList;
70 class IFSelect_WorkSession;
71 DEFINE_STANDARD_HANDLE(IFSelect_WorkSession, Standard_Transient)
73 //! This class can be used to simply manage a process such as
74 //! splitting a file, extracting a set of Entities ...
75 //! It allows to manage different types of Variables : Integer or
76 //! Text Parameters, Selections, Dispatches, in addition to a
77 //! ShareOut. To each of these variables, a unique Integer
78 //! Identifier is attached. A Name can be attached too as desired.
79 class IFSelect_WorkSession : public Standard_Transient
85 //! Creates a Work Session
86 //! It provides default, empty ShareOut and ModelCopier, which can
87 //! be replaced (if required, should be done just after creation).
88 Standard_EXPORT IFSelect_WorkSession();
90 //! Changes the Error Handler status (by default, it is not set)
91 Standard_EXPORT void SetErrorHandle (const Standard_Boolean toHandle);
93 //! Returns the Error Handler status
94 Standard_Boolean ErrorHandle() const
95 { return theerrhand; }
97 //! Returns the ShareOut defined at creation time
98 const Handle(IFSelect_ShareOut) & ShareOut() const
99 { return theshareout; }
101 //! Sets a new ShareOut. Fills Items which its content
102 //! Warning : data from the former ShareOut are lost
103 Standard_EXPORT void SetShareOut (const Handle(IFSelect_ShareOut)& shareout);
105 //! Set value of mode responsible for precence of selections after loading
106 //! If mode set to true that different selections will be accessible after loading
107 //! else selections will be not accessible after loading( for economy memory in applicatios)
108 void SetModeStat (const Standard_Boolean theMode)
109 { themodelstat = theMode; }
111 //! Return value of mode defining of filling selection during loading
112 Standard_Boolean GetModeStat() const
113 { return themodelstat; }
115 //! Sets a WorkLibrary, which will be used to Read and Write Files
116 void SetLibrary (const Handle(IFSelect_WorkLibrary) &theLib)
117 { thelibrary = theLib; }
119 //! Returns the WorkLibrary. Null Handle if not yet set
120 //! should be C++ : return const &
121 const Handle(IFSelect_WorkLibrary) & WorkLibrary() const
122 { return thelibrary; }
124 //! Sets a Protocol, which will be used to determine Graphs, to
125 //! Read and to Write Files
126 Standard_EXPORT void SetProtocol (const Handle(Interface_Protocol)& protocol);
128 //! Returns the Protocol. Null Handle if not yet set
129 //! should be C++ : return const &
130 const Handle(Interface_Protocol) & Protocol() const
131 { return theprotocol; }
133 //! Sets a specific Signature to be the SignType, i.e. the
134 //! Signature which will determine TypeName from the Model
135 //! (basic function). It is recorded in the GTool
136 //! This Signature is also set as "xst-sign-type" (reserved name)
137 Standard_EXPORT void SetSignType (const Handle(IFSelect_Signature)& signtype);
139 //! Returns the current SignType
140 Standard_EXPORT Handle(IFSelect_Signature) SignType() const;
142 //! Returns True is a Model has been set
143 Standard_Boolean HasModel() const
144 { return (!myModel.IsNull()); }
146 //! Sets a Model as input : this will be the Model from which the
147 //! ShareOut will work
148 //! if <clearpointed> is True (default) all SelectPointed items
149 //! are cleared, else they must be managed by the caller
150 //! Remark : SetModel clears the Graph, recomputes it if a
151 //! Protocol is set and if the Model is not empty, of course
152 Standard_EXPORT void SetModel (const Handle(Interface_InterfaceModel)& model, const Standard_Boolean clearpointed = Standard_True);
154 //! Returns the Model of the Work Session (Null Handle if none)
155 //! should be C++ : return const &
156 const Handle(Interface_InterfaceModel) & Model () const
159 //! Stores the filename used for read for setting the model
160 //! It is cleared by SetModel and ClearData(1)
161 void SetLoadedFile (const Standard_CString theFileName)
162 { theloaded = theFileName; }
164 //! Returns the filename used to load current model
166 Standard_CString LoadedFile() const
167 { return theloaded.ToCString(); }
169 //! Reads a file with the WorkLibrary (sets Model and LoadedFile)
170 //! Returns a integer status which can be :
171 //! RetDone if OK, RetVoid if no Protocol not defined,
172 //! RetError for file not found, RetFail if fail during read
173 Standard_EXPORT IFSelect_ReturnStatus ReadFile (const Standard_CString filename);
175 //! Returns the count of Entities stored in the Model, or 0
176 Standard_EXPORT Standard_Integer NbStartingEntities() const;
178 //! Returns an Entity stored in the Model of the WorkSession
179 //! (Null Handle is no Model or num out of range)
180 Standard_EXPORT Handle(Standard_Transient) StartingEntity (const Standard_Integer num) const;
182 //! Returns the Number of an Entity in the Model
183 //! (0 if no Model set or <ent> not in the Model)
184 Standard_EXPORT Standard_Integer StartingNumber (const Handle(Standard_Transient)& ent) const;
186 //! From a given label in Model, returns the corresponding number
187 //! Starts from first entity by Default, may start after a given
188 //! number : this number may be given negative, its absolute value
189 //! is then considered. Hence a loop on NumberFromLabel may be
190 //! programmed (stop test is : returned value positive or null)
192 //! Returns 0 if not found, < 0 if more than one found (first
193 //! found in negative).
194 //! If <val> just gives an integer value, returns it
195 Standard_EXPORT Standard_Integer NumberFromLabel (const Standard_CString val, const Standard_Integer afternum = 0) const;
197 //! Returns the label for <ent>, as the Model does
198 //! If <ent> is not in the Model or if no Model is loaded, a Null
199 //! Handle is returned
200 Standard_EXPORT Handle(TCollection_HAsciiString) EntityLabel (const Handle(Standard_Transient)& ent) const;
202 //! Returns the Name of an Entity
203 //! This Name is computed by the general service Name
204 //! Returns a Null Handle if fails
205 Standard_EXPORT Handle(TCollection_HAsciiString) EntityName (const Handle(Standard_Transient)& ent) const;
207 //! Returns the Category Number determined for an entity
208 //! it is computed by the class Category
209 //! An unknown entity (number 0) gives a value -1
210 Standard_EXPORT Standard_Integer CategoryNumber (const Handle(Standard_Transient)& ent) const;
212 //! Returns the Category Name determined for an entity
213 //! it is computed by the class Category
214 //! Remark : an unknown entity gives an empty string
215 Standard_EXPORT Standard_CString CategoryName (const Handle(Standard_Transient)& ent) const;
217 //! Returns the Validity Name determined for an entity
218 //! it is computed by the class SignValidity
219 //! Remark : an unknown entity gives an empty string
220 Standard_EXPORT Standard_CString ValidityName (const Handle(Standard_Transient)& ent) const;
222 //! Clears recorded data (not the items) according mode :
223 //! 1 : all Data : Model, Graph, CheckList, + ClearData 4
224 //! 2 : Graph and CheckList (they will then be recomputed later)
225 //! 3 : CheckList (it will be recomputed by ComputeCheck)
226 //! 4 : just content of SelectPointed and Counters
227 //! Plus 0 : does nothing but called by SetModel
228 //! ClearData is virtual, hence it can be redefined to clear
229 //! other data of a specialised Work Session
230 Standard_EXPORT virtual void ClearData (const Standard_Integer mode);
232 //! Computes the Graph used for Selections, Displays ...
233 //! If a HGraph is already set, with same model as given by method
234 //! Model, does nothing. Else, computes a new Graph.
235 //! If <enforce> is given True, computes a new Graph anyway.
236 //! Remark that a call to ClearGraph will cause ComputeGraph to
237 //! really compute a new Graph
238 //! Returns True if Graph is OK, False else (i.e. if no Protocol
239 //! is set, or if Model is absent or empty).
240 Standard_EXPORT Standard_Boolean ComputeGraph (const Standard_Boolean enforce = Standard_False);
242 //! Returns the Computed Graph as HGraph (Null Handle if not set)
243 Standard_EXPORT Handle(Interface_HGraph) HGraph();
245 //! Returns the Computed Graph, for Read only
246 Standard_EXPORT const Interface_Graph& Graph();
248 //! Returns the list of entities shared by <ent> (can be empty)
249 //! Returns a null Handle if <ent> is unknown
250 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) Shareds (const Handle(Standard_Transient)& ent);
252 //! Returns the list of entities sharing <ent> (can be empty)
253 //! Returns a null Handle if <ent> is unknown
254 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) Sharings (const Handle(Standard_Transient)& ent);
256 //! Returns True if a Model is defined and really loaded (not
257 //! empty), a Protocol is set and a Graph has been computed.
258 //! In this case, the WorkSession can start to work
259 Standard_EXPORT Standard_Boolean IsLoaded() const;
261 //! Computes the CheckList for the Model currently loaded
262 //! It can then be used for displays, querries ...
263 //! Returns True if OK, False else (i.e. no Protocol set, or Model
264 //! absent). If <enforce> is False, works only if not already done
265 //! or if a new Model has been loaded from last call.
266 //! Remark : computation is enforced by every call to
267 //! SetModel or RunTransformer
268 Standard_EXPORT Standard_Boolean ComputeCheck (const Standard_Boolean enforce = Standard_False);
270 //! Returns the Check List for the Model currently loaded :
271 //! <complete> = True : complete (syntactic & semantic messages),
272 //! computed if not yet done
273 //! <complete> = False : only syntactic (check file form)
274 Standard_EXPORT Interface_CheckIterator ModelCheckList (const Standard_Boolean complete = Standard_True);
276 //! Returns a Check for a single entity, under the form of a
277 //! CheckIterator (this gives only one form for the user)
278 //! if <ent> is Null or equates the current Model, it gives the
279 //! Global Check, else the Check for the given entity
280 //! <complete> as for ModelCheckList
281 Standard_EXPORT Interface_CheckIterator CheckOne (const Handle(Standard_Transient)& ent, const Standard_Boolean complete = Standard_True);
283 //! Returns the Check List produced by the last execution of
284 //! either : EvaluateFile(for Split), SendSplit, SendAll,
285 //! SendSelected, RunTransformer-RunModifier
286 //! Cleared by SetModel or ClearData(1)
287 //! The field is protected, hence a specialized WorkSession may
289 Interface_CheckIterator LastRunCheckList() const
290 { return thecheckrun; }
292 //! Returns the Maximum Value for an Item Identifier. It can be
293 //! greater to the count of known Items, because some can have
295 Standard_EXPORT Standard_Integer MaxIdent() const;
297 //! Returns an Item, given its Ident. Returns a Null Handle if
298 //! no Item corresponds to this Ident.
299 Standard_EXPORT Handle(Standard_Transient) Item (const Standard_Integer id) const;
301 //! Returns the Ident attached to an Item in the WorkSession, or
302 //! Zero if it is unknown
303 Standard_EXPORT Standard_Integer ItemIdent (const Handle(Standard_Transient)& item) const;
305 //! Returns the Item which corresponds to a Variable, given its
306 //! Name (whatever the type of this Item).
307 //! Returns a Null Handle if this Name is not recorded
308 Standard_EXPORT Handle(Standard_Transient) NamedItem (const Standard_CString name) const;
310 //! Same as above, but <name> is given through a Handle
311 //! Especially Usefull with methods SelectionNames, etc...
312 Standard_EXPORT Handle(Standard_Transient) NamedItem (const Handle(TCollection_HAsciiString)& name) const;
314 //! Returns the Ident attached to a Name, 0 if name not recorded
315 Standard_EXPORT Standard_Integer NameIdent (const Standard_CString name) const;
317 //! Returns True if an Item of the WorkSession has an attached Name
318 Standard_EXPORT Standard_Boolean HasName (const Handle(Standard_Transient)& item) const;
320 //! Returns the Name attached to an Item as a Variable of this
321 //! WorkSession. If <item> is Null or not recorded, returns an
323 Standard_EXPORT Handle(TCollection_HAsciiString) Name (const Handle(Standard_Transient)& item) const;
325 //! Adds an Item and returns its attached Ident. Does nothing
326 //! if <item> is already recorded (and returns its attached Ident)
327 //! <active> if True commands call to SetActive (see below)
328 //! Remark : the determined Ident is used if <item> is a Dispatch,
329 //! to fill the ShareOut
330 Standard_EXPORT Standard_Integer AddItem (const Handle(Standard_Transient)& item, const Standard_Boolean active = Standard_True);
332 //! Adds an Item with an attached Name. If the Name is already
333 //! known in the WorkSession, the older item losts it
334 //! Returns Ident if Done, 0 else, i.e. if <item> is null
335 //! If <name> is empty, works as AddItem (i.e. with no name)
336 //! If <item> is already known but with no attached Name, this
337 //! method tries to attached a Name to it
338 //! <active> if True commands call to SetActive (see below)
339 Standard_EXPORT Standard_Integer AddNamedItem (const Standard_CString name, const Handle(Standard_Transient)& item, const Standard_Boolean active = Standard_True);
341 //! Following the type of <item> :
342 //! - Dispatch : Adds or Removes it in the ShareOut & FileNaming
343 //! - GeneralModifier : Adds or Removes it for final sending
344 //! (i.e. in the ModelCopier)
345 //! Returns True if it did something, False else (state unchanged)
346 Standard_EXPORT Standard_Boolean SetActive (const Handle(Standard_Transient)& item, const Standard_Boolean mode);
348 //! Removes an Item from the Session, given its Name
349 //! Returns True if Done, False else (Name not recorded)
350 //! (Applies only on Item which are Named)
351 Standard_EXPORT Standard_Boolean RemoveNamedItem (const Standard_CString name);
353 //! Removes a Name without removing the Item
354 //! Returns True if Done, False else (Name not recorded)
355 Standard_EXPORT Standard_Boolean RemoveName (const Standard_CString name);
357 //! Removes an Item given its Ident. Returns False if <id> is
358 //! attached to no Item in the WorkSession. For a Named Item,
359 //! also removes its Name.
360 Standard_EXPORT Standard_Boolean RemoveItem (const Handle(Standard_Transient)& item);
362 //! Clears all the recorded Items : Selections, Dispatches,
363 //! Modifiers, and Strings & IntParams, with their Idents & Names.
364 //! Remark that if a Model has been loaded, it is not cleared.
365 Standard_EXPORT void ClearItems();
367 //! Returns a Label which illustrates the content of an Item,
368 //! given its Ident. This Label is :
369 //! - for a Text Parameter, "Text:<text value>"
370 //! - for an Integer Parameter, "Integer:<integer value>"
371 //! - for a Selection, a Dispatch or a Modifier, its Label
372 //! (see these classes)
373 //! - for any other kind of Variable, its cdl type
374 Standard_EXPORT Handle(TCollection_HAsciiString) ItemLabel (const Standard_Integer id) const;
376 //! Fills a Sequence with the List of Idents attached to the Items
377 //! of which Type complies with (IsKind) <type> (alphabetic order)
378 //! Remark : <type> = TYPE(Standard_Transient) gives all the
379 //! Idents which are suitable in the WorkSession
380 Standard_EXPORT Handle(TColStd_HSequenceOfInteger) ItemIdents (const Handle(Standard_Type)& type) const;
382 //! Fills a Sequence with the list of the Names attached to Items
383 //! of which Type complies with (IsKind) <type> (alphabetic order)
384 //! Remark : <type> = TYPE(Standard_Transient) gives all the Names
385 Standard_EXPORT Handle(TColStd_HSequenceOfHAsciiString) ItemNames (const Handle(Standard_Type)& type) const;
387 //! Fills a Sequence with the NAMES of the control items, of which
388 //! the label matches <label> (contain it) : see NextIdentForLabel
389 //! Search mode is fixed to "contained"
390 //! If <label> is empty, returns all Names
391 Standard_EXPORT Handle(TColStd_HSequenceOfHAsciiString) ItemNamesForLabel (const Standard_CString label) const;
393 //! For query by Label with possible iterations
394 //! Searches the Ident of which Item has a Label which matches a
395 //! given one, the search starts from an initial Ident.
396 //! Returns the first found Ident which follows <id>, or ZERO
398 //! The search must start with <id> = 0, it returns the next Ident
399 //! which matches. To iterate, call again this method which this
400 //! returned value as <id>. Once an Ident has been returned, the
401 //! Item can be obtained by the method Item
403 //! <mode> precises the required matching mode :
404 //! - 0 (Default) : <label> must match exactly with the Item Label
405 //! - 1 : <label> must match the exact beginning (the end is free)
406 //! - 2 : <label> must be at least once wherever in the Item Label
407 //! - other values are ignored
408 Standard_EXPORT Standard_Integer NextIdentForLabel (const Standard_CString label, const Standard_Integer id, const Standard_Integer mode = 0) const;
410 //! Creates a parameter as being bound to a Static
411 //! If the Static is Integer, this creates an IntParam bound to
412 //! it by its name. Else this creates a String which is the value
414 //! Returns a null handle if <statname> is unknown as a Static
415 Standard_EXPORT Handle(Standard_Transient) NewParamFromStatic (const Standard_CString statname, const Standard_CString name = "");
417 //! Returns an IntParam, given its Ident in the Session
418 //! Null result if <id> is not suitable for an IntParam
419 //! (undefined, or defined for another kind of variable)
420 Standard_EXPORT Handle(IFSelect_IntParam) IntParam (const Standard_Integer id) const;
422 //! Returns Integer Value of an IntParam
423 Standard_EXPORT Standard_Integer IntValue (const Handle(IFSelect_IntParam)& it) const;
425 //! Creates a new IntParam. A Name can be set (Optional)
426 //! Returns the created IntParam, or a Null Handle in case of
427 //! Failure (see AddItem/AddNamedItem)
428 Standard_EXPORT Handle(IFSelect_IntParam) NewIntParam (const Standard_CString name = "");
430 //! Changes the Integer Value of an IntParam
431 //! Returns True if Done, False if <it> is not in the WorkSession
432 Standard_EXPORT Standard_Boolean SetIntValue (const Handle(IFSelect_IntParam)& it, const Standard_Integer val);
434 //! Returns a TextParam, given its Ident in the Session
435 //! Null result if <id> is not suitable for a TextParam
436 //! (undefined, or defined for another kind of variable)
437 Standard_EXPORT Handle(TCollection_HAsciiString) TextParam (const Standard_Integer id) const;
439 //! Returns Text Value of a TextParam (a String)
440 //! or an empty string if <it> is not in the WorkSession
441 Standard_EXPORT TCollection_AsciiString TextValue (const Handle(TCollection_HAsciiString)& par) const;
443 //! Creates a new (empty) TextParam. A Name can be set (Optional)
444 //! Returns the created TextParam (as an HAsciiString), or a Null
445 //! Handle in case of Failure (see AddItem/AddNamedItem)
446 Standard_EXPORT Handle(TCollection_HAsciiString) NewTextParam (const Standard_CString name = "");
448 //! Changes the Text Value of a TextParam (an HAsciiString)
449 //! Returns True if Done, False if <it> is not in the WorkSession
450 Standard_EXPORT Standard_Boolean SetTextValue (const Handle(TCollection_HAsciiString)& par, const Standard_CString val);
452 //! Returns a Signature, given its Ident in the Session
453 //! Null result if <id> is not suitable for a Signature
454 //! (undefined, or defined for another kind of variable)
455 Standard_EXPORT Handle(IFSelect_Signature) Signature (const Standard_Integer id) const;
457 //! Returns the Value computed by a Signature for an Entity
458 //! Returns an empty string if the entity does not belong to the
460 Standard_EXPORT Standard_CString SignValue (const Handle(IFSelect_Signature)& sign, const Handle(Standard_Transient)& ent) const;
462 //! Returns a Selection, given its Ident in the Session
463 //! Null result if <id> is not suitable for a Selection
464 //! (undefined, or defined for another kind of variable)
465 Standard_EXPORT Handle(IFSelect_Selection) Selection (const Standard_Integer id) const;
467 //! Evaluates the effect of a Selection applied on the input Model
468 //! Returned Result remains empty if no input Model has been set
469 Standard_EXPORT Interface_EntityIterator EvalSelection (const Handle(IFSelect_Selection)& sel) const;
471 //! Returns the Selections which are source of Selection, given
472 //! its rank in the List of Selections (see SelectionIterator)
473 //! Returned value is empty if <num> is out of range or if
474 //! <sel> is not in the WorkSession
475 Standard_EXPORT IFSelect_SelectionIterator Sources (const Handle(IFSelect_Selection)& sel) const;
477 //! Returns the result of a Selection, computed by EvalSelection
478 //! (see above) under the form of a HSequence (hence, it can be
479 //! used by a frontal-engine logic). It can be empty
480 //! Returns a Null Handle if <sel> is not in the WorkSession
481 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) SelectionResult (const Handle(IFSelect_Selection)& sel) const;
483 //! Returns the result of a Selection, by forcing its input with
484 //! a given list <list> (unless <list> is Null).
486 //! <list> applies only for a SelectDeduct kind Selection :
487 //! its Input is considered : if it is a SelectDeduct kind
488 //! Selection, its Input is considered, etc... until an Input
489 //! is not a Deduct/Extract : its result is replaced by <list>
490 //! and all the chain of deductions is applied
491 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) SelectionResultFromList (const Handle(IFSelect_Selection)& sel, const Handle(TColStd_HSequenceOfTransient)& list) const;
493 //! Sets a Selection as input for an item, according its type :
494 //! if <item> is a Dispatch : as Final Selection
495 //! if <item> is a GeneralModifier (i.e. any kind of Modifier) :
496 //! as Selection used to filter entities to modify
497 //! <sel> Null causes this Selection to be nullified
498 //! Returns False if <item> is not of a suitable type, or
499 //! <item> or <sel> is not in the WorkSession
500 Standard_EXPORT Standard_Boolean SetItemSelection (const Handle(Standard_Transient)& item, const Handle(IFSelect_Selection)& sel);
502 //! Resets input Selection which was set by SetItemSelection
503 //! Same conditions as for SetItemSelection
504 //! Returns True if done, False if <item> is not in the WorkSession
505 Standard_EXPORT Standard_Boolean ResetItemSelection (const Handle(Standard_Transient)& item);
507 //! Returns the Selection of a Dispatch or a GeneralModifier.
508 //! Returns a Null Handle if none is defined or <item> not good type
509 Standard_EXPORT Handle(IFSelect_Selection) ItemSelection (const Handle(Standard_Transient)& item) const;
511 //! Returns a SignCounter from its ident in the Session
512 //! Null result if <id> is not suitable for a SignCounter
513 //! (undefined, or defined for another kind of variable)
514 Standard_EXPORT Handle(IFSelect_SignCounter) SignCounter (const Standard_Integer id) const;
516 //! Computes the content of a SignCounter when it is defined with
517 //! a Selection, then returns True
518 //! Returns False if the SignCounter is not defined with a
519 //! Selection, or if its Selection Mode is inhibited
520 //! <forced> to work around optimisations
521 Standard_EXPORT Standard_Boolean ComputeCounter (const Handle(IFSelect_SignCounter)& counter, const Standard_Boolean forced = Standard_False);
523 //! Computes the content of a SignCounter from an input list
524 //! If <list> is Null, uses internal definition of the Counter :
525 //! a Selection, else the whole Model (recomputation forced)
526 //! If <clear> is True (D), starts from scratch
527 //! Else, cumulates computations
528 Standard_EXPORT Standard_Boolean ComputeCounterFromList (const Handle(IFSelect_SignCounter)& counter, const Handle(TColStd_HSequenceOfTransient)& list, const Standard_Boolean clear = Standard_True);
530 //! Returns the ordered list of dispatches stored by the ShareOut
531 Standard_EXPORT Handle(TColStd_HSequenceOfInteger) AppliedDispatches() const;
533 //! Clears the list of Dispatches recorded by the ShareOut
534 //! if <only> disp is True, tha's all. Else, clears also the lists
535 //! of Modifiers recorded by the ShareOut
536 Standard_EXPORT void ClearShareOut (const Standard_Boolean onlydisp);
538 //! Returns a Dispatch, given its Ident in the Session
539 //! Null result if <id> is not suitable for a Dispatch
540 //! (undefined, or defined for another kind of variable)
541 Standard_EXPORT Handle(IFSelect_Dispatch) Dispatch (const Standard_Integer id) const;
543 //! Returns the rank of a Dispatch in the ShareOut, or 0 if <disp>
544 //! is not in the ShareOut or not in the WorkSession
545 Standard_EXPORT Standard_Integer DispatchRank (const Handle(IFSelect_Dispatch)& disp) const;
547 //! Gives access to the complete ModelCopier
548 const Handle(IFSelect_ModelCopier) & ModelCopier() const
549 { return thecopier; }
551 //! Sets a new ModelCopier. Fills Items which its content
552 Standard_EXPORT void SetModelCopier (const Handle(IFSelect_ModelCopier)& copier);
554 //! Returns the count of Modifiers applied to final sending
555 //! Model Modifiers if <formodel> is True, File Modifiers else
556 //! (i.e. Modifiers which apply once the Models have been filled)
557 Standard_EXPORT Standard_Integer NbFinalModifiers (const Standard_Boolean formodel) const;
559 //! Fills a Sequence with a list of Idents, those attached to
560 //! the Modifiers applied to final sending.
561 //! Model Modifiers if <formodel> is True, File Modifiers else
562 //! This list is given in the order in which they will be applied
563 //! (which takes into account the Changes to Modifier Ranks)
564 Standard_EXPORT Handle(TColStd_HSequenceOfInteger) FinalModifierIdents (const Standard_Boolean formodel) const;
566 //! Returns a Modifier, given its Ident in the Session
567 //! Null result if <id> is not suitable for a Modifier
568 //! (undefined, or defined for another kind of variable)
569 Standard_EXPORT Handle(IFSelect_GeneralModifier) GeneralModifier (const Standard_Integer id) const;
571 //! Returns a Model Modifier, given its Ident in the Session,
572 //! i.e. typed as a Modifier (not simply a GeneralModifier)
573 //! Null result if <id> is not suitable for a Modifier
574 //! (undefined, or defined for another kind of variable)
575 Standard_EXPORT Handle(IFSelect_Modifier) ModelModifier (const Standard_Integer id) const;
577 //! Returns the Rank of a Modifier given its Ident. Model or File
578 //! Modifier according its type (ModelModifier or not)
579 //! Remember that Modifiers are applied sequencially following
580 //! their Rank : first Model Modifiers then File Modifiers
581 //! Rank is given by rank of call to AddItem and can be
582 //! changed by ChangeModifierRank
583 Standard_EXPORT Standard_Integer ModifierRank (const Handle(IFSelect_GeneralModifier)& item) const;
585 //! Changes the Rank of a Modifier in the Session :
586 //! Model Modifiers if <formodel> is True, File Modifiers else
587 //! the Modifier n0 <before> is put to n0 <after>
588 //! Return True if Done, False if <before> or <after> out of range
589 Standard_EXPORT Standard_Boolean ChangeModifierRank (const Standard_Boolean formodel, const Standard_Integer before, const Standard_Integer after);
591 //! Removes all the Modifiers active in the ModelCopier : they
592 //! become inactive and they are removed from the Session
593 Standard_EXPORT void ClearFinalModifiers();
595 //! Sets a GeneralModifier to be applied to an item :
596 //! - item = ShareOut : applies for final sending (all dispatches)
597 //! - item is a Dispatch : applies for this dispatch only
598 //! Returns True if done, False if <modif> or <item> not in <me>
599 Standard_EXPORT Standard_Boolean SetAppliedModifier (const Handle(IFSelect_GeneralModifier)& modif, const Handle(Standard_Transient)& item);
601 //! Resets a GeneralModifier to be applied
602 //! Returns True if done, False if <modif> was not applied
603 Standard_EXPORT Standard_Boolean ResetAppliedModifier (const Handle(IFSelect_GeneralModifier)& modif);
605 //! Returns the item on which a GeneralModifier is applied :
606 //! the ShareOut, or a given Dispatch
607 //! Returns a Null Handle if <modif> is not applied
608 Standard_EXPORT Handle(Standard_Transient) UsesAppliedModifier (const Handle(IFSelect_GeneralModifier)& modif) const;
610 //! Returns a Transformer, given its Ident in the Session
611 //! Null result if <id> is not suitable for a Transformer
612 //! (undefined, or defined for another kind of variable)
613 Standard_EXPORT Handle(IFSelect_Transformer) Transformer (const Standard_Integer id) const;
615 //! Runs a Transformer on starting Model, which can then be edited
616 //! or replaced by a new one. The Protocol can also be changed.
617 //! Fills LastRunCheckList
619 //! Returned status is 0 if nothing done (<transf> or model
620 //! undefined), positive if OK, negative else :
622 //! 1 : OK, edition on the spot with no change to the graph
623 //! of dependances (purely local)
624 //! 2 : OK, model edited on the spot (graph recomputed, may
625 //! have changed), protocol unchanged
626 //! 3 : OK, new model produced, same protocol
627 //! 4 : OK, model edited on the spot (graph recomputed),
628 //! but protocol has changed
629 //! 5 : OK, new model produced, protocol has changed
630 //! -1 : Error on the spot (slight changes), data may be corrupted
631 //! (remark : corruption should not be profound)
632 //! -2 : Error on edition the spot, data may be corrupted
633 //! (checking them is recommanded)
634 //! -3 : Error with a new data set, transformation ignored
635 //! -4 : OK as 4, but graph of dependances count not be recomputed
636 //! (the former one is kept) : check the protocol
637 Standard_EXPORT Standard_Integer RunTransformer (const Handle(IFSelect_Transformer)& transf);
639 //! Runs a Modifier on Starting Model. It can modify entities, or
640 //! add new ones. But the Model or the Protocol is unchanged.
641 //! The Modifier is applied on each entity of the Model. See also
642 //! RunModifierSelected
643 //! Fills LastRunCheckList
645 //! <copy> : if True, a new data set is produced which brings
646 //! the modifications (Model + its Entities)
647 //! if False, data are modified on the spot
649 //! It works through a TransformStandard defined with <modif>
650 //! Returned status as RunTransformer : 0 nothing done, >0 OK,
651 //! <0 problem, but only between -3 and 3 (protocol unchanged)
652 //! Remark : <copy> True will give <effect> = 3 or -3
653 Standard_EXPORT Standard_Integer RunModifier (const Handle(IFSelect_Modifier)& modif, const Standard_Boolean copy);
655 //! Acts as RunModifier, but the Modifier is applied on the list
656 //! determined by a Selection, rather than on the whole Model
657 //! If the selection is a null handle, the whole model is taken
658 Standard_EXPORT Standard_Integer RunModifierSelected (const Handle(IFSelect_Modifier)& modif, const Handle(IFSelect_Selection)& sel, const Standard_Boolean copy);
660 //! Creates and returns a TransformStandard, empty, with its
661 //! Copy Option (True = Copy, False = On the Spot) and an
663 //! To a TransformStandard, the method SetAppliedModifier applies
664 Standard_EXPORT Handle(IFSelect_Transformer) NewTransformStandard (const Standard_Boolean copy, const Standard_CString name = "");
666 //! Defines a new content from the former one
667 //! If <keep> is True, it is given by entities selected by
668 //! Selection <sel> (and all shared entities)
669 //! Else, it is given by all the former content but entities
670 //! selected by the Selection <sel> (and properly shared ones)
671 //! Returns True if done. Returns False if the selected list
672 //! (from <sel>) is empty, hence nothing is done
673 Standard_EXPORT Standard_Boolean SetModelContent (const Handle(IFSelect_Selection)& sel, const Standard_Boolean keep);
675 //! Returns the defined File Prefix. Null Handle if not defined
676 Standard_EXPORT Handle(TCollection_HAsciiString) FilePrefix() const;
678 //! Returns the defined Default File Root. It is used for
679 //! Dispatches which have no specific root attached.
680 //! Null Handle if not defined
681 Standard_EXPORT Handle(TCollection_HAsciiString) DefaultFileRoot() const;
683 //! Returns the defined File Extension. Null Handle if not defined
684 Standard_EXPORT Handle(TCollection_HAsciiString) FileExtension() const;
686 //! Returns the File Root defined for a Dispatch. Null if no
687 //! Root Name is defined for it (hence, no File will be produced)
688 Standard_EXPORT Handle(TCollection_HAsciiString) FileRoot (const Handle(IFSelect_Dispatch)& disp) const;
690 //! Defines a File Prefix
691 Standard_EXPORT void SetFilePrefix (const Standard_CString name);
693 //! Defines a Default File Root Name. Clears it is <name> = ""
694 //! Returns True if OK, False if <name> already set for a Dispatch
695 Standard_EXPORT Standard_Boolean SetDefaultFileRoot (const Standard_CString name);
697 //! Defines a File Extension
698 Standard_EXPORT void SetFileExtension (const Standard_CString name);
700 //! Defines a Root for a Dispatch
701 //! If <name> is empty, clears Root Name
702 //! This has as effect to inhibit the production of File by <disp>
703 //! Returns False if <disp> is not in the WorkSession or if a
704 //! root name is already defined for it
705 Standard_EXPORT Standard_Boolean SetFileRoot (const Handle(IFSelect_Dispatch)& disp, const Standard_CString name);
707 //! Extracts File Root Name from a given complete file name
709 Standard_EXPORT Standard_CString GiveFileRoot (const Standard_CString file) const;
711 //! Completes a file name as required, with Prefix and Extension
712 //! (if defined; for a non-defined item, completes nothing)
713 Standard_EXPORT Standard_CString GiveFileComplete (const Standard_CString file) const;
715 //! Erases all stored data from the File Evaluation
716 //! (i.e. ALL former naming informations are lost)
717 Standard_EXPORT void ClearFile();
719 //! Performs and stores a File Evaluation. The Results are a List
720 //! of produced Models and a List of names (Strings), in parallel
721 //! Fills LastRunCheckList
722 Standard_EXPORT void EvaluateFile();
724 //! Returns the count of produced Models
725 Standard_EXPORT Standard_Integer NbFiles() const;
727 //! Returns a Model, given its rank in the Evaluation List
728 Standard_EXPORT Handle(Interface_InterfaceModel) FileModel (const Standard_Integer num) const;
730 //! Returns the name of a file corresponding to a produced Model,
731 //! given its rank in the Evaluation List
732 Standard_EXPORT TCollection_AsciiString FileName (const Standard_Integer num) const;
734 //! Commands file sending to clear the list of already sent files,
735 //! commands to record a new one if <record> is True
736 //! This list is managed by the ModelCopier when SendSplit is called
737 //! It allows a global exploitation of the set of sent files
738 Standard_EXPORT void BeginSentFiles (const Standard_Boolean record);
740 //! Returns the list of recorded sent files, or a Null Handle is
741 //! recording has not been enabled
742 Standard_EXPORT Handle(TColStd_HSequenceOfHAsciiString) SentFiles() const;
744 //! Performs creation of derived files from the input Model
745 //! Takes its data (sub-models and names), from result EvaluateFile
746 //! if active, else by dynamic Evaluation (not stored)
747 //! After SendSplit, result of EvaluateFile is Cleared
748 //! Fills LastRunCheckList
750 //! Works with the WorkLibrary which acts on specific type of Model
751 //! and can work with File Modifiers (managed by the Model Copier)
752 //! and a ModelCopier, which can work with Model Modifiers
753 //! Returns False if, either WorkLibrary has failed on at least
754 //! one sub-file, or the Work Session is badly conditionned
755 //! (no Model defined, or FileNaming not in phase with ShareOut)
756 Standard_EXPORT Standard_Boolean SendSplit();
758 //! Returns an Evaluation of the whole ShareOut definition : i.e.
759 //! how the entities of the starting model are forecast to be sent
760 //! to various files : list of packets according the dispatches,
761 //! effective lists of roots for each packet (which determine the
762 //! content of the corresponding file); plus evaluation of which
763 //! entities are : forgotten (sent into no file), duplicated (sent
764 //! into more than one file), sent into a given file.
765 //! See the class PacketList for more details.
766 Standard_EXPORT Handle(IFSelect_PacketList) EvalSplit() const;
768 //! Returns the list of Entities sent in files, accourding the
769 //! count of files each one has been sent (these counts are reset
770 //! by SetModel or SetRemaining(Forget) ) stored in Graph Status
771 //! <count> = -1 (default) is for ENtities sent at least once
772 //! <count> = 0 is for the Remaining List (entities not yet sent)
773 //! <count> = 1 is for entities sent in one and only one file
775 //! Remaining Data are computed on each Sending/Copying output
776 //! files (see methods EvaluateFile and SendSplit)
777 //! Graph Status is 0 for Remaining Entity, <count> for Sent into
779 //! This status is set to 0 (not yet sent) for all by SetModel
780 //! and by SetRemaining(mode=Forget,Display)
781 Standard_EXPORT Interface_EntityIterator SentList (const Standard_Integer count = -1) const;
783 //! Returns the greater count of different files in which any of
784 //! the starting entities could be sent.
785 //! Before any file output, this count is 0.
786 //! Ideal count is 1. More than 1 means that duplications occur.
787 Standard_EXPORT Standard_Integer MaxSendingCount() const;
789 //! Processes Remaining data (after having sent files), mode :
790 //! Forget : forget remaining info (i.e. clear all "Sent" status)
791 //! Compute : compute and keep remaining (does nothing if :
792 //! remaining is empty or if no files has been sent)
793 //! Display : display entities recorded as remaining
794 //! Undo : restore former state of data (after Remaining(1) )
795 //! Returns True if OK, False else (i.e. mode = 2 and Remaining
796 //! List is either empty or takes all the entities, or mode = 3
797 //! and no former computation of remaining data was done)
798 Standard_EXPORT Standard_Boolean SetRemaining (const IFSelect_RemainMode mode);
800 //! Sends the starting Model into one file, without splitting,
801 //! managing remaining data or anything else.
802 //! <computegraph> true commands the Graph to be recomputed before
803 //! sending : required when a Model is filled in several steps
805 //! The Model and File Modifiers recorded to be applied on sending
807 //! Returns a status of execution :
809 //! Void if no data available,
810 //! Error if errors occured (work library is not defined), errors
811 //! during translation
812 //! Fail if exception during translation is raised
813 //! Stop if no disk space or disk, file is write protected
814 //! Fills LastRunCheckList
815 Standard_EXPORT IFSelect_ReturnStatus SendAll (const Standard_CString filename, const Standard_Boolean computegraph = Standard_False);
817 //! Sends a part of the starting Model into one file, without
818 //! splitting. But remaining data are managed.
819 //! <computegraph> true commands the Graph to be recomputed before
820 //! sending : required when a Model is filled in several steps
822 //! The Model and File Modifiers recorded to be applied on sending
824 //! Returns a status : Done if OK, Fail if error during send,
825 //! Error : WorkLibrary not defined, Void : selection list empty
826 //! Fills LastRunCheckList
827 Standard_EXPORT IFSelect_ReturnStatus SendSelected (const Standard_CString filename, const Handle(IFSelect_Selection)& sel, const Standard_Boolean computegraph = Standard_False);
829 //! Writes the current Interface Model globally to a File, and
830 //! returns a write status which can be :
831 //! Done OK, Fail file could not be written, Error no norm is selected
832 //! Remark : It is a simple, one-file writing, other operations are
833 //! available (such as splitting ...) which calls SendAll
834 Standard_EXPORT IFSelect_ReturnStatus WriteFile (const Standard_CString filename);
836 //! Writes a sub-part of the current Interface Model to a File,
837 //! as defined by a Selection <sel>, recomputes the Graph, and
838 //! returns a write status which can be :
839 //! Done OK, Fail file could not be written, Error no norm is selected
840 //! Remark : It is a simple, one-file writing, other operations are
841 //! available (such as splitting ...) which calls SendSelected
842 Standard_EXPORT IFSelect_ReturnStatus WriteFile (const Standard_CString filename, const Handle(IFSelect_Selection)& sel);
844 //! Returns the count of Input Selections known for a Selection,
845 //! or 0 if <sel> not in the WorkSession. This count is one for a
846 //! SelectDeduct / SelectExtract kind, two for SelectControl kind,
847 //! variable for a SelectCombine (Union/Intersection), zero else
848 Standard_EXPORT Standard_Integer NbSources (const Handle(IFSelect_Selection)& sel) const;
850 //! Returns the <num>th Input Selection of a Selection
852 //! Returns a Null Handle if <sel> is not in the WorkSession or if
853 //! <num> is out of the range <1-NbSources>
854 //! To obtain more details, see the method Sources
855 Standard_EXPORT Handle(IFSelect_Selection) Source (const Handle(IFSelect_Selection)& sel, const Standard_Integer num = 1) const;
857 //! Returns True if <sel> a Reversed SelectExtract, False else
858 Standard_EXPORT Standard_Boolean IsReversedSelectExtract (const Handle(IFSelect_Selection)& sel) const;
860 //! Toggles the Sense (Direct <-> Reversed) of a SelectExtract
861 //! Returns True if Done, False if <sel> is not a SelectExtract or
862 //! is not in the WorkSession
863 Standard_EXPORT Standard_Boolean ToggleSelectExtract (const Handle(IFSelect_Selection)& sel);
865 //! Sets an Input Selection (as <input>) to a SelectExtract or
866 //! a SelectDeduct (as <sel>).
867 //! Returns True if Done, False if <sel> is neither a
868 //! SelectExtract nor a SelectDeduct, or not in the WorkSession
869 Standard_EXPORT Standard_Boolean SetInputSelection (const Handle(IFSelect_Selection)& sel, const Handle(IFSelect_Selection)& input);
871 //! Sets an Input Selection, Main if <formain> is True, Second else
872 //! (as <sc>) to a SelectControl (as <sel>). Returns True if Done,
873 //! False if <sel> is not a SelectControl, or <sc> or <sel> is not
874 //! in the WorkSession
875 Standard_EXPORT Standard_Boolean SetControl (const Handle(IFSelect_Selection)& sel, const Handle(IFSelect_Selection)& sc, const Standard_Boolean formain = Standard_True);
877 //! Adds an input selection to a SelectCombine (Union or Inters.).
878 //! Returns new count of inputs for this SelectCombine if Done or
879 //! 0 if <sel> is not kind of SelectCombine, or if <seladd> or
880 //! <sel> is not in the WorkSession
881 //! By default, adding is done at the end of the list
882 //! Else, it is an insertion to rank <atnum> (usefull for Un-ReDo)
883 Standard_EXPORT Standard_Integer CombineAdd (const Handle(IFSelect_Selection)& selcomb, const Handle(IFSelect_Selection)& seladd, const Standard_Integer atnum = 0);
885 //! Removes an input selection from a SelectCombine (Union or
886 //! Intersection). Returns True if done, False if <selcomb> is not
887 //! kind of SelectCombine or <selrem> is not source of <selcomb>
888 Standard_EXPORT Standard_Boolean CombineRemove (const Handle(IFSelect_Selection)& selcomb, const Handle(IFSelect_Selection)& selrem);
890 //! Creates a new Selection, of type SelectPointed, its content
891 //! starts with <list>. A name must be given (can be empty)
892 Standard_EXPORT Handle(IFSelect_Selection) NewSelectPointed (const Handle(TColStd_HSequenceOfTransient)& list, const Standard_CString name);
894 //! Changes the content of a Selection of type SelectPointed
895 //! According <mode> : 0 set <list> as new content (clear former)
896 //! 1 : adds <list> to actual content
897 //! -1 : removes <list> from actual content
898 //! Returns True if done, False if <sel> is not a SelectPointed
899 Standard_EXPORT Standard_Boolean SetSelectPointed (const Handle(IFSelect_Selection)& sel, const Handle(TColStd_HSequenceOfTransient)& list, const Standard_Integer mode) const;
901 //! Returns a Selection from a Name :
902 //! - the name of a Selection : this Selection
903 //! - the name of a Signature + criteria between (..) : a new
904 //! Selection from this Signature
905 //! - an entity or a list of entities : a new SelectPointed
906 //! Else, returns a Null Handle
907 Standard_EXPORT Handle(IFSelect_Selection) GiveSelection (const Standard_CString selname) const;
909 //! Determines a list of entities from an object :
910 //! <obj> already HSequenceOfTransient : returned itself
911 //! <obj> Selection : its Result of Evaluation is returned
912 //! <obj> an entity of the Model : a HSequence which contains it
913 //! else, an empty HSequence
914 //! <obj> the Model it self : ALL its content (not only the roots)
915 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GiveList (const Handle(Standard_Transient)& obj) const;
917 //! Computes a List of entities from two alphanums,
918 //! first and second, as follows :
919 //! if <first> is a Number or Label of an entity : this entity
920 //! if <first> is a list of Numbers/Labels : the list of entities
921 //! if <first> is the name of a Selection in <WS>, and <second>
922 //! not defined, the standard result of this Selection
923 //! else, let's consider "first second" : this whole phrase is
924 //! splitted by blanks, as follows (RECURSIVE CALL) :
925 //! - the leftest term is the final selection
926 //! - the other terms define the result of the selection
927 //! - and so on (the "leftest minus one" is a selection, of which
928 //! the input is given by the remaining ...)
929 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GiveList (const Standard_CString first, const Standard_CString second = "") const;
931 //! Computes a List of entities from the model as follows
932 //! <first> beeing a Selection or a combination of Selections,
933 //! <ent> beeing an entity or a list
934 //! of entities (as a HSequenceOfTransient) :
935 //! the standard result of this selection applied to this list
936 //! if <ent> is Null, the standard definition of the selection is
937 //! used (which contains a default input selection)
938 //! if <selname> is erroneous, a null handle is returned
940 //! REMARK : selname is processed as <first second> of preceeding
942 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GiveListFromList (const Standard_CString selname, const Handle(Standard_Transient)& ent) const;
944 //! Combines two lists and returns the result, according to mode :
945 //! <mode> < 0 : entities in <l1> AND NOT in <l2>
946 //! <mode> = 0 : entities in <l1> AND in <l2>
947 //! <mode> > 0 : entities in <l1> OR in <l2>
948 Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GiveListCombined (const Handle(TColStd_HSequenceOfTransient)& l1, const Handle(TColStd_HSequenceOfTransient)& l2, const Standard_Integer mode) const;
950 //! Loads data from a check iterator to query status on it
951 Standard_EXPORT void QueryCheckList (const Interface_CheckIterator& chl);
953 //! Determines check status for an entity regarding last call to
955 //! -1 : <ent> unknown in the model, ignored
956 //! 0 : no check at all, immediate or inherited thru Graph
957 //! 1 : immediate warning (no fail), no inherited check
958 //! 2 : immediate fail, no inherited check
959 //! +10 : idem but some inherited warning (no fail)
960 //! +20 : idem but some inherited fail
961 Standard_EXPORT Standard_Integer QueryCheckStatus (const Handle(Standard_Transient)& ent) const;
963 //! Determines if <entdad> is parent of <entson> (in the graph),
964 //! returns : -1 if no; 0 if <entdad> = <entson>
965 //! 1 if immediate parent, > 1 if parent, gives count of steps
966 Standard_EXPORT Standard_Integer QueryParent (const Handle(Standard_Transient)& entdad, const Handle(Standard_Transient)& entson) const;
968 //! Sets a list of Parameters, i.e. TypedValue, to be handled
969 //! through an Editor
970 //! The two lists are parallel, if <params> is longer than <uses>,
971 //! surnumeral parameters are for general use
973 //! EditForms are created to handle these parameters (list, edit)
974 //! on the basis of a ParamEditor xst-params-edit
976 //! A use number dispatches the parameter to a given EditForm
977 //! EditForms are defined as follows
979 //! xst-params all All Parameters (complete list)
980 //! xst-params-general 1 Generals
981 //! xst-params-load 2 LoadFile (no Transfer)
982 //! xst-params-send 3 SendFile (Write, no Transfer)
983 //! xst-params-split 4 Split
984 //! xst-param-read 5 Transfer on Reading
985 //! xst-param-write 6 Transfer on Writing
986 Standard_EXPORT void SetParams (const NCollection_Vector<Handle(Standard_Transient)>& params, const NCollection_Vector<Standard_Integer>& uselist);
988 //! Traces the Statics attached to a given use number
989 //! If <use> is given positive (normal), the trace is embedded
990 //! with a header and a trailer
991 //! If <use> is negative, just values are printed
992 //! (this allows to make compositions)
993 //! Remark : use number 5 commands use -2 to be traced
994 //! Remark : use numbers 4 and 6 command use -3 to be traced
995 Standard_EXPORT void TraceStatics (const Standard_Integer use, const Standard_Integer mode = 0) const;
997 //! Dumps contents of the ShareOut (on "cout")
998 Standard_EXPORT void DumpShare() const;
1000 //! Lists the Labels of all Items of the WorkSession
1001 //! If <label> is defined, lists labels which contain it
1002 Standard_EXPORT void ListItems (const Standard_CString label = "") const;
1004 //! Lists the Modifiers of the session (for each one, displays
1005 //! its Label). Listing is done following Ranks (Modifiers are
1006 //! invoked following their ranks)
1007 //! Model Modifiers if <formodel> is True, File Modifiers else
1008 Standard_EXPORT void ListFinalModifiers (const Standard_Boolean formodel) const;
1010 //! Lists a Selection and its Sources (see SelectionIterator),
1011 //! given its rank in the list
1012 Standard_EXPORT void DumpSelection (const Handle(IFSelect_Selection)& sel) const;
1014 //! Lists the content of the Input Model (if there is one)
1015 //! According level : 0 -> gives only count of Entities and Roots
1016 //! 1 -> Lists also Roots; 2 -> Lists all Entities (by TraceType)
1017 //! 3 -> Performs a call to CheckList (Fails) and lists the result
1018 //! 4 -> as 3 but all CheckList (Fails + Warnings)
1019 //! 5,6,7 : as 3 but resp. Count,List,Labels by Fail
1020 //! 8,9,10 : as 4 but resp. Count,List,Labels by message
1021 Standard_EXPORT void DumpModel (const Standard_Integer level, const Handle(Message_Messenger)& S);
1023 //! Dumps the current Model (as inherited DumpModel), on currently
1024 //! defined Default Trace File (default is standard output)
1025 Standard_EXPORT void TraceDumpModel (const Standard_Integer mode);
1027 //! Dumps a starting entity according to the current norm.
1028 //! To do this, it calls DumpEntity from WorkLibrary.
1029 //! <level> is to be interpreted for each norm : see specific
1030 //! classes of WorkLibrary for it. Generally, 0 if for very basic
1031 //! (only type ...), greater values give more and more details.
1032 Standard_EXPORT void DumpEntity (const Handle(Standard_Transient)& ent, const Standard_Integer level, const Handle(Message_Messenger)& S) const;
1034 //! Prints main informations about an entity : its number, type,
1035 //! validity (and checks if any), category, shareds and sharings..
1036 //! mutable because it can recompute checks as necessary
1037 Standard_EXPORT void PrintEntityStatus (const Handle(Standard_Transient)& ent, const Handle(Message_Messenger)& S);
1039 //! Dumps an entity from the current Model as inherited DumpEntity
1040 //! on currently defined Default Trace File
1041 //! (<level> interpreted according to the Norm, see WorkLibrary)
1042 Standard_EXPORT void TraceDumpEntity (const Handle(Standard_Transient)& ent, const Standard_Integer level) const;
1044 //! Prints a CheckIterator to the current Trace File, controlled
1045 //! with the current Model
1046 //! complete or fails only, according to <failsonly>
1047 //! <mode> defines the mode of printing
1048 //! 0 : sequential, according entities; else with a CheckCounter
1049 //! 1 : according messages, count of entities
1050 //! 2 : id but with list of entities, designated by their numbers
1051 //! 3 : as 2 but with labels of entities
1052 Standard_EXPORT void PrintCheckList (const Interface_CheckIterator& checklist, const Standard_Boolean failsonly, const IFSelect_PrintCount mode) const;
1054 //! Prints a SignatureList to the current Trace File, controlled
1055 //! with the current Model
1056 //! <mode> defines the mode of printing (see SignatureList)
1057 Standard_EXPORT void PrintSignatureList (const Handle(IFSelect_SignatureList)& signlist, const IFSelect_PrintCount mode) const;
1059 //! Displays the list of Entities selected by a Selection (i.e.
1060 //! the result of EvalSelection).
1061 Standard_EXPORT void EvaluateSelection (const Handle(IFSelect_Selection)& sel) const;
1063 //! Displays the result of applying a Dispatch on the input Model
1064 //! (also shows Remainder if there is)
1065 //! <mode> = 0 (default), displays nothing else
1066 //! <mode> = 1 : displays also duplicated entities (because of
1068 //! <mode> = 2 : displays the entities of the starting Model
1069 //! which are not taken by this dispatch (forgotten entities)
1070 //! <mode> = 3 : displays both duplicated and forgotten entities
1071 //! Remark : EvaluateComplete displays these data evaluated for
1072 //! for all the dispatches, if there are several
1073 Standard_EXPORT void EvaluateDispatch (const Handle(IFSelect_Dispatch)& disp, const Standard_Integer mode = 0) const;
1075 //! Displays the effect of applying the ShareOut on the input
1077 //! <mode> = 0 (default) : displays only roots for each packet,
1078 //! <mode> = 1 : displays all entities for each packet, plus
1079 //! duplicated entities
1080 //! <mode> = 2 : same as <mode> = 1, plus displays forgotten
1081 //! entities (which are in no packet at all)
1082 Standard_EXPORT void EvaluateComplete (const Standard_Integer mode = 0) const;
1084 //! Internal method which displays an EntityIterator
1085 //! <mode> 0 gives short display (only entity numbers)
1086 //! 1 gives a more complete trace (1 line per Entity)
1087 //! (can be used each time a trace has to be output from a list)
1088 //! 2 gives a form suitable for givelist : (n1,n2,n3...)
1089 Standard_EXPORT void ListEntities (const Interface_EntityIterator& iter, const Standard_Integer mode) const;
1091 DEFINE_STANDARD_RTTIEXT(IFSelect_WorkSession,Standard_Transient)
1095 Handle(Interface_HGraph) thegraph;
1096 Interface_CheckIterator thecheckrun;
1097 TColStd_IndexedDataMapOfTransientTransient theitems;
1098 NCollection_DataMap<TCollection_AsciiString, Handle(Standard_Transient)> thenames;
1102 Standard_Boolean theerrhand;
1103 Handle(IFSelect_ShareOut) theshareout;
1104 Handle(IFSelect_WorkLibrary) thelibrary;
1105 Handle(Interface_Protocol) theprotocol;
1106 Handle(Interface_InterfaceModel) myModel;
1107 TCollection_AsciiString theloaded;
1108 Handle(Interface_GTool) thegtool;
1109 Standard_Boolean thecheckdone;
1110 Interface_CheckIterator thechecklist;
1111 TCollection_AsciiString thecheckana;
1112 Handle(IFSelect_ModelCopier) thecopier;
1113 Handle(Interface_InterfaceModel) theoldel;
1114 Standard_Boolean themodelstat;
1117 #endif // _IFSelect_WorkSession_HeaderFile