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 Handle(HYDROData_StricklerTable);
28 class Handle(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 DEFINE_STANDARD_HANDLE(HYDROData_Document, MMgt_TShared)
51 /**\class HYDROData_Document
53 * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
55 * Document contains all data of the Study specific to this module.
56 * Also it provides acces to this data: open/save, transactions management etc.
57 * to provide access to all stored data.
60 class HYDROData_Document : public MMgt_TShared
64 DEFINE_STANDARD_RTTI(HYDROData_Document);
66 //! Returns the existing document or creates new if it is not exist
67 HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(const int theStudyID);
69 //! Returns the document by object
70 HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(
71 const TDF_Label& theObjectLabel );
75 //! Returns true if data model contains document for this study
76 HYDRODATA_EXPORT static bool HasDocument(const int theStudyID);
78 //! Get study id by document instance, if document doesn't exists return false
79 HYDRODATA_EXPORT static bool DocumentId( const Handle(HYDROData_Document)& theDocument,
84 //! Loads the OCAF document from the file.
85 //! \param theFileName full name of the file to load
86 //! \param theStudyID identifier of the SALOME study to associate with loaded file
87 //! \returns error status (OK in case of success)
88 HYDRODATA_EXPORT static Data_DocError Load(const char* theFileName, const int theStudyID);
90 //! Saves the OCAF document to the file.
91 //! \param theFileName full name of the file to store
92 //! \returns error status (OK in case of success)
93 HYDRODATA_EXPORT Data_DocError Save(const char* theFileName);
95 //! Removes document data
96 HYDRODATA_EXPORT void Close();
100 // Returns name of document instance in python dump script
101 HYDRODATA_EXPORT QString GetDocPyName() const;
103 //! Dump study document to Python script representation.
104 //! \param theFileName full name of the file to store
105 //! \returns true if document has been successfuly dumped
106 HYDRODATA_EXPORT bool DumpToPython( const QString& theFileName,
107 const bool theIsMultiFile ) const;
109 //! Dump model data to Python script representation.
110 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects,
111 const bool theIsMultiFile ) const;
115 // Methods to work with objects presentation.
117 //! Returns the order of objects presentation. Objects in returned sequence
118 //! are order from top to low depending on z-level parameter. Objects that
119 //! have no z-level parameter are located at the end of sequence and
120 //! sorted alphabetically.
121 //! Only the following types of objects considered:
123 //! 2. KIND_IMMERSIBLE_ZONE
129 //! 8. KIND_POLYLINEXY
131 //! \param theIsAll if flag is true then all objects will be included,
132 //! otherwise only objects which have the z-level parameter
133 //! \returns ordered sequence of objects
134 HYDRODATA_EXPORT HYDROData_SequenceOfObjects GetObjectsLayerOrder(
135 const Standard_Boolean theIsAll = Standard_True ) const;
137 //! Sets the order of objects presentation.
138 HYDRODATA_EXPORT void SetObjectsLayerOrder( const HYDROData_SequenceOfObjects& theOrder );
140 //! Show object at the top of other model objects. If the object
141 //! already has the z-level parameter then nothing will be done.
142 HYDRODATA_EXPORT void Show( const Handle_HYDROData_Entity& theObject );
144 //! Show sequence of objects at the top of other model objects.
145 //! The objects from the sequence will be sorted alphabetically at first.
146 HYDRODATA_EXPORT void Show( const HYDROData_SequenceOfObjects& theObjects );
148 //! Removes the order of objects presentation.
149 HYDRODATA_EXPORT void RemoveObjectsLayerOrder();
151 HYDRODATA_EXPORT void GetLocalCS( double&, double& ) const;
152 HYDRODATA_EXPORT void SetLocalCS( double, double );
153 HYDRODATA_EXPORT void Transform( double& X, double& Y, bool IsToLocalCS ) const;
154 HYDRODATA_EXPORT void Transform( gp_Pnt& thePnt, bool IsToLocalCS ) const;
155 HYDRODATA_EXPORT void Transform( gp_XYZ& thePnt, bool IsToLocalCS ) const;
156 HYDRODATA_EXPORT void Transform( gp_XY& thePnt, bool IsToLocalCS ) const;
160 //! Starts a new operation (opens a tansaction)
161 HYDRODATA_EXPORT void StartOperation();
162 //! Finishes the previously started operation (closes the transaction)
163 HYDRODATA_EXPORT void CommitOperation(
164 const TCollection_ExtendedString& theName = TCollection_ExtendedString());
165 //! Aborts the operation
166 HYDRODATA_EXPORT void AbortOperation();
167 //! Returns true if operation has been started, but not yet finished or aborted
168 HYDRODATA_EXPORT bool IsOperation();
169 //! Returns true if document was modified (since creation/opening)
170 HYDRODATA_EXPORT bool IsModified();
174 //! Returns True if there are available Undos
175 HYDRODATA_EXPORT bool CanUndo();
176 //! Returns a list of stored undo actions
177 HYDRODATA_EXPORT const TDF_DeltaList& GetUndos();
178 //! Clears a list of stored undo actions
179 HYDRODATA_EXPORT void ClearUndos();
180 //! Undoes last operation
181 HYDRODATA_EXPORT void Undo();
183 //! Returns True if there are available Redos
184 HYDRODATA_EXPORT bool CanRedo();
185 //! Returns a list of stored undo actions
186 HYDRODATA_EXPORT const TDF_DeltaList& GetRedos();
187 //! Clears a list of stored undo actions
188 HYDRODATA_EXPORT void ClearRedos();
189 //! Redoes last operation
190 HYDRODATA_EXPORT void Redo();
194 //! Creates and locates in the document a new object
195 //! \param theKind kind of the created object, can not be UNKNOWN
196 //! \returns the created object
197 HYDRODATA_EXPORT Handle(HYDROData_Entity) CreateObject(const ObjectKind theKind);
200 //! Find the data object with the specified name.
201 HYDRODATA_EXPORT Handle(HYDROData_Entity) FindObjectByName(
202 const QString& theName,
203 const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
205 //! Find the data objects with the specified names.
206 HYDRODATA_EXPORT HYDROData_SequenceOfObjects FindObjectsByNames(
207 const QStringList& theNames,
208 const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
212 //! Returns interpolator factory instance
213 HYDRODATA_EXPORT HYDROData_InterpolatorsFactory* GetInterpolatorsFactory();
215 //! Get the appropriate interpolator by the name.
216 HYDRODATA_EXPORT HYDROData_IProfilesInterpolator* GetInterpolator( const TCollection_AsciiString& theName ) const;
218 //! Get list of registered interpolator names.
219 HYDRODATA_EXPORT NCollection_Sequence<TCollection_AsciiString> GetInterpolatorNames() const;
222 //! Returns default strickler coefficient
223 HYDRODATA_EXPORT double GetDefaultStricklerCoefficient() const;
225 //! Sets default strickler coefficient
226 HYDRODATA_EXPORT void SetDefaultStricklerCoefficient( double ) const;
228 HYDRODATA_EXPORT QColor HYDROData_Document::GetAssociatedColor(const QString& theStricklerType,
229 const Handle(HYDROData_StricklerTable)& theTable);
232 friend class HYDROData_Iterator;
233 friend class test_HYDROData_Document;
235 //! Creates new document: private because "Document" method must be used instead of direct creation.
236 HYDRODATA_EXPORT HYDROData_Document();
237 //! Creates new document by existing OCAF structure
238 HYDRODATA_EXPORT HYDROData_Document(const Handle(TDocStd_Document)& theDoc);
239 //! Deletes all high-level data, managed this document
240 HYDRODATA_EXPORT ~HYDROData_Document();
242 //! Returns the new identifier of the new object (may be used for correct ordering of objects)
243 HYDRODATA_EXPORT int NewID();
245 //! Returns the label where the objects are located (used by Iterator)
246 HYDRODATA_EXPORT TDF_Label LabelOfObjects();
248 HYDRODATA_EXPORT TDF_Label LabelOfLocalCS() const;
252 // Dump header Python part in to file \c theFile
253 bool DumpToPython( QFile& theFile,
254 MapOfTreatedObjects& theTreatedObjects ) const;
256 // Dump objects of type \c theObjectKind to file \c theFile
257 bool dumpPartitionToPython( QFile& theFile,
258 const bool theIsMultiFile,
259 MapOfTreatedObjects& theDumpedObjects,
260 const ObjectKind& theObjectKind ) const;
261 void UpdateLCSFields() const;
264 Handle(TDocStd_Document) myDoc; ///< OCAF document instance corresponding for keeping all persistent data
265 int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
268 HYDROData_InterpolatorsFactory* myInterpolatorsFactory; ///< iterpolators factory