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.
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.
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
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #ifndef HYDROData_Document_HeaderFile
20 #define HYDROData_Document_HeaderFile
22 #include <HYDROData_Entity.h>
23 #include <TDocStd_Document.hxx>
25 class HYDROData_InterpolatorsFactory;
26 class HYDROData_IProfilesInterpolator;
27 class HYDROData_StricklerTable;
28 class HYDROData_LandCoverMap;
37 * Errors that could appear on document open/save actions.
38 * If there is no error, it is "OK".
41 DocError_OK = 0, ///< success
42 DocError_ResourcesProblem, ///< resources files are invalid or not found
43 DocError_CanNotOpen, ///< can not open file for reading or writing
44 DocError_InvalidVersion, ///< version of document is different than expected
45 DocError_InvalidFormat, ///< format of the document is bad
46 DocError_UnknownProblem ///< problem has unknown nature
49 /**\class HYDROData_Document
51 * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
53 * Document contains all data of the Study specific to this module.
54 * Also it provides acces to this data: open/save, transactions management etc.
55 * to provide access to all stored data.
58 class HYDROData_Document : public MMgt_TShared
61 DEFINE_STANDARD_RTTIEXT(HYDROData_Document, MMgt_TShared);
63 //! Returns the existing document or creates new if it is not exist
64 HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(const int theStudyID);
66 //! Returns the document by object
67 HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(
68 const TDF_Label& theObjectLabel );
72 //! Returns true if data model contains document for this study
73 HYDRODATA_EXPORT static bool HasDocument(const int theStudyID);
75 //! Get study id by document instance, if document doesn't exists return false
76 HYDRODATA_EXPORT static bool DocumentId( const Handle(HYDROData_Document)& theDocument,
81 //! Loads the OCAF document from the file.
82 //! \param theFileName full name of the file to load
83 //! \param theStudyID identifier of the SALOME study to associate with loaded file
84 //! \returns error status (OK in case of success)
85 HYDRODATA_EXPORT static Data_DocError Load(const char* theFileName, const int theStudyID);
87 //! Saves the OCAF document to the file.
88 //! \param theFileName full name of the file to store
89 //! \returns error status (OK in case of success)
90 HYDRODATA_EXPORT Data_DocError Save(const char* theFileName);
92 //! Removes document data
93 HYDRODATA_EXPORT void Close();
97 // Returns name of document instance in python dump script
98 HYDRODATA_EXPORT QString GetDocPyName() const;
100 //! Dump study document to Python script representation.
101 //! \param theFileName full name of the file to store
102 //! \returns true if document has been successfuly dumped
103 HYDRODATA_EXPORT bool DumpToPython( const QString& thePyScriptPath,
104 const bool theIsMultiFile ) const;
106 //! Dump model data to Python script representation.
107 HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
108 MapOfTreatedObjects& theTreatedObjects,
109 const bool theIsMultiFile ) const;
111 HYDRODATA_EXPORT void CollectQGISValues( const QString& theAttrName,
112 QStringList& theAttrValues,
113 QStringList& theStricklerTypes ) const;
117 // Methods to work with objects presentation.
119 //! Returns the order of objects presentation. Objects in returned sequence
120 //! are order from top to low depending on z-level parameter. Objects that
121 //! have no z-level parameter are located at the end of sequence and
122 //! sorted alphabetically.
123 //! Only the following types of objects considered:
125 //! 2. KIND_IMMERSIBLE_ZONE
131 //! 8. KIND_POLYLINEXY
133 //! \param theIsAll if flag is true then all objects will be included,
134 //! otherwise only objects which have the z-level parameter
135 //! \returns ordered sequence of objects
136 HYDRODATA_EXPORT HYDROData_SequenceOfObjects GetObjectsLayerOrder(
137 const Standard_Boolean theIsAll = Standard_True ) const;
139 //! Sets the order of objects presentation.
140 HYDRODATA_EXPORT void SetObjectsLayerOrder( const HYDROData_SequenceOfObjects& theOrder );
142 //! Show object at the top of other model objects. If the object
143 //! already has the z-level parameter then nothing will be done.
144 HYDRODATA_EXPORT void Show( const Handle(HYDROData_Entity)& theObject );
146 //! Show sequence of objects at the top of other model objects.
147 //! The objects from the sequence will be sorted alphabetically at first.
148 HYDRODATA_EXPORT void Show( const HYDROData_SequenceOfObjects& theObjects );
150 //! Removes the order of objects presentation.
151 HYDRODATA_EXPORT void RemoveObjectsLayerOrder();
153 HYDRODATA_EXPORT void GetLocalCS( double&, double& ) const;
154 HYDRODATA_EXPORT void SetLocalCS( double, double );
155 HYDRODATA_EXPORT void Transform( double& X, double& Y, bool IsToLocalCS ) const;
156 HYDRODATA_EXPORT void Transform( gp_Pnt& thePnt, bool IsToLocalCS ) const;
157 HYDRODATA_EXPORT void Transform( gp_XYZ& thePnt, bool IsToLocalCS ) const;
158 HYDRODATA_EXPORT void Transform( gp_XY& thePnt, bool IsToLocalCS ) const;
159 HYDRODATA_EXPORT void Transform( double& X, double& Y, double& Z, bool IsToLocalCS ) const;
163 //! Starts a new operation (opens a tansaction)
164 HYDRODATA_EXPORT void StartOperation();
165 //! Finishes the previously started operation (closes the transaction)
166 HYDRODATA_EXPORT void CommitOperation(
167 const TCollection_ExtendedString& theName = TCollection_ExtendedString());
168 //! Aborts the operation
169 HYDRODATA_EXPORT void AbortOperation();
170 //! Returns true if operation has been started, but not yet finished or aborted
171 HYDRODATA_EXPORT bool IsOperation();
172 //! Returns true if document was modified (since creation/opening)
173 HYDRODATA_EXPORT bool IsModified();
177 //! Returns True if there are available Undos
178 HYDRODATA_EXPORT bool CanUndo();
179 //! Returns a list of stored undo actions
180 HYDRODATA_EXPORT const TDF_DeltaList& GetUndos();
181 //! Clears a list of stored undo actions
182 HYDRODATA_EXPORT void ClearUndos();
183 //! Undoes last operation
184 HYDRODATA_EXPORT void Undo();
186 //! Returns True if there are available Redos
187 HYDRODATA_EXPORT bool CanRedo();
188 //! Returns a list of stored undo actions
189 HYDRODATA_EXPORT const TDF_DeltaList& GetRedos();
190 //! Clears a list of stored undo actions
191 HYDRODATA_EXPORT void ClearRedos();
192 //! Redoes last operation
193 HYDRODATA_EXPORT void Redo();
197 //! Creates and locates in the document a new object
198 //! \param theKind kind of the created object, can not be UNKNOWN
199 //! \returns the created object
200 HYDRODATA_EXPORT Handle(HYDROData_Entity) CreateObject(const ObjectKind theKind);
203 //! Find the data object with the specified name.
204 HYDRODATA_EXPORT Handle(HYDROData_Entity) FindObjectByName(
205 const QString& theName,
206 const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
208 //! Find the data objects with the specified names.
209 HYDRODATA_EXPORT HYDROData_SequenceOfObjects FindObjectsByNames(
210 const QStringList& theNames,
211 const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
215 //! Returns interpolator factory instance
216 HYDRODATA_EXPORT HYDROData_InterpolatorsFactory* GetInterpolatorsFactory();
218 //! Get the appropriate interpolator by the name.
219 HYDRODATA_EXPORT HYDROData_IProfilesInterpolator* GetInterpolator( const TCollection_AsciiString& theName ) const;
221 //! Get list of registered interpolator names.
222 HYDRODATA_EXPORT NCollection_Sequence<TCollection_AsciiString> GetInterpolatorNames() const;
225 //! Returns default strickler coefficient
226 HYDRODATA_EXPORT double GetDefaultStricklerCoefficient() const;
228 //! Sets default strickler coefficient
229 HYDRODATA_EXPORT void SetDefaultStricklerCoefficient( double ) const;
231 HYDRODATA_EXPORT int GetCountQuadtree() const;
232 HYDRODATA_EXPORT void SetCountQuadtree( int ) const;
233 HYDRODATA_EXPORT int GetCountDelaunay() const;
234 HYDRODATA_EXPORT void SetCountDelaunay( int ) const;
236 HYDRODATA_EXPORT QColor GetAssociatedColor( const QString& theStricklerType, const Handle(HYDROData_StricklerTable)& theTable ) const;
239 friend class HYDROData_Iterator;
240 friend class test_HYDROData_Document;
242 //! Creates new document: private because "Document" method must be used instead of direct creation.
243 HYDRODATA_EXPORT HYDROData_Document();
244 //! Creates new document by existing OCAF structure
245 HYDRODATA_EXPORT HYDROData_Document(const Handle(TDocStd_Document)& theDoc);
246 //! Deletes all high-level data, managed this document
247 HYDRODATA_EXPORT ~HYDROData_Document();
249 //! Returns the new identifier of the new object (may be used for correct ordering of objects)
250 HYDRODATA_EXPORT int NewID();
252 //! Returns the label where the objects are located (used by Iterator)
253 HYDRODATA_EXPORT TDF_Label LabelOfObjects();
255 HYDRODATA_EXPORT TDF_Label LabelOfLocalCS() const;
259 // Dump header Python part in to file \c theFile
260 bool DumpToPython( QFile& theFile,
261 MapOfTreatedObjects& theTreatedObjects ) const;
263 // Dump objects of type \c theObjectKind to file \c theFile
264 bool dumpPartitionToPython( QFile& theFile,
265 const QString& thePyScriptPath,
266 const bool theIsMultiFile,
267 MapOfTreatedObjects& theDumpedObjects,
268 const ObjectKind& theObjectKind ) const;
269 void UpdateLCSFields() const;
272 Handle(TDocStd_Document) myDoc; ///< OCAF document instance corresponding for keeping all persistent data
273 int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
276 HYDROData_InterpolatorsFactory* myInterpolatorsFactory; ///< iterpolators factory