Salome HOME
correction for Python wrapping
[modules/hydro.git] / src / HYDROPy / HYDROData_Bathymetry.sip
index a359d85e92add8d0ffe07364b6c4cc9f7e94e67a..9f316d7c4bb71fca3b90125e619bc4eaf31e17d3 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
@@ -39,8 +35,14 @@ class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
     }
 %End
 
-  typedef gp_XYZ                       AltitudePoint;
-  typedef NCollection_Sequence<gp_XYZ> AltitudePoints;
+public:
+  struct AltitudePoint
+  {
+    double X;
+    double Y;
+    double Z;
+  };
+  typedef std::vector<HYDROData_Bathymetry::AltitudePoint> AltitudePoints;
 
 
 %TypeHeaderCode
@@ -48,62 +50,19 @@ class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
 %End
 
 public:      
-  // Public methods to work with Bathymetry altitudes.
-
-  /**
-   * 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.
-
-  /**
-   * Set flag indicating needs to invert altitude values
-   * \param theIsInverted new invert value
-   * \param theIsUpdate flag indicating necessity to update points
-   */
-  void             SetAltitudesInverted( const bool theIsInverted,
-                                         const bool theIsUpdate = true );
-
-  /**
-   * Returns flag indicating needs to invert altitude values.
-   */
-  bool             IsAltitudesInverted() const;
-
-  /**
-   * 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 TCollection_AsciiString& 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();
 };