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;
35 * Errors that could appear on document open/save actions.
36 * If there is no error, it is "OK".
39 DocError_OK = 0, ///< success
40 DocError_ResourcesProblem, ///< resources files are invalid or not found
41 DocError_CanNotOpen, ///< can not open file for reading or writing
42 DocError_InvalidVersion, ///< version of document is different than expected
43 DocError_InvalidFormat, ///< format of the document is bad
44 DocError_UnknownProblem ///< problem has unknown nature
47 DEFINE_STANDARD_HANDLE(HYDROData_Document, MMgt_TShared)
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
62 DEFINE_STANDARD_RTTI(HYDROData_Document);
64 //! Returns the existing document or creates new if it is not exist
65 HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(const int theStudyID);
67 //! Returns the document by object
68 HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(
69 const TDF_Label& theObjectLabel );
73 //! Returns true if data model contains document for this study
74 HYDRODATA_EXPORT static bool HasDocument(const int theStudyID);
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,
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);
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);
93 //! Removes document data
94 HYDRODATA_EXPORT void Close();
98 // Returns name of document instance in python dump script
99 HYDRODATA_EXPORT QString GetDocPyName() const;
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& theFileName,
105 const bool theIsMultiFile ) const;
107 //! Dump model data to Python script representation.
108 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects,
109 const bool theIsMultiFile ) const;
113 // Methods to work with objects presentation.
115 //! Returns the order of objects presentation. Objects in returned sequence
116 //! are order from top to low depending on z-level parameter. Objects that
117 //! have no z-level parameter are located at the end of sequence and
118 //! sorted alphabetically.
119 //! Only the following types of objects considered:
121 //! 2. KIND_IMMERSIBLE_ZONE
127 //! 8. KIND_POLYLINEXY
129 //! \param theIsAll if flag is true then all objects will be included,
130 //! otherwise only objects which have the z-level parameter
131 //! \returns ordered sequence of objects
132 HYDRODATA_EXPORT HYDROData_SequenceOfObjects GetObjectsLayerOrder(
133 const Standard_Boolean theIsAll = Standard_True ) const;
135 //! Sets the order of objects presentation.
136 HYDRODATA_EXPORT void SetObjectsLayerOrder( const HYDROData_SequenceOfObjects& theOrder );
138 //! Show object at the top of other model objects. If the object
139 //! already has the z-level parameter then nothing will be done.
140 HYDRODATA_EXPORT void Show( const Handle_HYDROData_Entity& theObject );
142 //! Show sequence of objects at the top of other model objects.
143 //! The objects from the sequence will be sorted alphabetically at first.
144 HYDRODATA_EXPORT void Show( const HYDROData_SequenceOfObjects& theObjects );
146 //! Removes the order of objects presentation.
147 HYDRODATA_EXPORT void RemoveObjectsLayerOrder();
149 HYDRODATA_EXPORT void GetLocalCS( double&, double& ) const;
150 HYDRODATA_EXPORT void SetLocalCS( double, double );
151 HYDRODATA_EXPORT void Transform( double& X, double& Y, bool IsToLocalCS ) const;
152 HYDRODATA_EXPORT void Transform( gp_Pnt& thePnt, bool IsToLocalCS ) const;
153 HYDRODATA_EXPORT void Transform( gp_XYZ& thePnt, bool IsToLocalCS ) const;
154 HYDRODATA_EXPORT void Transform( gp_XY& thePnt, bool IsToLocalCS ) const;
158 //! Starts a new operation (opens a tansaction)
159 HYDRODATA_EXPORT void StartOperation();
160 //! Finishes the previously started operation (closes the transaction)
161 HYDRODATA_EXPORT void CommitOperation(
162 const TCollection_ExtendedString& theName = TCollection_ExtendedString());
163 //! Aborts the operation
164 HYDRODATA_EXPORT void AbortOperation();
165 //! Returns true if operation has been started, but not yet finished or aborted
166 HYDRODATA_EXPORT bool IsOperation();
167 //! Returns true if document was modified (since creation/opening)
168 HYDRODATA_EXPORT bool IsModified();
172 //! Returns True if there are available Undos
173 HYDRODATA_EXPORT bool CanUndo();
174 //! Returns a list of stored undo actions
175 HYDRODATA_EXPORT const TDF_DeltaList& GetUndos();
176 //! Clears a list of stored undo actions
177 HYDRODATA_EXPORT void ClearUndos();
178 //! Undoes last operation
179 HYDRODATA_EXPORT void Undo();
181 //! Returns True if there are available Redos
182 HYDRODATA_EXPORT bool CanRedo();
183 //! Returns a list of stored undo actions
184 HYDRODATA_EXPORT const TDF_DeltaList& GetRedos();
185 //! Clears a list of stored undo actions
186 HYDRODATA_EXPORT void ClearRedos();
187 //! Redoes last operation
188 HYDRODATA_EXPORT void Redo();
192 //! Creates and locates in the document a new object
193 //! \param theKind kind of the created object, can not be UNKNOWN
194 //! \returns the created object
195 HYDRODATA_EXPORT Handle(HYDROData_Entity) CreateObject(const ObjectKind theKind);
198 //! Find the data object with the specified name.
199 HYDRODATA_EXPORT Handle(HYDROData_Entity) FindObjectByName(
200 const QString& theName,
201 const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
203 //! Find the data objects with the specified names.
204 HYDRODATA_EXPORT HYDROData_SequenceOfObjects FindObjectsByNames(
205 const QStringList& theNames,
206 const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
210 //! Returns interpolator factory instance
211 HYDRODATA_EXPORT HYDROData_InterpolatorsFactory* GetInterpolatorsFactory();
213 //! Get the appropriate interpolator by the name.
214 HYDRODATA_EXPORT HYDROData_IProfilesInterpolator* GetInterpolator( const TCollection_AsciiString& theName ) const;
216 //! Get list of registered interpolator names.
217 HYDRODATA_EXPORT NCollection_Sequence<TCollection_AsciiString> GetInterpolatorNames() const;
220 //! Returns default strickler coefficient
221 HYDRODATA_EXPORT double GetDefaultStricklerCoefficient() const;
223 //! Sets default strickler coefficient
224 HYDRODATA_EXPORT void SetDefaultStricklerCoefficient( double ) const;
227 friend class HYDROData_Iterator;
228 friend class test_HYDROData_Document;
230 //! Creates new document: private because "Document" method must be used instead of direct creation.
231 HYDRODATA_EXPORT HYDROData_Document();
232 //! Creates new document by existing OCAF structure
233 HYDRODATA_EXPORT HYDROData_Document(const Handle(TDocStd_Document)& theDoc);
234 //! Deletes all high-level data, managed this document
235 HYDRODATA_EXPORT ~HYDROData_Document();
237 //! Returns the new identifier of the new object (may be used for correct ordering of objects)
238 HYDRODATA_EXPORT int NewID();
240 //! Returns the label where the objects are located (used by Iterator)
241 HYDRODATA_EXPORT TDF_Label LabelOfObjects();
243 HYDRODATA_EXPORT TDF_Label LabelOfLocalCS() const;
247 // Dump header Python part in to file \c theFile
248 bool DumpToPython( QFile& theFile,
249 MapOfTreatedObjects& theTreatedObjects ) const;
251 // Dump objects of type \c theObjectKind to file \c theFile
252 bool dumpPartitionToPython( QFile& theFile,
253 const bool theIsMultiFile,
254 MapOfTreatedObjects& theDumpedObjects,
255 const ObjectKind& theObjectKind ) const;
256 void UpdateLCSFields() const;
259 Handle(TDocStd_Document) myDoc; ///< OCAF document instance corresponding for keeping all persistent data
260 int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
263 HYDROData_InterpolatorsFactory* myInterpolatorsFactory; ///< iterpolators factory