// 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
//

%ExportedHeaderCode
#include <HYDROData_Bathymetry.h>
%End

class HYDROData_Bathymetry : public HYDROData_IAltitudeObject
{
%ConvertToSubClassCode
    switch ( sipCpp->GetKind() )
    {
      case KIND_BATHYMETRY:
        sipClass = sipClass_HYDROData_Bathymetry;
        break;

      default:
        // We don't recognise the type.
        sipClass = NULL;
    }
%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.

  /**
   * 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
   */
  HYDROData_Bathymetry::AltitudePoints GetAltitudePoints() const;

  /**
   * Remove all altitude points.
   */
  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 );


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();
};