Salome HOME
Merge branch 'BR_LAND_COVER_MAP' of ssh://git.salome-platform.org/modules/hydro into...
[modules/hydro.git] / src / HYDROPy / HYDROData_Bathymetry.sip
index 75b918e3e246f049aabf1fda6c14ae5d79fe1846..e23029181dddbc9b9476af8227dab068511e0733 100644 (file)
@@ -1,12 +1,8 @@
-// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
-//
-// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-//
+// 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.
+// 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
 #include <HYDROData_Bathymetry.h>
 %End
 
-class HYDROData_Bathymetry : HYDROData_IAltitudeObject
+class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
 {
-
-  typedef gp_XYZ                       AltitudePoint;
-  typedef NCollection_Sequence<gp_XYZ> AltitudePoints;
-
 %ConvertToSubClassCode
     switch ( sipCpp->GetKind() )
     {
@@ -43,61 +35,28 @@ class HYDROData_Bathymetry : HYDROData_IAltitudeObject
     }
 %End
 
+  typedef gp_XYZ                       AltitudePoint;
+  typedef NCollection_Sequence<gp_XYZ> AltitudePoints;
+
+
 %TypeHeaderCode
 #include <HYDROData_Bathymetry.h>
 %End
 
 public:      
-  // Public methods to work with Bathymetry altitudes.
-
-  /**
-   * Returns altitude for given point.
-   * \param thePoint the point to examine
-   * \return altitude value
-   */
-  double           GetAltitudeForPoint( const gp_XY& thePoint );
-
-  /**
-   * Replace current altitude points by new one.
-   * \param thePoints the altitude points list
-   */
-  virtual void             SetAltitudePoints( const HYDROData_Bathymetry::AltitudePoints& );
-
-  /**
-   * Returns altitude points list.
-   * \return points list
-   */
+  virtual void SetAltitudePoints( const HYDROData_Bathymetry::AltitudePoints& );
   HYDROData_Bathymetry::AltitudePoints GetAltitudePoints() const;
 
-  /**
-   * Remove all altitude points.
-   */
-  void              RemoveAltitudePoints();
-
+  void RemoveAltitudePoints();
 
 public:
-  // Public methods to work with files.
-
-  /**
-   * Imports Bathymetry data from file. The supported file types:
-   *  - xyz
-   * \param theFileName the path to file
-   * \return \c true if file has been successfully read
-   */
-  bool             ImportFromFile( const QString& theFileName );
+  void SetAltitudesInverted( const bool theIsInverted, const bool theIsUpdate = true );
+  bool IsAltitudesInverted() const;
 
+  bool ImportFromFile( const TCollection_AsciiString& theFileName );
 
 protected:
-
-  /**
-   * Creates new object in the internal data structure. Use higher level objects 
-   * to create objects with real content.
-   */
   HYDROData_Bathymetry();
-
-  /**
-   * Destructs properties of the object and object itself, removes it from the document.
-   */
   ~HYDROData_Bathymetry();
 };