src/HYDROData/HYDROData_Document.h

   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.
   6 //
   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.
  11 //
  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
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 #ifndef HYDROData_Document_HeaderFile
  20 #define HYDROData_Document_HeaderFile
  21
  22 #include <HYDROData_Entity.h>
  23 #include <TDocStd_Document.hxx>
  24 #include <Standard_Transient.hxx>
  25
  26 class HYDROData_InterpolatorsFactory;
  27 class HYDROData_IProfilesInterpolator;
  28 class HYDROData_StricklerTable;
  29 class HYDROData_LandCoverMap;
  30
  31 class QFile;
  32 class gp_Pnt2d;
  33 class gp_Pnt;
  34 class gp_XYZ;
  35 class gp_XY;
  36
  37 /**
  38  * Errors that could appear on document open/save actions.
  39  * If there is no error, it is "OK".
  40  */
  41 enum Data_DocError {
  42   DocError_OK = 0, ///< success
  43   DocError_ResourcesProblem, ///< resources files are invalid or not found
  44   DocError_CanNotOpen, ///< can not open file for reading or writing
  45   DocError_InvalidVersion, ///< version of document is different than expected
  46   DocError_InvalidFormat, ///< format of the document is bad
  47   DocError_UnknownProblem ///< problem has unknown nature
  48 };
  49
  50 /**\class HYDROData_Document
  51  *
  52  * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
  53  *
  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.
  57  */
  58
  59 class HYDROData_Document : public Standard_Transient
  60 {
  61 public:
  62   DEFINE_STANDARD_RTTIEXT(HYDROData_Document, Standard_Transient);
  63
  64   //! Returns the existing document or creates new if it is not exist
  65   HYDRODATA_EXPORT static Handle(HYDROData_Document) Document();
  66
  67   //! Returns the document by object
  68   HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(
  69     const TDF_Label& theObjectLabel );
  70
  71 public:
  72
  73   //! Returns true if data model contains document for this study
  74   HYDRODATA_EXPORT static bool HasDocument();
  75
  76
  77 public:
  78
  79   //! Loads the OCAF document from the file.
  80   //! \param theFileName full name of the file to load
  81   //! \returns error status (OK in case of success)
  82   HYDRODATA_EXPORT static Data_DocError Load(const char* theFileName);
  83
  84   //! Saves the OCAF document to the file.
  85   //! \param theFileName full name of the file to store
  86   //! \returns error status (OK in case of success)
  87   HYDRODATA_EXPORT Data_DocError Save(const char* theFileName);
  88
  89   //! Removes document data
  90   HYDRODATA_EXPORT void Close();
  91
  92 public:
  93
  94   // Returns name of document instance in python dump script
  95   HYDRODATA_EXPORT QString GetDocPyName() const;
  96
  97   //! Dump study document to Python script representation.
  98   //! \param theFileName full name of the file to store
  99   //! \returns true if document has been successfuly dumped
 100   HYDRODATA_EXPORT bool DumpToPython( const QString& thePyScriptPath,
 101                                       const bool     theIsMultiFile ) const;
 102
 103   //! Dump model data to Python script representation.
 104   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
 105                                                      MapOfTreatedObjects& theTreatedObjects,
 106                                                      const bool           theIsMultiFile ) const;
 107
 108   HYDRODATA_EXPORT void CollectQGISValues( const QString& theAttrName,
 109                                            QStringList& theAttrValues,
 110                                            QStringList& theStricklerTypes ) const;
 111
 112 public:
 113
 114   // Methods to work with objects presentation.
 115
 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:
 121   //!   1. KIND_IMAGE
 122   //!   2. KIND_IMMERSIBLE_ZONE
 123   //!   3. KIND_CHANNEL
 124   //!   4. KIND_RIVER
 125   //!   5. KIND_STREAM
 126   //!   6. KIND_OBSTACLE
 127   //!   7. KIND_DIGUE
 128   //!   8. KIND_POLYLINEXY
 129   //!   9. KIND_ZONE
 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;
 135
 136   //! Sets the order of objects presentation.
 137   HYDRODATA_EXPORT void SetObjectsLayerOrder( const HYDROData_SequenceOfObjects& theOrder );
 138
 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 );
 142
 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 );
 146
 147   //! Removes the order of objects presentation.
 148   HYDRODATA_EXPORT void RemoveObjectsLayerOrder();
 149
 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;
 156   HYDRODATA_EXPORT void Transform( double& X, double& Y, double& Z, bool IsToLocalCS ) const;
 157
 158 public:
 159
 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();
 171
 172 public:
 173
 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();
 182
 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();
 191
 192 public:
 193
 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);
 198
 199
 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;
 204
 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;
 209
 210   //! Collect all data objects with given object type
 211   HYDRODATA_EXPORT HYDROData_SequenceOfObjects CollectAllObjects(
 212     const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
 213
 214 public:
 215
 216   //! Returns interpolator factory instance
 217   HYDRODATA_EXPORT HYDROData_InterpolatorsFactory* GetInterpolatorsFactory();
 218
 219   //! Get the appropriate interpolator by the name.
 220   HYDRODATA_EXPORT HYDROData_IProfilesInterpolator* GetInterpolator( const TCollection_AsciiString& theName ) const;
 221
 222   //! Get list of registered interpolator names.
 223   HYDRODATA_EXPORT NCollection_Sequence<TCollection_AsciiString> GetInterpolatorNames() const;
 224
 225 public:
 226   //! Returns default strickler coefficient
 227   HYDRODATA_EXPORT double GetDefaultStricklerCoefficient() const;
 228
 229   //! Sets default strickler coefficient
 230   HYDRODATA_EXPORT void SetDefaultStricklerCoefficient( double ) const;
 231
 232   HYDRODATA_EXPORT int GetCountQuadtree() const;
 233   HYDRODATA_EXPORT void SetCountQuadtree( int ) const;
 234   HYDRODATA_EXPORT int GetCountDelaunay() const;
 235   HYDRODATA_EXPORT void SetCountDelaunay( int ) const;
 236
 237   HYDRODATA_EXPORT QColor GetAssociatedColor( const QString& theStricklerType, const Handle(HYDROData_StricklerTable)& theTable ) const;
 238
 239 protected:
 240   friend class HYDROData_Iterator;
 241   friend class test_HYDROData_Document;
 242
 243   //! Creates new document: private because "Document" method must be used instead of direct creation.
 244   HYDRODATA_EXPORT HYDROData_Document();
 245   //! Creates new document by existing OCAF structure
 246   HYDRODATA_EXPORT HYDROData_Document(const Handle(TDocStd_Document)& theDoc);
 247   //! Deletes all high-level data, managed this document
 248   HYDRODATA_EXPORT ~HYDROData_Document();
 249
 250   //! Returns the new identifier of the new object (may be used for correct ordering of objects)
 251   HYDRODATA_EXPORT int NewID();
 252
 253   //! Returns the label where the objects are located (used by Iterator)
 254   HYDRODATA_EXPORT TDF_Label LabelOfObjects();
 255
 256   HYDRODATA_EXPORT TDF_Label LabelOfLocalCS() const;
 257
 258 private:
 259
 260   // Dump header Python part in to file \c theFile
 261   bool DumpToPython( QFile&               theFile,
 262                      MapOfTreatedObjects& theTreatedObjects ) const;
 263
 264   // Dump objects of type \c theObjectKind to file \c theFile
 265   bool dumpPartitionToPython( QFile&               theFile,
 266                               const QString&       thePyScriptPath,
 267                               const bool           theIsMultiFile,
 268                               MapOfTreatedObjects& theDumpedObjects,
 269                               const ObjectKind&    theObjectKind ) const;
 270   void UpdateLCSFields() const;
 271
 272 private:
 273   Handle(TDocStd_Document) myDoc; ///< OCAF document instance corresponding for keeping all persistent data
 274   int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
 275   double myLX, myLY;
 276
 277   HYDROData_InterpolatorsFactory* myInterpolatorsFactory; ///< iterpolators factory
 278 };
 279
 280 #endif