+// 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_IInterpolator.h"
-class Handle(HYDROData_Object);
-class Handle(HYDROData_IAltitudeObject);
+class HYDROData_LandCover;
class TopoDS_Shape;
-DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Entity)
-
/**\class HYDROData_Zone
* \brief Class that stores/retreives information about the 2d face.
{
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:
{
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:
- DEFINE_STANDARD_RTTI(HYDROData_Zone);
+ DEFINE_STANDARD_RTTIEXT(HYDROData_Zone, HYDROData_Entity);
/**
* Returns the kind of this object. Must be redefined in all objects of known type.
* * 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: