Merge branch 'master' of https://git.salome-platform.org/git/modules/hydro

[modules/hydro.git] / src / HYDROData / HYDROData_Bathymetry.h

diff --git a/src/HYDROData/HYDROData_Bathymetry.h b/src/HYDROData/HYDROData_Bathymetry.h
index db928f7a506b994deb3efb9ffbdfc297660c4a98..0842b12f9c9abe743ffc94309dda6116af854cad 100644 (file)
--- a/src/HYDROData/HYDROData_Bathymetry.h
+++ b/src/HYDROData/HYDROData_Bathymetry.h
@@ -1,3 +1,20 @@
+// 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_Bathymetry_HeaderFile
 #define HYDROData_Bathymetry_HeaderFile
@@ -6,6 +23,7 @@
 
 class QFile;
 class gp_XYZ;
+class Handle_HYDROData_PolylineXY;
 
 DEFINE_STANDARD_HANDLE(HYDROData_Bathymetry, HYDROData_IAltitudeObject)
 
@@ -19,8 +37,8 @@ class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
 {
 public:
 
-  typedef gp_XYZ               AltitudePoint;
-  typedef QList<AltitudePoint> AltitudePoints;
+  typedef gp_XYZ                              AltitudePoint;
+  typedef NCollection_Sequence<AltitudePoint> AltitudePoints;
 
 protected:
 
@@ -30,8 +48,9 @@ protected:
   enum DataTag
   {
     DataTag_First = HYDROData_IAltitudeObject::DataTag_First + 100, ///< first tag, to reserve
-    DataTag_AltitudePoints, ///< altitude points, array of reals
-    DataTag_FilePath        ///< bathymetry imported file path
+    DataTag_AltitudePoints,    ///< altitude points, array of reals
+    DataTag_FilePath,          ///< bathymetry imported file path
+    DataTag_AltitudesInverted, ///< flag to invert z values
   };
 
 public:
@@ -47,7 +66,8 @@ public:
   /**
    * Dump Bathymetry object to Python script representation.
    */
-  HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
+  HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
+                                                     MapOfTreatedObjects& theTreatedObjects ) const;
 
 public:      
   // Public methods to work with Bathymetry altitudes.
@@ -62,7 +82,7 @@ public:
    * Returns altitude points list.
    * \return points list
    */
-  HYDRODATA_EXPORT virtual AltitudePoints   GetAltitudePoints() const;
+  HYDRODATA_EXPORT virtual AltitudePoints   GetAltitudePoints(bool IsConvertToGlobal = false) const;
 
   /**
    * Remove all altitude points.
@@ -83,12 +103,25 @@ public:
    * Stores the bathymetry file path
    * \param theFilePath image file path
    */
-  HYDRODATA_EXPORT void                     SetFilePath( const QString& theFilePath );
+  HYDRODATA_EXPORT void                     SetFilePath( const TCollection_AsciiString& theFilePath );
 
   /**
    * Returns uploaded bathymetry file path
    */
-  HYDRODATA_EXPORT QString                  GetFilePath() const;
+  HYDRODATA_EXPORT TCollection_AsciiString  GetFilePath() const;
+
+  /**
+   * Set flag indicating needs to invert altitude values
+   * \param theIsInverted new invert value
+   * \param theIsUpdate flag indicating necessity to update points
+   */
+  HYDRODATA_EXPORT void                     SetAltitudesInverted( const bool theIsInverted,
+                                                                  const bool theIsUpdate = true );
+
+  /**
+   * Returns flag indicating needs to invert altitude values.
+   */
+  HYDRODATA_EXPORT bool                     IsAltitudesInverted() const;
 
   /**
    * Imports Bathymetry data from file. The supported file types:
@@ -96,8 +129,11 @@ public:
    * \param theFileName the path to file
    * \return \c true if file has been successfully read
    */
-  HYDRODATA_EXPORT virtual bool             ImportFromFile( const QString& theFileName );
+  HYDRODATA_EXPORT virtual bool             ImportFromFile( const TCollection_AsciiString& theFileName );
 
+  HYDRODATA_EXPORT Handle_HYDROData_PolylineXY CreateBoundaryPolyline() const;
+
+  HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
 
 private:
 
@@ -105,7 +141,10 @@ private:
    * Imports Bathymetry data from 'XYZ' file.
    */
   bool                                      importFromXYZFile( QFile&          theFile,
-                                                               AltitudePoints& thePoints );
+                                                               AltitudePoints& thePoints ) const;
+
+  bool                                      importFromASCFile( QFile&          theFile,
+                                                               AltitudePoints& thePoints ) const;
 
 protected:
 
@@ -115,12 +154,12 @@ protected:
    * Creates new object in the internal data structure. Use higher level objects 
    * to create objects with real content.
    */
-  HYDROData_Bathymetry();
+  HYDRODATA_EXPORT HYDROData_Bathymetry();
 
   /**
    * Destructs properties of the object and object itself, removes it from the document.
    */
-  ~HYDROData_Bathymetry();
+  HYDRODATA_EXPORT ~HYDROData_Bathymetry();
 };
 
 #endif