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