src/HYDROData/HYDROData_Zone.h

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 #ifndef HYDROData_Zone_HeaderFile
  20 #define HYDROData_Zone_HeaderFile
  21
  22 #include "HYDROData_Entity.h"
  23 #include "HYDROData_IInterpolator.h"
  24
  25 class Handle(HYDROData_LandCover);
  26 class TopoDS_Shape;
  27
  28 DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Entity)
  29
  30
  31 /**\class HYDROData_Zone
  32  * \brief Class that stores/retreives information about the 2d face.
  33  */
  34 class HYDROData_Zone : public HYDROData_Entity
  35 {
  36
  37 public:
  38
  39   // Enumeration of mergin types for conflict altitudes/types
  40   enum MergeType
  41   {
  42     Merge_UNKNOWN, // Undefined
  43     Merge_ZMIN,    // The minimum values
  44     Merge_ZMAX,    // The maximum values
  45     Merge_Object   // Only one altitude/land cover will be taken into account
  46   };
  47
  48 protected:
  49   /**
  50    * Enumeration of tags corresponding to the persistent object parameters.
  51    */
  52   enum DataTag
  53   {
  54     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
  55     DataTag_Shape,           ///< reference shape
  56     DataTag_Object,          ///< reference objects
  57     DataTag_MergeType,       ///< mergin type of conflict bathymetries/types
  58     DataTag_MergeObject,     ///< reference altitude/land cover for conflict merge
  59   };
  60
  61 public:
  62   DEFINE_STANDARD_RTTI(HYDROData_Zone);
  63
  64   /**
  65    * Returns the kind of this object. Must be redefined in all objects of known type.
  66    */
  67   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_ZONE; }
  68
  69
  70   /**
  71    * Returns flag indicating that object is updateble or not.
  72    */
  73   HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
  74
  75
  76   /**
  77    * Checks that object has 2D presentation. Reimlemented to retun true.
  78    */
  79   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
  80
  81
  82   /**
  83    * Returns flag indicating that object can be removed or not.
  84    */
  85   HYDRODATA_EXPORT virtual bool CanRemove();
  86
  87   /**
  88    * Returns the list of all reference objects of this object.
  89    */
  90   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
  91
  92
  93   /**
  94    * Sets the shape of the zone.
  95    */
  96   HYDRODATA_EXPORT virtual void SetShape( const TopoDS_Shape& theShape );
  97
  98   /**
  99    * Returns the shape of the zone.
 100    */
 101   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const;
 102
 103
 104   /**
 105    * Returns true if zone needs merge of bathymetries.
 106    */
 107   HYDRODATA_EXPORT virtual bool IsMergingNeed() const;
 108
 109
 110   /**
 111    * Sets the interpolator for zone. By default it is NULL and original
 112    * interpolation algorithms are used to calculate points altitudes.
 113    * If you set interpolator it won't be stored in the data model structure,
 114    * it will be deleted during that time as this zone will be freed.
 115    */
 116   HYDRODATA_EXPORT virtual void SetInterpolator( HYDROData_IInterpolator* theInter );
 117
 118   /**
 119    * * Returns the interpolator of zone object.
 120    */
 121   HYDRODATA_EXPORT virtual HYDROData_IInterpolator* GetInterpolator() const;
 122
 123   /**
 124    * Sets the merging type for conflict altitudes.
 125    * By default it is set to Merge_UNKNOWN.
 126    */
 127   HYDRODATA_EXPORT virtual void SetMergeType( const MergeType& theType );
 128
 129   /**
 130    * Returns the merging type for conflict altitudes/types.
 131    */
 132   HYDRODATA_EXPORT virtual MergeType GetMergeType() const;
 133
 134
 135   /**
 136    * Sets the reference object to resolve the conflict.
 137    * This object is used only in case of "Merge_Object" merge type.
 138    * \param theObject the merge object
 139    */
 140   HYDRODATA_EXPORT virtual void SetMergeObject( const Handle(HYDROData_Entity)& theObject );
 141
 142   /**
 143    * Returns the reference object to resolve the conflict.
 144    * \return the merge object
 145    */
 146   HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetMergeObject() const;
 147
 148   /**
 149    * Removes the reference object for resolving the conflict.
 150    */
 151   HYDRODATA_EXPORT virtual void RemoveMergeObject();
 152
 153   /**
 154    * Add new one object for zone.
 155    * \param theObject the object to add
 156    */
 157   HYDRODATA_EXPORT virtual bool AddObject( const Handle(HYDROData_Entity)& theObject );
 158
 159   /**
 160    * Returns all objects of zone.
 161    * \return the list of objects
 162    */
 163   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetObjects() const;
 164
 165   /**
 166    * Removes all objects from zone.
 167    */
 168   HYDRODATA_EXPORT virtual void RemoveObjects();
 169
 170   /**
 171    * Returns submersible flag.
 172    * \return true if all objects of the zone is submersible
 173    */
 174   HYDRODATA_EXPORT bool IsSubmersible() const;
 175
 176 protected:
 177
 178   friend class HYDROData_Region;
 179   friend class HYDROData_Iterator;
 180
 181   /**
 182    * Creates new object in the internal data structure. Use higher level objects
 183    * to create objects with real content.
 184    */
 185   HYDRODATA_EXPORT HYDROData_Zone();
 186
 187   /**
 188    * Destructs properties of the object and object itself, removes it from the document.
 189    */
 190   HYDRODATA_EXPORT ~HYDROData_Zone();
 191
 192 private:
 193   HYDROData_IInterpolator* myInterpolator;
 194
 195 };
 196
 197 #endif