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>
24 #include <TDocStd_Document.hxx>
26 class HYDROData_InterpolatorsFactory;
27 class HYDROData_IProfilesInterpolator;
36 * Errors that could appear on document open/save actions.
37 * If there is no error, it is "OK".
40 DocError_OK = 0, ///< success
41 DocError_ResourcesProblem, ///< resources files are invalid or not found
42 DocError_CanNotOpen, ///< can not open file for reading or writing
43 DocError_InvalidVersion, ///< version of document is different than expected
44 DocError_InvalidFormat, ///< format of the document is bad
45 DocError_UnknownProblem ///< problem has unknown nature
48 DEFINE_STANDARD_HANDLE(HYDROData_Document, MMgt_TShared)
50 /**\class HYDROData_Document
52 * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
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.
59 class HYDROData_Document : public MMgt_TShared
63 DEFINE_STANDARD_RTTI(HYDROData_Document);
65 //! Returns the existing document or creates new if it is not exist
66 HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(const int theStudyID);
68 //! Returns the document by object
69 HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(
70 const TDF_Label& theObjectLabel );
74 //! Returns true if data model contains document for this study
75 HYDRODATA_EXPORT static bool HasDocument(const int theStudyID);
77 //! Get study id by document instance, if document doesn't exists return false
78 HYDRODATA_EXPORT static bool DocumentId( const Handle(HYDROData_Document)& theDocument,
83 //! Loads the OCAF document from the file.
84 //! \param theFileName full name of the file to load
85 //! \param theStudyID identifier of the SALOME study to associate with loaded file
86 //! \returns error status (OK in case of success)
87 HYDRODATA_EXPORT static Data_DocError Load(const char* theFileName, const int theStudyID);
89 //! Saves the OCAF document to the file.
90 //! \param theFileName full name of the file to store
91 //! \returns error status (OK in case of success)
92 HYDRODATA_EXPORT Data_DocError Save(const char* theFileName);
94 //! Removes document data
95 HYDRODATA_EXPORT void Close();
99 // Returns name of document instance in python dump script
100 HYDRODATA_EXPORT QString GetDocPyName() const;
102 //! Dump study document to Python script representation.
103 //! \param theFileName full name of the file to store
104 //! \returns true if document has been successfuly dumped
105 HYDRODATA_EXPORT bool DumpToPython( const QString& theFileName,
106 const bool theIsMultiFile ) const;
108 //! Dump model data to Python script representation.
109 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects,
110 const bool theIsMultiFile ) const;
114 // Methods to work with objects presentation.
116 //! Returns the order of objects presentation. Objects in returned sequence
117 //! are order from top to low depending on z-level parameter. Objects that
118 //! have no z-level parameter are located at the end of sequence and
119 //! sorted alphabetically.
120 //! Only the following types of objects considered:
122 //! 2. KIND_IMMERSIBLE_ZONE
128 //! 8. KIND_POLYLINEXY
130 //! \param theIsAll if flag is true then all objects will be included,
131 //! otherwise only objects which have the z-level parameter
132 //! \returns ordered sequence of objects
133 HYDRODATA_EXPORT HYDROData_SequenceOfObjects GetObjectsLayerOrder(
134 const Standard_Boolean theIsAll = Standard_True ) const;
136 //! Sets the order of objects presentation.
137 HYDRODATA_EXPORT void SetObjectsLayerOrder( const HYDROData_SequenceOfObjects& theOrder );
139 //! Show object at the top of other model objects. If the object
140 //! already has the z-level parameter then nothing will be done.
141 HYDRODATA_EXPORT void Show( const Handle_HYDROData_Entity& theObject );
143 //! Show sequence of objects at the top of other model objects.
144 //! The objects from the sequence will be sorted alphabetically at first.
145 HYDRODATA_EXPORT void Show( const HYDROData_SequenceOfObjects& theObjects );
147 //! Removes the order of objects presentation.
148 HYDRODATA_EXPORT void RemoveObjectsLayerOrder();
150 HYDRODATA_EXPORT void GetLocalCS( double&, double& ) const;
151 HYDRODATA_EXPORT void SetLocalCS( double, double );
152 HYDRODATA_EXPORT void Transform( double& X, double& Y, bool IsToLocalCS ) const;
153 HYDRODATA_EXPORT void Transform( gp_Pnt& thePnt, bool IsToLocalCS ) const;
154 HYDRODATA_EXPORT void Transform( gp_XYZ& thePnt, bool IsToLocalCS ) const;
155 HYDRODATA_EXPORT void Transform( gp_XY& thePnt, bool IsToLocalCS ) const;
159 //! Starts a new operation (opens a tansaction)
160 HYDRODATA_EXPORT void StartOperation();
161 //! Finishes the previously started operation (closes the transaction)
162 HYDRODATA_EXPORT void CommitOperation(
163 const TCollection_ExtendedString& theName = TCollection_ExtendedString());
164 //! Aborts the operation
165 HYDRODATA_EXPORT void AbortOperation();
166 //! Returns true if operation has been started, but not yet finished or aborted
167 HYDRODATA_EXPORT bool IsOperation();
168 //! Returns true if document was modified (since creation/opening)
169 HYDRODATA_EXPORT bool IsModified();
173 //! Returns True if there are available Undos
174 HYDRODATA_EXPORT bool CanUndo();
175 //! Returns a list of stored undo actions
176 HYDRODATA_EXPORT const TDF_DeltaList& GetUndos();
177 //! Clears a list of stored undo actions
178 HYDRODATA_EXPORT void ClearUndos();
179 //! Undoes last operation
180 HYDRODATA_EXPORT void Undo();
182 //! Returns True if there are available Redos
183 HYDRODATA_EXPORT bool CanRedo();
184 //! Returns a list of stored undo actions
185 HYDRODATA_EXPORT const TDF_DeltaList& GetRedos();
186 //! Clears a list of stored undo actions
187 HYDRODATA_EXPORT void ClearRedos();
188 //! Redoes last operation
189 HYDRODATA_EXPORT void Redo();
193 //! Creates and locates in the document a new object
194 //! \param theKind kind of the created object, can not be UNKNOWN
195 //! \returns the created object
196 HYDRODATA_EXPORT Handle(HYDROData_Entity) CreateObject(const ObjectKind theKind);
199 //! Find the data object with the specified name.
200 HYDRODATA_EXPORT Handle(HYDROData_Entity) FindObjectByName(
201 const QString& theName,
202 const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
204 //! Find the data objects with the specified names.
205 HYDRODATA_EXPORT HYDROData_SequenceOfObjects FindObjectsByNames(
206 const QStringList& theNames,
207 const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
211 //! Returns interpolator factory instance
212 HYDRODATA_EXPORT HYDROData_InterpolatorsFactory* GetInterpolatorsFactory();
214 //! Get the appropriate interpolator by the name.
215 HYDRODATA_EXPORT HYDROData_IProfilesInterpolator* GetInterpolator( const TCollection_AsciiString& theName ) const;
217 //! Get list of registered interpolator names.
218 HYDRODATA_EXPORT NCollection_Sequence<TCollection_AsciiString> GetInterpolatorNames() const;
222 friend class HYDROData_Iterator;
223 friend class test_HYDROData_Document;
225 //! Creates new document: private because "Document" method must be used instead of direct creation.
226 HYDRODATA_EXPORT HYDROData_Document();
227 //! Creates new document by existing OCAF structure
228 HYDRODATA_EXPORT HYDROData_Document(const Handle(TDocStd_Document)& theDoc);
229 //! Deletes all high-level data, managed this document
230 HYDRODATA_EXPORT ~HYDROData_Document();
232 //! Returns the new identifier of the new object (may be used for correct ordering of objects)
233 HYDRODATA_EXPORT int NewID();
235 //! Returns the label where the objects are located (used by Iterator)
236 HYDRODATA_EXPORT TDF_Label LabelOfObjects();
238 HYDRODATA_EXPORT TDF_Label LabelOfLocalCS() const;
242 // Dump header Python part in to file \c theFile
243 bool DumpToPython( QFile& theFile,
244 MapOfTreatedObjects& theTreatedObjects ) const;
246 // Dump objects of type \c theObjectKind to file \c theFile
247 bool dumpPartitionToPython( QFile& theFile,
248 const bool theIsMultiFile,
249 MapOfTreatedObjects& theDumpedObjects,
250 const ObjectKind& theObjectKind ) const;
251 void UpdateLCSFields() const;
254 Handle(TDocStd_Document) myDoc; ///< OCAF document instance corresponding for keeping all persistent data
255 int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
258 HYDROData_InterpolatorsFactory* myInterpolatorsFactory; ///< iterpolators factory