X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_Zone.h;h=cde3b789a8f0a2a7facef4709c4ea50a23d2e982;hb=4d4d74dd554819c30f1c8ded5520cc6c25aba56b;hp=b8a8c0d2c648fd86ac2c6b6d8ec5295ad5f648c1;hpb=b97489a03c25bc13a55db045e41af90ebabe1d08;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_Zone.h b/src/HYDROData/HYDROData_Zone.h index b8a8c0d2..cde3b789 100644 --- a/src/HYDROData/HYDROData_Zone.h +++ b/src/HYDROData/HYDROData_Zone.h @@ -22,8 +22,7 @@ #include "HYDROData_Entity.h" #include "HYDROData_IInterpolator.h" -class Handle(HYDROData_Object); -class Handle(HYDROData_IAltitudeObject); +class Handle(HYDROData_LandCover); class TopoDS_Shape; DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Entity) @@ -37,13 +36,13 @@ class HYDROData_Zone : public HYDROData_Entity public: - // Enumeration of mergin types for conflict altitudes - enum MergeAltitudesType + // Enumeration of mergin types for conflict altitudes/types + enum MergeType { Merge_UNKNOWN, // Undefined Merge_ZMIN, // The minimum values Merge_ZMAX, // The maximum values - Merge_Object // Only one altitude will be taken into account + Merge_Object // Only one altitude/land cover will be taken into account }; protected: @@ -54,9 +53,9 @@ protected: { DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve DataTag_Shape, ///< reference shape - DataTag_GeometryObject, ///< reference geometry objects - DataTag_MergeType, ///< mergin type of conflict bathymetries - DataTag_MergeAltitude, ///< reference altitude for conflict merge + DataTag_Object, ///< reference objects + DataTag_MergeType, ///< mergin type of conflict bathymetries/types + DataTag_MergeObject, ///< reference altitude/land cover for conflict merge }; public: @@ -120,52 +119,58 @@ public: * * 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 ); + HYDRODATA_EXPORT virtual void SetMergeType( const MergeType& theType ); /** - * Returns the merging type for conflict altitudes. + * Returns the merging type for conflict altitudes/types. */ - HYDRODATA_EXPORT virtual MergeAltitudesType GetMergeType() const; + HYDRODATA_EXPORT virtual MergeType GetMergeType() const; /** - * Sets the reference altitude to resolve the conflict. + * Sets the reference object to resolve the conflict. * This object is used only in case of "Merge_Object" merge type. + * \param theObject the merge object */ - HYDRODATA_EXPORT virtual void SetMergeAltitude( const Handle(HYDROData_IAltitudeObject)& theAltitude ); + HYDRODATA_EXPORT virtual void SetMergeObject( const Handle(HYDROData_Entity)& theObject ); /** - * Returns the reference altitude to resolve the conflict. + * Returns the reference object to resolve the conflict. + * \return the merge object */ - HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) GetMergeAltitude() const; + HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetMergeObject() const; /** - * Removes the reference altitude for resolving the conflict. + * Removes the reference object for resolving the conflict. */ - HYDRODATA_EXPORT virtual void RemoveMergeAltitude(); + HYDRODATA_EXPORT virtual void RemoveMergeObject(); - /** - * Add new one geometry object for zone. + * Add new one object for zone. + * \param theObject the object to add */ - HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject ); + HYDRODATA_EXPORT virtual bool AddObject( const Handle(HYDROData_Entity)& theObject ); /** - * Returns all geometry objects of zone. + * Returns all objects of zone. + * \return the list of objects */ - HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const; + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetObjects() const; /** - * Removes all geometry objects from zone. + * Removes all objects from zone. */ - HYDRODATA_EXPORT virtual void RemoveGeometryObjects(); + HYDRODATA_EXPORT virtual void RemoveObjects(); + /** + * Returns submersible flag. + * \return true if all objects of the zone is submersible + */ HYDRODATA_EXPORT bool IsSubmersible() const; protected: