0027460: Data Exchange - restore method XSControl_WorkSession::MapReader()
[occt.git] / src / XSControl / XSControl_WorkSession.hxx
1 // Created on: 1995-06-01
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_WorkSession_HeaderFile
18 #define _XSControl_WorkSession_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <IFSelect_WorkSession.hxx>
24 #include <IFSelect_ReturnStatus.hxx>
25 #include <XSControl_TransferWriter.hxx>
26 class XSControl_Controller;
27 class XSControl_TransferReader;
28 class Dico_DictionaryOfTransient;
29 class XSControl_Vars;
30 class Message_Messenger;
31 class Transfer_TransientProcess;
32 class Standard_Transient;
33 class Interface_InterfaceModel;
34 class Transfer_FinderProcess;
35 class TopoDS_Shape;
36 class Interface_CheckIterator;
37
38
39 class XSControl_WorkSession;
40 DEFINE_STANDARD_HANDLE(XSControl_WorkSession, IFSelect_WorkSession)
41
42 //! This WorkSession completes the basic one, by adding :
43 //! - use of Controller, with norm selection...
44 //! - management of transfers (both ways) with auxiliary classes
45 //! TransferReader and TransferWriter
46 //! -> these transfers may work with a Context List : its items
47 //! are given by the user, according to the transfer to be
48 //! i.e. it is interpreted by the Actors
49 //! Each item is accessed by a Name
50 class XSControl_WorkSession : public IFSelect_WorkSession
51 {
52  public:
53   
54   Standard_EXPORT XSControl_WorkSession();
55   
56   ~XSControl_WorkSession()
57   { ClearBinders(); }
58
59   //! In addition to basic ClearData, clears Transfer and Management
60   //! for interactive use, for mode = 0,1,2 and over 4
61   //! Plus : mode = 5 to clear Transfers (both ways) only
62   //! mode = 6 to clear enforced results
63   //! mode = 7 to clear transfers, results
64   Standard_EXPORT virtual void ClearData (const Standard_Integer theMode) Standard_OVERRIDE;
65   
66   //! Selects a Norm defined by its name.
67   //! A Norm is described and handled by a Controller
68   //! Returns True if done, False if <normname> is unknown
69   //!
70   //! The current Profile for this Norm is taken.
71   Standard_EXPORT Standard_Boolean SelectNorm (const Standard_CString theNormName);
72   
73   //! Selects a Norm defined by its Controller itself
74   Standard_EXPORT void SetController (const Handle(XSControl_Controller)& theCtl);
75   
76   //! Returns the name of the last Selected Norm. If none is
77   //! defined, returns an empty string
78   //! By default, returns the complete name of the norm
79   //! If <rsc> is True, returns the short name used for resource
80   Standard_EXPORT Standard_CString SelectedNorm (const Standard_Boolean theRsc = Standard_False) const;
81   
82   //! Returns the norm controller itself
83   const Handle(XSControl_Controller) & NormAdaptor() const
84   { return myController; }
85   
86   //! Returns the current Context List, Null if not defined
87   //! The Context is given to the TransientProcess for TransferRead
88   const Handle(Dico_DictionaryOfTransient) & Context() const
89   { return myContext; }
90   
91   //! Sets the current Context List, as a whole
92   //! Sets it to the TransferReader
93   Standard_EXPORT void SetAllContext (const Handle(Dico_DictionaryOfTransient)& theContext);
94   
95   //! Clears the whole current Context (nullifies it)
96   Standard_EXPORT void ClearContext();
97   
98   //! Prints the transfer status of a transferred item, as beeing
99   //! the Mapped n0 <num>, from MapWriter if <wri> is True, or
100   //! from MapReader if <wri> is False
101   //! Returns True when done, False else (i.e. num out of range)
102   Standard_EXPORT Standard_Boolean PrintTransferStatus (const Standard_Integer theNum, const Standard_Boolean theWri, const Handle(Message_Messenger)& theS) const;
103   
104   //! Sets a Transfer Reader, by internal ways, according mode :
105   //! 0 recreates it clear,  1 clears it (does not recreate)
106   //! 2 aligns Roots of TransientProcess from final Results
107   //! 3 aligns final Results from Roots of TransientProcess
108   //! 4 begins a new transfer (by BeginTransfer)
109   //! 5 recreates TransferReader then begins a new transfer
110   Standard_EXPORT void InitTransferReader (const Standard_Integer theMode);
111   
112   //! Sets a Transfer Reader, which manages transfers on reading
113   Standard_EXPORT void SetTransferReader (const Handle(XSControl_TransferReader)& theTR);
114   
115   //! Returns the Transfer Reader, Null if not set
116   const Handle(XSControl_TransferReader) & TransferReader () const
117   { return myTransferReader; }
118
119   //! Returns the TransientProcess(internal data for TransferReader)
120   Standard_EXPORT Handle(Transfer_TransientProcess) MapReader() const;
121
122   //! Changes the Map Reader, i.e. considers that the new one
123   //! defines the relevant read results (forgets the former ones)
124   //! Returns True when done, False in case of bad definition, i.e.
125   //! if Model from TP differs from that of Session
126   Standard_EXPORT Standard_Boolean SetMapReader (const Handle(Transfer_TransientProcess)& theTP);
127   
128   //! Returns the result attached to a starting entity
129   //! If <mode> = 0, returns Final Result
130   //! If <mode> = 1, considers Last Result
131   //! If <mode> = 2, considers Final, else if absent, Last
132   //! returns it as Transient, if result is not transient returns
133   //! the Binder
134   //! <mode> = 10,11,12 idem but returns the Binder itself
135   //! (if it is not, e.g. Shape, returns the Binder)
136   //! <mode> = 20, returns the ResultFromModel
137   Standard_EXPORT Handle(Standard_Transient) Result (const Handle(Standard_Transient)& theEnt, const Standard_Integer theMode) const;
138   
139   //! Commands the transfer of, either one entity, or a list
140   //! I.E. calls the TransferReader after having analysed <ents>
141   //! It is cumulated from the last BeginTransfer
142   //! <ents> is processed by GiveList, hence :
143   //! - <ents> a Selection : its SelectionResult
144   //! - <ents> a HSequenceOfTransient : this list
145   //! - <ents> the Model : in this specific case, all the roots,
146   //! with no cumulation of former transfers (TransferReadRoots)
147   Standard_EXPORT Standard_Integer TransferReadOne (const Handle(Standard_Transient)& theEnts);
148   
149   //! Commands the transfer of all the root entities of the model
150   //! i.e. calls TransferRoot from the TransferReader with the Graph
151   //! No cumulation with former calls to TransferReadOne
152   Standard_EXPORT Standard_Integer TransferReadRoots();
153   
154   //! produces and returns a new Model well conditionned
155   //! It is produced by the Norm Controller
156   //! It can be Null (if this function is not implemented)
157   Standard_EXPORT Handle(Interface_InterfaceModel) NewModel();
158   
159   //! Returns the Transfer Reader, Null if not set
160   const Handle(XSControl_TransferWriter) & TransferWriter() const
161   { return myTransferWriter; }
162   
163   //! Changes the Map Reader, i.e. considers that the new one
164   //! defines the relevant read results (forgets the former ones)
165   //! Returns True when done, False if <FP> is Null
166   Standard_Boolean SetMapWriter (const Handle(Transfer_FinderProcess)& theFP)
167   {
168     if (theFP.IsNull()) return Standard_False;
169     myTransferWriter->SetFinderProcess(theFP);
170     return Standard_True;
171   }
172   
173   //! Transfers a Shape from CasCade to a model of current norm,
174   //! according to the last call to SetModeWriteShape
175   //! Returns status :Done if OK, Fail if error during transfer,
176   //! Error if transfer badly initialised
177   Standard_EXPORT IFSelect_ReturnStatus TransferWriteShape (const TopoDS_Shape& theShape, const Standard_Boolean theCompGraph = Standard_True);
178   
179   //! Returns the check-list of last transfer (write)
180   //! It is recorded in the FinderProcess, but it must be bound with
181   //! resulting entities (in the resulting file model) rather than
182   //! with original objects (in fact, their mappers)
183   Standard_EXPORT Interface_CheckIterator TransferWriteCheckList() const;
184   
185   const Handle(XSControl_Vars) & Vars() const
186   { return myVars; }
187   
188   void SetVars (const Handle(XSControl_Vars)& theVars)
189   { myVars = theVars; }
190   
191   DEFINE_STANDARD_RTTIEXT(XSControl_WorkSession,IFSelect_WorkSession)
192
193  private:
194   
195   //! Clears binders
196   Standard_EXPORT void ClearBinders();
197
198   Handle(XSControl_Controller) myController;
199   Handle(XSControl_TransferReader) myTransferReader;
200   Handle(XSControl_TransferWriter) myTransferWriter;
201   Handle(Dico_DictionaryOfTransient) myContext;
202   Handle(XSControl_Vars) myVars;
203 };
204
205 #endif // _XSControl_WorkSession_HeaderFile