X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_Zone.h;h=cde3b789a8f0a2a7facef4709c4ea50a23d2e982;hb=4d4d74dd554819c30f1c8ded5520cc6c25aba56b;hp=a0c4279cb55164f8730fc2a0a413f54d06ebc98c;hpb=3bf1f41d27a5903c25dca2d54d844c53760e6133;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_Zone.h b/src/HYDROData/HYDROData_Zone.h index a0c4279c..cde3b789 100644 --- a/src/HYDROData/HYDROData_Zone.h +++ b/src/HYDROData/HYDROData_Zone.h @@ -1,11 +1,28 @@ +// 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 +#include "HYDROData_Entity.h" +#include "HYDROData_IInterpolator.h" -class Handle(HYDROData_Object); -class Handle(HYDROData_Bathymetry); +class Handle(HYDROData_LandCover); class TopoDS_Shape; DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Entity) @@ -19,13 +36,13 @@ class HYDROData_Zone : public HYDROData_Entity public: - // Enumeration of mergin types for conflict bathymetries - enum MergeBathymetriesType + // 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 bathymetry will be taken into account + Merge_Object // Only one altitude/land cover will be taken into account }; protected: @@ -36,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_Bathymetry, ///< reference bathymetry + DataTag_Object, ///< reference objects + DataTag_MergeType, ///< mergin type of conflict bathymetries/types + DataTag_MergeObject, ///< reference altitude/land cover for conflict merge }; public: @@ -49,10 +66,28 @@ public: */ HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_ZONE; } + /** - * Dump object to Python script representation. + * Returns flag indicating that object is updateble or not. */ - HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const; + 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(); + + /** + * Returns the list of all reference objects of this object. + */ + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const; /** @@ -67,49 +102,76 @@ public: /** - * Sets the merging type for conflict bathymetries. + * Returns true if zone needs merge of bathymetries. + */ + 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 MergeBathymetriesType& theType ); + HYDRODATA_EXPORT virtual void SetMergeType( const MergeType& theType ); /** - * Returns the merging type for conflict bathymetries. + * Returns the merging type for conflict altitudes/types. */ - HYDRODATA_EXPORT virtual MergeBathymetriesType GetMergeType() const; + HYDRODATA_EXPORT virtual MergeType GetMergeType() const; /** - * Sets the reference bathymetry 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 SetMergeBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry ); + HYDRODATA_EXPORT virtual void SetMergeObject( const Handle(HYDROData_Entity)& theObject ); /** - * Returns the reference bathymetry to resolve the conflict. + * Returns the reference object to resolve the conflict. + * \return the merge object */ - HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetMergeBathymetry() const; + HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetMergeObject() const; /** - * Removes the reference bathymetry for resolving the conflict. + * Removes the reference object for resolving the conflict. */ - HYDRODATA_EXPORT virtual void RemoveMergeBathymetry(); + 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: @@ -120,12 +182,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; };