Dump to python corrected.

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

diff --git a/src/HYDROData/HYDROData_Zone.h b/src/HYDROData/HYDROData_Zone.h
index 4ef2dd9c96afd54099705526b7642196ee2fd112..ed7e1d7cbf843ef1b9d16913611215e1e61a8ce9 100644 (file)
--- a/src/HYDROData/HYDROData_Zone.h
+++ b/src/HYDROData/HYDROData_Zone.h
@@ -5,6 +5,7 @@
 #include <HYDROData_Entity.h>
 
 class Handle(HYDROData_Object);
+class Handle(HYDROData_IAltitudeObject);
 class TopoDS_Shape;
 
 DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Entity)
@@ -16,6 +17,17 @@ DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Entity)
 class HYDROData_Zone : public HYDROData_Entity
 {
 
+public:
+
+  // Enumeration of mergin types for conflict altitudes
+  enum MergeAltitudesType
+  {
+    Merge_UNKNOWN, // Undefined
+    Merge_ZMIN,    // The minimum values
+    Merge_ZMAX,    // The maximum values
+    Merge_Object   // Only one altitude will be taken into account
+  };
+
 protected:
   /**
    * Enumeration of tags corresponding to the persistent object parameters.
@@ -23,8 +35,10 @@ protected:
   enum DataTag
   {
     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
-    DataTag_Shape,            ///< reference shape
-    DataTag_GeometryObject,   ///< reference geometry objects
+    DataTag_Shape,           ///< reference shape
+    DataTag_GeometryObject,  ///< reference geometry objects
+    DataTag_MergeType,       ///< mergin type of conflict bathymetries
+    DataTag_MergeAltitude,   ///< reference altitude for conflict merge
   };
 
 public:
@@ -41,6 +55,23 @@ public:
   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
 
 
+  /**
+   * Returns flag indicating that object is updateble or not.
+   */
+  HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
+
+
+  /**
+   * Returns flag indicating that object can be removed or not.
+   */
+  HYDRODATA_EXPORT virtual bool CanRemove();
+
+  /**
+   * Returns the list of all reference objects of this object.
+   */
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
+
+
   /**
    * Sets the shape of the zone.
    */
@@ -53,30 +84,44 @@ public:
 
 
   /**
-   * Returns number of geometry objects for zone.
+   * Returns true if zone needs merge of bathymetries.
    */
-  HYDRODATA_EXPORT virtual int NbGeometryObjects() const;
+  HYDRODATA_EXPORT virtual bool IsMergingNeed() const;
+
 
   /**
-   * Add new one geometry object for zone.
+   * Sets the merging type for conflict altitudes.
+   * By default it is set to Merge_UNKNOWN.
    */
-  HYDRODATA_EXPORT virtual void AddGeometryObject( const Handle(HYDROData_Object)& theObject );
+  HYDRODATA_EXPORT virtual void SetMergeType( const MergeAltitudesType& theType );
 
   /**
-   * Replace the geometry object for zone.
+   * Returns the merging type for conflict altitudes.
    */
-  HYDRODATA_EXPORT virtual void SetGeometryObject( const int                       theIndex,
-                                                   const Handle(HYDROData_Object)& theObject );
+  HYDRODATA_EXPORT virtual MergeAltitudesType GetMergeType() const;
+
 
   /**
-   * Sets the geometry object for zone.
+   * Sets the reference altitude to resolve the conflict.
+   * This object is used only in case of "Merge_Object" merge type.
    */
-  HYDRODATA_EXPORT virtual void SetGeometryObjects( const HYDROData_SequenceOfObjects& theObjects );
+  HYDRODATA_EXPORT virtual void SetMergeAltitude( const Handle(HYDROData_IAltitudeObject)& theAltitude );
 
   /**
-   * Returns geometry object of zone by index.
+   * Returns the reference altitude to resolve the conflict.
+   */
+  HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) GetMergeAltitude() const;
+
+  /**
+   * Removes the reference altitude for resolving the conflict.
+   */
+  HYDRODATA_EXPORT virtual void RemoveMergeAltitude();
+  
+
+  /**
+   * Add new one geometry object for zone.
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Object) GetGeometryObject( const int theIndex ) const;
+  HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject );
 
   /**
    * Returns all geometry objects of zone.
@@ -98,12 +143,12 @@ 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();
 
 };