Salome HOME
refs #561: the draft data model for Strickler table
[modules/hydro.git] / src / HYDROData / HYDROData_Zone.h
index eddee171d3348cee5d93da139ec63e8a56e6e052..b8a8c0d2c648fd86ac2c6b6d8ec5295ad5f648c1 100644 (file)
@@ -1,11 +1,29 @@
+// 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_Zone_HeaderFile
 #define HYDROData_Zone_HeaderFile
 
-#include <HYDROData_Entity.h>
+#include "HYDROData_Entity.h"
+#include "HYDROData_IInterpolator.h"
 
 class Handle(HYDROData_Object);
-class Handle(HYDROData_Bathymetry);
+class Handle(HYDROData_IAltitudeObject);
 class TopoDS_Shape;
 
 DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Entity)
@@ -19,12 +37,13 @@ class HYDROData_Zone : public HYDROData_Entity
 
 public:
 
-  // Enumeration of mergin types for conflict bathymetries
-  enum MergeBathymetriesType
+  // Enumeration of mergin types for conflict altitudes
+  enum MergeAltitudesType
   {
-    Merge_ZMIN,   // The minimum values
-    Merge_ZMAX,   // The maximum values
-    Merge_Object  // Only one bathymetry will be taken into account
+    Merge_UNKNOWN, // Undefined
+    Merge_ZMIN,    // The minimum values
+    Merge_ZMAX,    // The maximum values
+    Merge_Object   // Only one altitude will be taken into account
   };
 
 protected:
@@ -37,7 +56,7 @@ protected:
     DataTag_Shape,           ///< reference shape
     DataTag_GeometryObject,  ///< reference geometry objects
     DataTag_MergeType,       ///< mergin type of conflict bathymetries
-    DataTag_Bathymetry,      ///< reference bathymetry
+    DataTag_MergeAltitude,   ///< reference altitude for conflict merge
   };
 
 public:
@@ -48,10 +67,28 @@ public:
    */
   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_ZONE; }
 
+
+  /**
+   * Returns flag indicating that object is updateble or not.
+   */
+  HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
+
+
+  /**
+   * Checks that object has 2D presentation. Reimlemented to retun true.
+   */
+  HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
+
+
+  /**
+   * Returns flag indicating that object can be removed or not.
+   */
+  HYDRODATA_EXPORT virtual bool CanRemove();
+
   /**
-   * Dump object to Python script representation.
+   * Returns the list of all reference objects of this object.
    */
-  HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 
 
   /**
@@ -66,32 +103,52 @@ public:
 
 
   /**
-   * Sets the merging type for conflict bathymetries.
-   * By default it is set to Merge_ZMIN.
+   * Returns true if zone needs merge of bathymetries.
    */
-  HYDRODATA_EXPORT virtual void SetMergeType( const MergeBathymetriesType& theType );
+  HYDRODATA_EXPORT virtual bool IsMergingNeed() const;
+
+
+  /**
+   * Sets the interpolator for zone. By default it is NULL and original
+   * interpolation algorithms are used to calculate points altitudes.
+   * If you set interpolator it won't be stored in the data model structure,
+   * it will be deleted during that time as this zone will be freed.
+   */
+  HYDRODATA_EXPORT virtual void SetInterpolator( HYDROData_IInterpolator* theInter );
+
+  /**
+   * * Returns the interpolator of zone object.
+   */
+  HYDRODATA_EXPORT virtual HYDROData_IInterpolator* GetInterpolator() const;
+
+
+  /**
+   * Sets the merging type for conflict altitudes.
+   * By default it is set to Merge_UNKNOWN.
+   */
+  HYDRODATA_EXPORT virtual void SetMergeType( const MergeAltitudesType& theType );
 
   /**
-   * Returns the merging type for conflict bathymetries.
+   * Returns the merging type for conflict altitudes.
    */
-  HYDRODATA_EXPORT virtual MergeBathymetriesType GetMergeType() const;
+  HYDRODATA_EXPORT virtual MergeAltitudesType GetMergeType() const;
 
 
   /**
-   * Sets the reference bathymetry to resolve the conflict.
+   * Sets the reference altitude to resolve the conflict.
    * This object is used only in case of "Merge_Object" merge type.
    */
-  HYDRODATA_EXPORT virtual void SetMergeBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry );
+  HYDRODATA_EXPORT virtual void SetMergeAltitude( const Handle(HYDROData_IAltitudeObject)& theAltitude );
 
   /**
-   * Returns the reference bathymetry to resolve the conflict.
+   * Returns the reference altitude to resolve the conflict.
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetMergeBathymetry() const;
+  HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) GetMergeAltitude() const;
 
   /**
-   * Removes the reference bathymetry for resolving the conflict.
+   * Removes the reference altitude for resolving the conflict.
    */
-  HYDRODATA_EXPORT virtual void RemoveMergeBathymetry();
+  HYDRODATA_EXPORT virtual void RemoveMergeAltitude();
   
 
   /**
@@ -109,6 +166,7 @@ public:
    */
   HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
 
+  HYDRODATA_EXPORT bool IsSubmersible() const;
 
 protected:
 
@@ -119,12 +177,15 @@ protected:
    * Creates new object in the internal data structure. Use higher level objects 
    * to create objects with real content.
    */
-  HYDROData_Zone();
+  HYDRODATA_EXPORT HYDROData_Zone();
 
   /**
    * Destructs properties of the object and object itself, removes it from the document.
    */
-  ~HYDROData_Zone();
+  HYDRODATA_EXPORT ~HYDROData_Zone();
+
+private:
+  HYDROData_IInterpolator* myInterpolator;
 
 };