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.
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.
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
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #ifndef HYDROData_Zone_HeaderFile
20 #define HYDROData_Zone_HeaderFile
22 #include "HYDROData_Entity.h"
23 #include "HYDROData_IInterpolator.h"
25 class HYDROData_LandCover;
29 /**\class HYDROData_Zone
30 * \brief Class that stores/retreives information about the 2d face.
32 class HYDROData_Zone : public HYDROData_Entity
36 // Enumeration of mergin types for conflict altitudes/types
39 Merge_UNKNOWN, // Undefined
40 Merge_ZMIN, // The minimum values
41 Merge_ZMAX, // The maximum values
42 Merge_Object // Only one altitude/land cover will be taken into account
47 * Enumeration of tags corresponding to the persistent object parameters.
51 DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
52 DataTag_Shape, ///< reference shape
53 DataTag_Object, ///< reference objects
54 DataTag_MergeType, ///< mergin type of conflict bathymetries/types
55 DataTag_MergeObject, ///< reference altitude/land cover for conflict merge
59 DEFINE_STANDARD_RTTIEXT(HYDROData_Zone, HYDROData_Entity);
62 * Returns the kind of this object. Must be redefined in all objects of known type.
64 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_ZONE; }
68 * Returns flag indicating that object is updateble or not.
70 HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
74 * Checks that object has 2D presentation. Reimlemented to retun true.
76 HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
80 * Returns flag indicating that object can be removed or not.
82 HYDRODATA_EXPORT virtual bool CanRemove();
85 * Returns the list of all reference objects of this object.
87 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
91 * Sets the shape of the zone.
93 HYDRODATA_EXPORT virtual void SetShape( const TopoDS_Shape& theShape );
96 * Returns the shape of the zone.
98 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const;
102 * Returns true if zone needs merge of bathymetries.
104 HYDRODATA_EXPORT virtual bool IsMergingNeed() const;
108 * Sets the interpolator for zone. By default it is NULL and original
109 * interpolation algorithms are used to calculate points altitudes.
110 * If you set interpolator it won't be stored in the data model structure,
111 * it will be deleted during that time as this zone will be freed.
113 HYDRODATA_EXPORT virtual void SetInterpolator( HYDROData_IInterpolator* theInter );
116 * * Returns the interpolator of zone object.
118 HYDRODATA_EXPORT virtual HYDROData_IInterpolator* GetInterpolator() const;
121 * Sets the merging type for conflict altitudes.
122 * By default it is set to Merge_UNKNOWN.
124 HYDRODATA_EXPORT virtual void SetMergeType( const MergeType& theType );
127 * Returns the merging type for conflict altitudes/types.
129 HYDRODATA_EXPORT virtual MergeType GetMergeType() const;
133 * Sets the reference object to resolve the conflict.
134 * This object is used only in case of "Merge_Object" merge type.
135 * \param theObject the merge object
137 HYDRODATA_EXPORT virtual void SetMergeObject( const Handle(HYDROData_Entity)& theObject );
140 * Returns the reference object to resolve the conflict.
141 * \return the merge object
143 HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetMergeObject() const;
146 * Removes the reference object for resolving the conflict.
148 HYDRODATA_EXPORT virtual void RemoveMergeObject();
151 * Add new one object for zone.
152 * \param theObject the object to add
154 HYDRODATA_EXPORT virtual bool AddObject( const Handle(HYDROData_Entity)& theObject );
157 * Returns all objects of zone.
158 * \return the list of objects
160 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetObjects() const;
163 * Removes all objects from zone.
165 HYDRODATA_EXPORT virtual void RemoveObjects();
168 * Returns submersible flag.
169 * \return true if all objects of the zone is submersible
171 HYDRODATA_EXPORT bool IsSubmersible() const;
175 friend class HYDROData_Region;
176 friend class HYDROData_Iterator;
179 * Creates new object in the internal data structure. Use higher level objects
180 * to create objects with real content.
182 HYDRODATA_EXPORT HYDROData_Zone();
185 * Destructs properties of the object and object itself, removes it from the document.
187 HYDRODATA_EXPORT ~HYDROData_Zone();
190 HYDROData_IInterpolator* myInterpolator;