]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_Document.h
Salome HOME
Merge branch 'BR_H2018_2' of https://codev-tuleap.cea.fr/plugins/git/salome/hydro...
[modules/hydro.git] / src / HYDROData / HYDROData_Document.h
1 // Copyright (C) 2014-2015  EDF-R&D
2 // This library is free software; you can redistribute it and/or
3 // modify it under the terms of the GNU Lesser General Public
4 // License as published by the Free Software Foundation; either
5 // version 2.1 of the License, or (at your option) any later version.
6 //
7 // This library is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
10 // Lesser General Public License for more details.
11 //
12 // You should have received a copy of the GNU Lesser General Public
13 // License along with this library; if not, write to the Free Software
14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
15 //
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
17 //
18
19 #ifndef HYDROData_Document_HeaderFile
20 #define HYDROData_Document_HeaderFile
21
22 #include <HYDROData_Entity.h>
23 #include <TDocStd_Document.hxx>
24 #include <MMgt_TShared.hxx>
25
26 class HYDROData_InterpolatorsFactory;
27 class HYDROData_IProfilesInterpolator;
28 class HYDROData_StricklerTable;
29 class HYDROData_LandCoverMap;
30
31 class QFile;
32 class gp_Pnt2d;
33 class gp_Pnt;
34 class gp_XYZ;
35 class gp_XY;
36
37 /**
38  * Errors that could appear on document open/save actions.
39  * If there is no error, it is "OK".
40  */
41 enum Data_DocError {
42   DocError_OK = 0, ///< success
43   DocError_ResourcesProblem, ///< resources files are invalid or not found
44   DocError_CanNotOpen, ///< can not open file for reading or writing
45   DocError_InvalidVersion, ///< version of document is different than expected
46   DocError_InvalidFormat, ///< format of the document is bad
47   DocError_UnknownProblem ///< problem has unknown nature
48 };
49
50 /**\class HYDROData_Document
51  *
52  * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
53  *
54  * Document contains all data of the Study specific to this module.
55  * Also it provides acces to this data: open/save, transactions management etc.
56  * to provide access to all stored data.
57  */
58
59 class HYDROData_Document : public MMgt_TShared
60 {
61 public:
62   DEFINE_STANDARD_RTTIEXT(HYDROData_Document, MMgt_TShared);
63
64   //! Returns the existing document or creates new if it is not exist
65   HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(const int theStudyID);
66
67   //! Returns the document by object
68   HYDRODATA_EXPORT static Handle(HYDROData_Document) Document( 
69     const TDF_Label& theObjectLabel );
70
71 public:
72
73   //! Returns true if data model contains document for this study
74   HYDRODATA_EXPORT static bool HasDocument(const int theStudyID);
75
76   //! Get study id by document instance, if document doesn't exists return false
77   HYDRODATA_EXPORT static bool DocumentId( const Handle(HYDROData_Document)& theDocument,
78                                            int&                              theDocId );
79
80 public:
81
82   //! Loads the OCAF document from the file.
83   //! \param theFileName full name of the file to load
84   //! \param theStudyID identifier of the SALOME study to associate with loaded file
85   //! \returns error status (OK in case of success)
86   HYDRODATA_EXPORT static Data_DocError Load(const char* theFileName, const int theStudyID);
87
88   //! Saves the OCAF document to the file.
89   //! \param theFileName full name of the file to store
90   //! \returns error status (OK in case of success)
91   HYDRODATA_EXPORT Data_DocError Save(const char* theFileName);
92
93   //! Removes document data
94   HYDRODATA_EXPORT void Close();
95
96 public:
97
98   // Returns name of document instance in python dump script
99   HYDRODATA_EXPORT QString GetDocPyName() const;
100
101   //! Dump study document to Python script representation.
102   //! \param theFileName full name of the file to store
103   //! \returns true if document has been successfuly dumped
104   HYDRODATA_EXPORT bool DumpToPython( const QString& thePyScriptPath,
105                                       const bool     theIsMultiFile ) const;
106
107   //! Dump model data to Python script representation.
108   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
109                                                      MapOfTreatedObjects& theTreatedObjects,
110                                                      const bool           theIsMultiFile ) const;
111
112   HYDRODATA_EXPORT void CollectQGISValues( const QString& theAttrName,
113                                            QStringList& theAttrValues,
114                                            QStringList& theStricklerTypes ) const;
115
116 public:
117
118   // Methods to work with objects presentation.
119
120   //! Returns the order of objects presentation. Objects in returned sequence
121   //! are order from top to low depending on z-level parameter. Objects that
122   //! have no z-level parameter are located at the end of sequence and
123   //! sorted alphabetically.
124   //! Only the following types of objects considered:
125   //!   1. KIND_IMAGE
126   //!   2. KIND_IMMERSIBLE_ZONE
127   //!   3. KIND_CHANNEL
128   //!   4. KIND_RIVER
129   //!   5. KIND_STREAM
130   //!   6. KIND_OBSTACLE
131   //!   7. KIND_DIGUE
132   //!   8. KIND_POLYLINEXY
133   //!   9. KIND_ZONE
134   //! \param theIsAll if flag is true then all objects will be included,
135   //!                 otherwise only objects which have the z-level parameter
136   //! \returns ordered sequence of objects
137   HYDRODATA_EXPORT HYDROData_SequenceOfObjects GetObjectsLayerOrder( 
138     const Standard_Boolean theIsAll = Standard_True ) const;
139
140   //! Sets the order of objects presentation.
141   HYDRODATA_EXPORT void SetObjectsLayerOrder( const HYDROData_SequenceOfObjects& theOrder );
142
143   //! Show object at the top of other model objects. If the object
144   //! already has the z-level parameter then nothing will be done.
145   HYDRODATA_EXPORT void Show( const Handle(HYDROData_Entity)& theObject );
146
147   //! Show sequence of objects at the top of other model objects.
148   //! The objects from the sequence will be sorted alphabetically at first.
149   HYDRODATA_EXPORT void Show( const HYDROData_SequenceOfObjects& theObjects );
150
151   //! Removes the order of objects presentation.
152   HYDRODATA_EXPORT void RemoveObjectsLayerOrder();
153
154   HYDRODATA_EXPORT void GetLocalCS( double&, double& ) const;
155   HYDRODATA_EXPORT void SetLocalCS( double, double );
156   HYDRODATA_EXPORT void Transform( double& X, double& Y, bool IsToLocalCS ) const;
157   HYDRODATA_EXPORT void Transform( gp_Pnt& thePnt, bool IsToLocalCS ) const;
158   HYDRODATA_EXPORT void Transform( gp_XYZ& thePnt, bool IsToLocalCS ) const;
159   HYDRODATA_EXPORT void Transform( gp_XY& thePnt, bool IsToLocalCS ) const;
160   HYDRODATA_EXPORT void Transform( double& X, double& Y, double& Z, bool IsToLocalCS ) const;
161
162 public:
163
164   //! Starts a new operation (opens a tansaction)
165   HYDRODATA_EXPORT void StartOperation();
166   //! Finishes the previously started operation (closes the transaction)
167   HYDRODATA_EXPORT void CommitOperation(
168     const TCollection_ExtendedString& theName = TCollection_ExtendedString());
169   //! Aborts the operation 
170   HYDRODATA_EXPORT void AbortOperation();
171   //! Returns true if operation has been started, but not yet finished or aborted
172   HYDRODATA_EXPORT bool IsOperation();
173   //! Returns true if document was modified (since creation/opening)
174   HYDRODATA_EXPORT bool IsModified();
175
176 public:
177
178   //! Returns True if there are available Undos
179   HYDRODATA_EXPORT bool CanUndo();
180   //! Returns a list of stored undo actions
181   HYDRODATA_EXPORT const TDF_DeltaList& GetUndos();
182   //! Clears a list of stored undo actions
183   HYDRODATA_EXPORT void ClearUndos();
184   //! Undoes last operation
185   HYDRODATA_EXPORT void Undo();
186
187   //! Returns True if there are available Redos
188   HYDRODATA_EXPORT bool CanRedo();
189   //! Returns a list of stored undo actions
190   HYDRODATA_EXPORT const TDF_DeltaList& GetRedos();
191   //! Clears a list of stored undo actions
192   HYDRODATA_EXPORT void ClearRedos();
193   //! Redoes last operation
194   HYDRODATA_EXPORT void Redo();
195
196 public:
197
198   //! Creates and locates in the document a new object
199   //! \param theKind kind of the created object, can not be UNKNOWN
200   //! \returns the created object
201   HYDRODATA_EXPORT Handle(HYDROData_Entity) CreateObject(const ObjectKind theKind);
202
203
204   //! Find the data object with the specified name.
205   HYDRODATA_EXPORT Handle(HYDROData_Entity) FindObjectByName( 
206     const QString&   theName, 
207     const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
208
209   //! Find the data objects with the specified names.
210   HYDRODATA_EXPORT HYDROData_SequenceOfObjects FindObjectsByNames(
211     const QStringList& theNames, 
212     const ObjectKind   theObjectKind = KIND_UNKNOWN ) const;
213
214   //! Collect all data objects with given object type
215   HYDRODATA_EXPORT HYDROData_SequenceOfObjects CollectAllObjects(
216     const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
217
218 public:
219   
220   //! Returns interpolator factory instance
221   HYDRODATA_EXPORT HYDROData_InterpolatorsFactory* GetInterpolatorsFactory();
222
223   //! Get the appropriate interpolator by the name.
224   HYDRODATA_EXPORT HYDROData_IProfilesInterpolator* GetInterpolator( const TCollection_AsciiString& theName ) const;
225
226   //! Get list of registered interpolator names.
227   HYDRODATA_EXPORT NCollection_Sequence<TCollection_AsciiString> GetInterpolatorNames() const;
228
229 public:
230   //! Returns default strickler coefficient
231   HYDRODATA_EXPORT double GetDefaultStricklerCoefficient() const;
232
233   //! Sets default strickler coefficient
234   HYDRODATA_EXPORT void SetDefaultStricklerCoefficient( double ) const;
235
236   HYDRODATA_EXPORT int GetCountQuadtree() const;
237   HYDRODATA_EXPORT void SetCountQuadtree( int ) const;
238   HYDRODATA_EXPORT int GetCountDelaunay() const;
239   HYDRODATA_EXPORT void SetCountDelaunay( int ) const;
240
241   HYDRODATA_EXPORT QColor GetAssociatedColor( const QString& theStricklerType, const Handle(HYDROData_StricklerTable)& theTable ) const;
242
243 protected:
244   friend class HYDROData_Iterator;
245   friend class test_HYDROData_Document;
246
247   //! Creates new document: private because "Document" method must be used instead of direct creation.
248   HYDRODATA_EXPORT HYDROData_Document();
249   //! Creates new document by existing OCAF structure
250   HYDRODATA_EXPORT HYDROData_Document(const Handle(TDocStd_Document)& theDoc);
251   //! Deletes all high-level data, managed this document
252   HYDRODATA_EXPORT ~HYDROData_Document();
253
254   //! Returns the new identifier of the new object (may be used for correct ordering of objects)
255   HYDRODATA_EXPORT int NewID();
256
257   //! Returns the label where the objects are located (used by Iterator)
258   HYDRODATA_EXPORT TDF_Label LabelOfObjects();
259
260   HYDRODATA_EXPORT TDF_Label LabelOfLocalCS() const;
261
262 private:
263   
264   // Dump header Python part in to file \c theFile
265   bool DumpToPython( QFile&               theFile,
266                      MapOfTreatedObjects& theTreatedObjects ) const;
267
268   // Dump objects of type \c theObjectKind to file \c theFile
269   bool dumpPartitionToPython( QFile&               theFile,
270                               const QString&       thePyScriptPath,
271                               const bool           theIsMultiFile,
272                               MapOfTreatedObjects& theDumpedObjects,
273                               const ObjectKind&    theObjectKind ) const;
274   void UpdateLCSFields() const;
275
276 private:
277   Handle(TDocStd_Document) myDoc; ///< OCAF document instance corresponding for keeping all persistent data
278   int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
279   double myLX, myLY;
280
281   HYDROData_InterpolatorsFactory* myInterpolatorsFactory; ///< iterpolators factory
282 };
283
284 #endif