Salome HOME
correct update status of stream and DTM
[modules/hydro.git] / src / HYDROData / HYDROData_Document.h
index 43eba79a60324eeaef2114b213f6051ea68b1646..6e164226183d804685bf44b6ff61ce2ceea3de71 100644 (file)
@@ -1,11 +1,32 @@
+// Copyright (C) 2014-2015  EDF-R&D
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
 #ifndef HYDROData_Document_HeaderFile
 #define HYDROData_Document_HeaderFile
 
-#include <HYDROData.h>
 #include <HYDROData_Entity.h>
-
 #include <TDocStd_Document.hxx>
 
+class HYDROData_InterpolatorsFactory;
+class HYDROData_IProfilesInterpolator;
+class Handle(HYDROData_StricklerTable);
+class Handle(HYDROData_LandCoverMap);
+
 class QFile;
 class gp_Pnt2d;
 class gp_Pnt;
@@ -82,13 +103,18 @@ public:
   //! Dump study document to Python script representation.
   //! \param theFileName full name of the file to store
   //! \returns true if document has been successfuly dumped
-  HYDRODATA_EXPORT bool DumpToPython( const QString& theFileName,
+  HYDRODATA_EXPORT bool DumpToPython( const QString& thePyScriptPath,
                                       const bool     theIsMultiFile ) const;
 
   //! Dump model data to Python script representation.
-  HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects,
+  HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
+                                                     MapOfTreatedObjects& theTreatedObjects,
                                                      const bool           theIsMultiFile ) const;
 
+  HYDRODATA_EXPORT void CollectQGISValues( const QString& theAttrName,
+                                           QStringList& theAttrValues,
+                                           QStringList& theStricklerTypes ) const;
+
 public:
 
   // Methods to work with objects presentation.
@@ -127,12 +153,13 @@ public:
   //! Removes the order of objects presentation.
   HYDRODATA_EXPORT void RemoveObjectsLayerOrder();
 
-  HYDRODATA_EXPORT gp_Pnt2d GetLocalCS() const;
-  HYDRODATA_EXPORT void SetLocalCS( const gp_Pnt2d& );
+  HYDRODATA_EXPORT void GetLocalCS( double&, double& ) const;
+  HYDRODATA_EXPORT void SetLocalCS( double, double );
   HYDRODATA_EXPORT void Transform( double& X, double& Y, bool IsToLocalCS ) const;
   HYDRODATA_EXPORT void Transform( gp_Pnt& thePnt, bool IsToLocalCS ) const;
   HYDRODATA_EXPORT void Transform( gp_XYZ& thePnt, bool IsToLocalCS ) const;
   HYDRODATA_EXPORT void Transform( gp_XY& thePnt, bool IsToLocalCS ) const;
+  HYDRODATA_EXPORT void Transform( double& X, double& Y, double& Z, bool IsToLocalCS ) const;
 
 public:
 
@@ -186,8 +213,27 @@ public:
     const QStringList& theNames, 
     const ObjectKind   theObjectKind = KIND_UNKNOWN ) const;
 
-protected:
+public:
+  
+  //! Returns interpolator factory instance
+  HYDRODATA_EXPORT HYDROData_InterpolatorsFactory* GetInterpolatorsFactory();
+
+  //! Get the appropriate interpolator by the name.
+  HYDRODATA_EXPORT HYDROData_IProfilesInterpolator* GetInterpolator( const TCollection_AsciiString& theName ) const;
 
+  //! Get list of registered interpolator names.
+  HYDRODATA_EXPORT NCollection_Sequence<TCollection_AsciiString> GetInterpolatorNames() const;
+
+public:
+  //! Returns default strickler coefficient
+  HYDRODATA_EXPORT double GetDefaultStricklerCoefficient() const;
+
+  //! Sets default strickler coefficient
+  HYDRODATA_EXPORT void SetDefaultStricklerCoefficient( double ) const;
+
+  HYDRODATA_EXPORT QColor GetAssociatedColor( const QString& theStricklerType, const Handle(HYDROData_StricklerTable)& theTable ) const;
+
+protected:
   friend class HYDROData_Iterator;
   friend class test_HYDROData_Document;
 
@@ -214,14 +260,18 @@ private:
 
   // Dump objects of type \c theObjectKind to file \c theFile
   bool dumpPartitionToPython( QFile&               theFile,
+                              const QString&       thePyScriptPath,
                               const bool           theIsMultiFile,
                               MapOfTreatedObjects& theDumpedObjects,
                               const ObjectKind&    theObjectKind ) const;
+  void UpdateLCSFields() const;
 
 private:
   Handle(TDocStd_Document) myDoc; ///< OCAF document instance corresponding for keeping all persistent data
   int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
   double myLX, myLY;
+
+  HYDROData_InterpolatorsFactory* myInterpolatorsFactory; ///< iterpolators factory
 };
 
 #endif