src/HYDROData/HYDROData_Document.h

   1 // Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef HYDROData_Document_HeaderFile
  24 #define HYDROData_Document_HeaderFile
  25
  26 #include <HYDROData.h>
  27 #include <HYDROData_Entity.h>
  28
  29 #include <TDocStd_Document.hxx>
  30
  31 class HYDROData_InterpolatorsFactory;
  32
  33 class QFile;
  34 class gp_Pnt2d;
  35 class gp_Pnt;
  36 class gp_XYZ;
  37 class gp_XY;
  38
  39 /**
  40  * Errors that could appear on document open/save actions.
  41  * If there is no error, it is "OK".
  42  */
  43 enum Data_DocError {
  44   DocError_OK = 0, ///< success
  45   DocError_ResourcesProblem, ///< resources files are invalid or not found
  46   DocError_CanNotOpen, ///< can not open file for reading or writing
  47   DocError_InvalidVersion, ///< version of document is different than expected
  48   DocError_InvalidFormat, ///< format of the document is bad
  49   DocError_UnknownProblem ///< problem has unknown nature
  50 };
  51
  52 DEFINE_STANDARD_HANDLE(HYDROData_Document, MMgt_TShared)
  53
  54 /**\class HYDROData_Document
  55  *
  56  * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
  57  *
  58  * Document contains all data of the Study specific to this module.
  59  * Also it provides acces to this data: open/save, transactions management etc.
  60  * to provide access to all stored data.
  61  */
  62
  63 class HYDROData_Document : public MMgt_TShared
  64 {
  65 public:
  66
  67   DEFINE_STANDARD_RTTI(HYDROData_Document);
  68
  69   //! Returns the existing document or creates new if it is not exist
  70   HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(const int theStudyID);
  71
  72   //! Returns the document by object
  73   HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(
  74     const TDF_Label& theObjectLabel );
  75
  76 public:
  77
  78   //! Returns true if data model contains document for this study
  79   HYDRODATA_EXPORT static bool HasDocument(const int theStudyID);
  80
  81   //! Get study id by document instance, if document doesn't exists return false
  82   HYDRODATA_EXPORT static bool DocumentId( const Handle(HYDROData_Document)& theDocument,
  83                                            int&                              theDocId );
  84
  85 public:
  86
  87   //! Loads the OCAF document from the file.
  88   //! \param theFileName full name of the file to load
  89   //! \param theStudyID identifier of the SALOME study to associate with loaded file
  90   //! \returns error status (OK in case of success)
  91   HYDRODATA_EXPORT static Data_DocError Load(const char* theFileName, const int theStudyID);
  92
  93   //! Saves the OCAF document to the file.
  94   //! \param theFileName full name of the file to store
  95   //! \returns error status (OK in case of success)
  96   HYDRODATA_EXPORT Data_DocError Save(const char* theFileName);
  97
  98   //! Removes document data
  99   HYDRODATA_EXPORT void Close();
 100
 101 public:
 102
 103   // Returns name of document instance in python dump script
 104   HYDRODATA_EXPORT QString GetDocPyName() const;
 105
 106   //! Dump study document to Python script representation.
 107   //! \param theFileName full name of the file to store
 108   //! \returns true if document has been successfuly dumped
 109   HYDRODATA_EXPORT bool DumpToPython( const QString& theFileName,
 110                                       const bool     theIsMultiFile ) const;
 111
 112   //! Dump model data to Python script representation.
 113   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects,
 114                                                      const bool           theIsMultiFile ) 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
 161 public:
 162
 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();
 174
 175 public:
 176
 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();
 185
 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();
 194
 195 public:
 196
 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);
 201
 202
 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;
 207
 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;
 212
 213 public:
 214
 215   //! Returns interpolator factory instance
 216   HYDRODATA_EXPORT HYDROData_InterpolatorsFactory* GetInterpolatorsFactory();
 217
 218 protected:
 219
 220   friend class HYDROData_Iterator;
 221   friend class test_HYDROData_Document;
 222
 223   //! Creates new document: private because "Document" method must be used instead of direct creation.
 224   HYDRODATA_EXPORT HYDROData_Document();
 225   //! Creates new document by existing OCAF structure
 226   HYDRODATA_EXPORT HYDROData_Document(const Handle(TDocStd_Document)& theDoc);
 227   //! Deletes all high-level data, managed this document
 228   HYDRODATA_EXPORT ~HYDROData_Document();
 229
 230   //! Returns the new identifier of the new object (may be used for correct ordering of objects)
 231   HYDRODATA_EXPORT int NewID();
 232
 233   //! Returns the label where the objects are located (used by Iterator)
 234   HYDRODATA_EXPORT TDF_Label LabelOfObjects();
 235
 236   HYDRODATA_EXPORT TDF_Label LabelOfLocalCS() const;
 237
 238 private:
 239
 240   // Dump header Python part in to file \c theFile
 241   bool DumpToPython( QFile&               theFile,
 242                      MapOfTreatedObjects& theTreatedObjects ) const;
 243
 244   // Dump objects of type \c theObjectKind to file \c theFile
 245   bool dumpPartitionToPython( QFile&               theFile,
 246                               const bool           theIsMultiFile,
 247                               MapOfTreatedObjects& theDumpedObjects,
 248                               const ObjectKind&    theObjectKind ) const;
 249   void UpdateLCSFields() const;
 250
 251 private:
 252   Handle(TDocStd_Document) myDoc; ///< OCAF document instance corresponding for keeping all persistent data
 253   int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
 254   double myLX, myLY;
 255
 256   HYDROData_InterpolatorsFactory* myInterpolatorsFactory; ///< iterpolators factory
 257 };
 258
 259 #endif