Salome HOME
refs #1330: basic implementation of the not zoomable polyline arrows
[modules/hydro.git] / src / HYDROData / HYDROData_Document.h
index 7efc1d63137509f1a501e49763aee6c919105c83..4c0368f81d141b2ff4c450c15d747e02d658c30a 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 HYDROData_StricklerTable;
+class HYDROData_LandCoverMap;
+
 class QFile;
 class gp_Pnt2d;
 class gp_Pnt;
@@ -25,8 +46,6 @@ enum Data_DocError {
   DocError_UnknownProblem ///< problem has unknown nature
 };
 
-DEFINE_STANDARD_HANDLE(HYDROData_Document, MMgt_TShared)
-
 /**\class HYDROData_Document
  *
  * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
@@ -39,8 +58,7 @@ DEFINE_STANDARD_HANDLE(HYDROData_Document, MMgt_TShared)
 class HYDROData_Document : public MMgt_TShared
 {
 public:
-
-  DEFINE_STANDARD_RTTI(HYDROData_Document);
+  DEFINE_STANDARD_RTTIEXT(HYDROData_Document, MMgt_TShared);
 
   //! Returns the existing document or creates new if it is not exist
   HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(const int theStudyID);
@@ -82,13 +100,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.
@@ -118,7 +141,7 @@ public:
 
   //! Show object at the top of other model objects. If the object
   //! already has the z-level parameter then nothing will be done.
-  HYDRODATA_EXPORT void Show( const Handle_HYDROData_Entity& theObject );
+  HYDRODATA_EXPORT void Show( const Handle(HYDROData_Entity)& theObject );
 
   //! Show sequence of objects at the top of other model objects.
   //! The objects from the sequence will be sorted alphabetically at first.
@@ -133,6 +156,7 @@ public:
   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 +210,32 @@ 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 int GetCountQuadtree() const;
+  HYDRODATA_EXPORT void SetCountQuadtree( int ) const;
+  HYDRODATA_EXPORT int GetCountDelaunay() const;
+  HYDRODATA_EXPORT void SetCountDelaunay( int ) 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,6 +262,7 @@ 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;
@@ -223,6 +272,8 @@ 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