0025748: Parallel version of progress indicator
[occt.git] / src / XSControl / XSControl_Controller.hxx
1 // Created on: 1995-03-13
2 // Created by: Christian CAILLET
3 // Copyright (c) 1995-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 _XSControl_Controller_HeaderFile
18 #define _XSControl_Controller_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TCollection_AsciiString.hxx>
24 #include <TColStd_SequenceOfTransient.hxx>
25 #include <TColStd_HSequenceOfHAsciiString.hxx>
26 #include <TColStd_SequenceOfInteger.hxx>
27 #include <Interface_HArray1OfHAsciiString.hxx>
28 #include <Standard_Transient.hxx>
29 #include <NCollection_Vector.hxx>
30 #include <IFSelect_ReturnStatus.hxx>
31 #include <Standard_Transient.hxx>
32 #include <NCollection_DataMap.hxx>
33 #include <TCollection_AsciiString.hxx>
34 #include <Message_ProgressRange.hxx>
35
36 class IFSelect_WorkLibrary;
37 class Interface_Protocol;
38 class IFSelect_Signature;
39 class Transfer_ActorOfTransientProcess;
40 class Transfer_ActorOfFinderProcess;
41 class Standard_DomainError;
42 class XSControl_WorkSession;
43 class Interface_InterfaceModel;
44 class Transfer_FinderProcess;
45 class TopoDS_Shape;
46 class Interface_CheckIterator;
47
48 class XSControl_Controller;
49 DEFINE_STANDARD_HANDLE(XSControl_Controller, Standard_Transient)
50
51 //! This class allows a general X-STEP engine to run generic
52 //! functions on any interface norm, in the same way. It includes
53 //! the transfer operations. I.e. it gathers the already available
54 //! general modules, the engine has just to know it
55 //!
56 //! The important point is that a given X-STEP Controller is
57 //! attached to a given couple made of an Interface Norm (such as
58 //! IGES-5.1) and an application data model (CasCade Shapes for
59 //! instance).
60 //!
61 //! Finally, Controller can be gathered in a general dictionary then
62 //! retreived later by a general call (method Recorded)
63 //!
64 //! It does not manage the produced data, but the Actors make the
65 //! link between the norm and the application
66 class XSControl_Controller : public Standard_Transient
67 {
68  public:
69   
70   //! Changes names
71   //! if a name is empty, the formerly set one remains
72   //! Remark : Does not call Record or AutoRecord
73   Standard_EXPORT void SetNames (const Standard_CString theLongName, const Standard_CString theShortName);
74   
75   //! Records <me> is a general dictionary under Short and Long
76   //! Names (see method Name)
77   void AutoRecord() const
78   {
79     Record (Name(Standard_True));
80     Record (Name(Standard_False));
81   }
82   
83   //! Records <me> in a general dictionary under a name
84   //! Error if <name> already used for another one
85   Standard_EXPORT void Record (const Standard_CString name) const;
86   
87   //! Returns the Controller attached to a given name
88   //! Returns a Null Handle if <name> is unknown
89   Standard_EXPORT static Handle(XSControl_Controller) Recorded (const Standard_CString name);
90   
91   //! Returns a name, as given when initializing :
92   //! rsc = False (D) : True Name attached to the Norm (long name)
93   //! rsc = True : Name of the ressource set (i.e. short name)
94   Standard_CString Name (const Standard_Boolean rsc = Standard_False) const
95   { return (rsc ? myShortName.ToCString() : myLongName.ToCString()); }
96   
97   //! Returns the Protocol attached to the Norm (from field)
98   const Handle(Interface_Protocol) & Protocol () const
99   { return myAdaptorProtocol; }
100   
101   //! Returns the SignType attached to the norm (from field)
102   //szv:const Handle(IFSelect_Signature) & SignType1() const
103   //szv:{ return mySignType; }
104   
105   //! Returns the WorkLibrary attached to the Norm. Remark that it
106   //! has to be in phase with the Protocol  (read from field)
107   const Handle(IFSelect_WorkLibrary) & WorkLibrary() const
108   { return myAdaptorLibrary; }
109   
110   //! Creates a new empty Model ready to receive data of the Norm
111   //! Used to write data from Imagine to an interface file
112   Standard_EXPORT virtual Handle(Interface_InterfaceModel) NewModel() const = 0;
113   
114   //! Returns the Actor for Read attached to the pair (norm,appli)
115   //! It can be adapted for data of the input Model, as required
116   //! Can be read from field then adapted with Model as required
117   Standard_EXPORT virtual Handle(Transfer_ActorOfTransientProcess) ActorRead (const Handle(Interface_InterfaceModel)& model) const;
118   
119   //! Returns the Actor for Write attached to the pair (norm,appli)
120   //! Read from field. Can be redefined
121   Standard_EXPORT virtual Handle(Transfer_ActorOfFinderProcess) ActorWrite() const;
122   
123   //! Sets mininum and maximum values for modetrans (write)
124   //! Erases formerly recorded bounds and values
125   //! Actually only for shape
126   //! Then, for each value a little help can be attached
127   Standard_EXPORT void SetModeWrite (const Standard_Integer modemin, const Standard_Integer modemax, const Standard_Boolean shape = Standard_True);
128   
129   //! Attaches a short line of help to a value of modetrans (write)
130   Standard_EXPORT void SetModeWriteHelp (const Standard_Integer modetrans, const Standard_CString help, const Standard_Boolean shape = Standard_True);
131   
132   //! Returns recorded min and max values for modetrans (write)
133   //! Actually only for shapes
134   //! Returns True if bounds are set, False else (then, free value)
135   Standard_EXPORT Standard_Boolean ModeWriteBounds (Standard_Integer& modemin, Standard_Integer& modemax, const Standard_Boolean shape = Standard_True) const;
136   
137   //! Tells if a value of <modetrans> is a good value(within bounds)
138   //! Actually only for shapes
139   Standard_EXPORT Standard_Boolean IsModeWrite (const Standard_Integer modetrans, const Standard_Boolean shape = Standard_True) const;
140   
141   //! Returns the help line recorded for a value of modetrans
142   //! empty if help not defined or not within bounds or if values are free
143   Standard_EXPORT Standard_CString ModeWriteHelp (const Standard_Integer modetrans, const Standard_Boolean shape = Standard_True) const;
144   
145   //! Tells if <obj> (an application object) is a valid candidate
146   //! for a transfer to a Model.
147   //! By default, asks the ActorWrite if known (through a
148   //! TransientMapper). Can be redefined
149   Standard_EXPORT virtual Standard_Boolean RecognizeWriteTransient (const Handle(Standard_Transient)& obj, const Standard_Integer modetrans = 0) const;
150   
151   //! Takes one Transient Object and transfers it to an
152   //! InterfaceModel (already created, e.g. by NewModel)
153   //! (result is recorded in the model by AddWithRefs)
154   //! FP records produced results and checks
155   //!
156   //! Default uses ActorWrite; can be redefined as necessary
157   //! Returned value is a status, as follows :
158   //! 0  OK ,  1 No Result ,  2 Fail (e.g. exception raised)
159   //! -1 bad conditions ,  -2 bad model or null model
160   //! For type of object not recognized : should return 1
161   Standard_EXPORT virtual IFSelect_ReturnStatus TransferWriteTransient 
162                    (const Handle(Standard_Transient)& obj,
163                     const Handle(Transfer_FinderProcess)& FP,
164                     const Handle(Interface_InterfaceModel)& model,
165                     const Standard_Integer modetrans = 0,
166                     const Message_ProgressRange& theProgress = Message_ProgressRange()) const;
167   
168   //! Tells if a shape is valid for a transfer to a model
169   //! Asks the ActorWrite (through a ShapeMapper)
170   Standard_EXPORT virtual Standard_Boolean RecognizeWriteShape (const TopoDS_Shape& shape, const Standard_Integer modetrans = 0) const;
171   
172   //! Takes one Shape and transfers it to an
173   //! InterfaceModel (already created, e.g. by NewModel)
174   //! Default uses ActorWrite; can be redefined as necessary
175   //! Returned value is a status, as follows :
176   //! Done  OK ,  Void : No Result ,  Fail : Fail (e.g. exception)
177   //! Error : bad conditions , bad model or null model
178   Standard_EXPORT virtual IFSelect_ReturnStatus TransferWriteShape
179                    (const TopoDS_Shape& shape,
180                     const Handle(Transfer_FinderProcess)& FP,
181                     const Handle(Interface_InterfaceModel)& model,
182                     const Standard_Integer modetrans = 0,
183                     const Message_ProgressRange& theProgress = Message_ProgressRange()) const;
184   
185   //! Records a Session Item, to be added for customisation of the Work Session.
186   //! It must have a specific name.
187   //! <setapplied> is used if <item> is a GeneralModifier, to decide
188   //! If set to true, <item> will be applied to the hook list "send".
189   //! Else, it is not applied to any hook list.
190   //! Remark : this method is to be called at Create time,
191   //! the recorded items will be used by Customise
192   //! Warning : if <name> conflicts, the last recorded item is kept
193   Standard_EXPORT void AddSessionItem (const Handle(Standard_Transient)& theItem, const Standard_CString theName, const Standard_Boolean toApply = Standard_False);
194   
195   //! Returns an item given its name to record in a Session
196   //! If <name> is unknown, returns a Null Handle
197   Standard_EXPORT Handle(Standard_Transient) SessionItem (const Standard_CString theName) const;
198   
199   //! Customises a WorkSession, by adding to it the recorded items (by AddSessionItem)
200   Standard_EXPORT virtual void Customise (Handle(XSControl_WorkSession)& WS);
201   
202   const NCollection_DataMap<TCollection_AsciiString, Handle(Standard_Transient)> & AdaptorSession() const
203   { return myAdaptorSession; }
204
205   DEFINE_STANDARD_RTTIEXT(XSControl_Controller,Standard_Transient)
206
207  protected:
208   
209   //! Initializing with names
210   //! <theLongName>  is for the complete, official, long  name
211   //! <theShortName> is for the short name used for resources
212   Standard_EXPORT XSControl_Controller(const Standard_CString theLongName, const Standard_CString theShortName);
213
214   //! Records the name of a Static to be traced for a given use
215   Standard_EXPORT void TraceStatic (const Standard_CString theName, const Standard_Integer theUse);
216
217   TCollection_AsciiString myShortName;
218   TCollection_AsciiString myLongName;
219   Handle(IFSelect_WorkLibrary) myAdaptorLibrary;
220   Handle(Interface_Protocol) myAdaptorProtocol;
221   //szv:Handle(IFSelect_Signature) mySignType;
222   Handle(Transfer_ActorOfTransientProcess) myAdaptorRead;
223   Handle(Transfer_ActorOfFinderProcess) myAdaptorWrite;
224   NCollection_DataMap<TCollection_AsciiString, Handle(Standard_Transient)> myAdaptorSession;
225
226  private:
227
228   TColStd_SequenceOfTransient myAdaptorApplied;
229   NCollection_Vector<Handle(Standard_Transient)> myParams;
230   NCollection_Vector<Standard_Integer> myParamUses;
231   Handle(Interface_HArray1OfHAsciiString) myModeWriteShapeN;
232 };
233
234 #endif // _XSControl_Controller_HeaderFile