Ordering of model objects implementation.

[modules/hydro.git] / src / HYDROPy / HYDROData_Entity.sip

diff --git a/src/HYDROPy/HYDROData_Entity.sip b/src/HYDROPy/HYDROData_Entity.sip
index f5b75504d82f368aa824f77125b3b9c27b530932..6492535a1e908a3b7a96622235271afbf6171436 100644 (file)
--- a/src/HYDROPy/HYDROData_Entity.sip
+++ b/src/HYDROPy/HYDROData_Entity.sip
@@ -44,6 +44,9 @@ const ObjectKind KIND_POLYLINEXY;
 const ObjectKind KIND_CALCULATION;
 const ObjectKind KIND_ZONE;
 const ObjectKind KIND_REGION;
+const ObjectKind KIND_SHAPES_GROUP;
+const ObjectKind KIND_SPLITTED_GROUP;
+const ObjectKind KIND_OBSTACLE_ALTITUDE;
 
 class HYDROData_Entity
 {
@@ -59,45 +62,85 @@ class HYDROData_Entity
         sipClass = sipClass_HYDROData_Image;
         break;
 
-      case KIND_POLYLINEXY:
-        sipClass = sipClass_HYDROData_PolylineXY;
+      case KIND_POLYLINE:
+        sipClass = sipClass_HYDROData_Polyline3D;
         break;
 
       case KIND_BATHYMETRY:
         sipClass = sipClass_HYDROData_Bathymetry;
         break;
 
-      case KIND_OBSTACLE_ALTITUDE:
-        sipClass = sipClass_HYDROData_ObstacleAltitude;
+      case KIND_ALTITUDE:
+        sipClass = sipClass_HYDROData_AltitudeObject;
         break;
 
       case KIND_IMMERSIBLE_ZONE:
         sipClass = sipClass_HYDROData_ImmersibleZone;
         break;
-        
-      case KIND_CALCULATION:
-        sipClass = sipClass_HYDROData_CalculationCase;
+
+      case KIND_RIVER:
+        sipClass = sipClass_HYDROData_River;
+        break;
+
+      case KIND_STREAM:
+        sipClass = sipClass_HYDROData_Stream;
+        break;
+
+      case KIND_CONFLUENCE:
+        sipClass = sipClass_HYDROData_Confluence;
+        break;
+
+      case KIND_CHANNEL:
+        sipClass = sipClass_HYDROData_Channel;
         break;
 
       case KIND_OBSTACLE:
         sipClass = sipClass_HYDROData_Obstacle;
         break;
 
+      case KIND_DIGUE:
+        sipClass = sipClass_HYDROData_Digue;
+        break;
+
       case KIND_PROFILE:
         sipClass = sipClass_HYDROData_Profile;
         break;
 
-      case KIND_REGION:
-        sipClass = sipClass_HYDROData_Region;
+      case KIND_PROFILEUZ:
+        sipClass = sipClass_HYDROData_ProfileUZ;
+        break;
+
+      case KIND_POLYLINEXY:
+        sipClass = sipClass_HYDROData_PolylineXY;
+        break;
+
+      case KIND_CALCULATION:
+        sipClass = sipClass_HYDROData_CalculationCase;
         break;
 
       case KIND_ZONE:
         sipClass = sipClass_HYDROData_Zone;
         break;
 
+      case KIND_REGION:
+        sipClass = sipClass_HYDROData_Region;
+        break;
+
       case KIND_SHAPES_GROUP:
         sipClass = sipClass_HYDROData_ShapesGroup;
         break;
+        
+      case KIND_SPLITTED_GROUP:
+        sipClass = sipClass_HYDROData_SplittedShapesGroup;
+        break;
+
+      case KIND_STREAM_ALTITUDE:
+        sipClass = sipClass_HYDROData_StreamAltitude;
+        break;
+
+      case KIND_OBSTACLE_ALTITUDE:
+        sipClass = sipClass_HYDROData_ObstacleAltitude;
+        break;
 
       case KIND_UNKNOWN:
         sipClass = sipClass_HYDROData_Entity;
@@ -131,6 +174,36 @@ public:
    */
   virtual void Update();
 
+  /**
+   * Checks that object has 2D presentation. Base implementation returns false.
+   */
+  virtual bool IsHas2dPrs() const;
+
+  /**
+   * Returns data of object wrapped to QVariant.
+   * Base implementation returns null value.
+   */
+  virtual QVariant GetDataVariant();
+
+
+  /**
+   * Sets the "MustBeUpdated" flag: if object is depended on updated features.
+   * \param theFlag is true for objects that must be updated, false for up-to-date
+   */
+  virtual void SetToUpdate( bool theFlag );
+
+  /**
+   * Returns the "MustBeUpdated" flag: is object data must be updated or not
+   * \returns false if object is up to date
+   */
+  virtual bool IsMustBeUpdated() const;
+
+  /**
+   * Returns flag indicating that object is updateble or not.
+   */
+  virtual bool CanBeUpdated() const;
+
+  
   /**
    * Checks is object exists in the data structure.
    * \returns true is object is not exists in the data model
@@ -140,21 +213,41 @@ public:
   /**
    * Removes object from the data structure.
    */
-  void Remove();
+  virtual void Remove();
 
-  /**
-   * Returns unique integer identifier of the object (may be used for ordering of objects)
-   */
-  int ID() const;
 
   /**
    * Copies all properties of this to the destinated object.
    * Objects must be the same type.
    * \param theDestination initialized object (from any document) - target of copying
    */
-  /*
-  void CopyTo( HYDROData_Entity theDestination ) const;
-  */
+  void CopyTo( HYDROData_Entity theDestination ) const [void ( const Handle_HYDROData_Entity& )];
+  %MethodCode
+    Handle(HYDROData_Entity) aCopyTo = createHandle( a0 );
+    if ( !aCopyTo.IsNull() )
+    {
+      Py_BEGIN_ALLOW_THREADS
+      sipSelfWasArg ? sipCpp->HYDROData_Entity::CopyTo( aCopyTo ):
+                      sipCpp->CopyTo( aCopyTo );
+      Py_END_ALLOW_THREADS
+    }
+  %End
+
+  /**
+   * Returns father object. For object created under root document label
+   * this method always return NULL object.
+   */
+  HYDROData_Entity GetFatherObject() const [Handle_HYDROData_Entity ()];
+  %MethodCode
+    Handle(HYDROData_Entity) aFather;
+    
+    Py_BEGIN_ALLOW_THREADS
+    aFather = sipSelfWasArg ? sipCpp->HYDROData_Entity::GetFatherObject() : 
+                              sipCpp->GetFatherObject();
+    Py_END_ALLOW_THREADS
+    
+    sipRes = createPointer( aFather );
+  %End
 
   /**
    * Returns the list of all reference objects of this object.
@@ -162,6 +255,23 @@ public:
    */
   virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 
+
+  /**
+   * Returns the z-level for object presentation, -1 if no z-level.
+   */
+  virtual bool GetZLevel( int& theLevel ) const [Standard_Boolean ( Standard_Integer& )];
+
+  /**
+   * Set the z-level for object presentation.
+   */
+  virtual void SetZLevel( const int& theLevel ) [void ( const Standard_Integer& )];
+
+  /**
+   * Remove the z-level of object presentation.
+   */
+  virtual void RemoveZLevel();
+
+
 protected:
 
   /**