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