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