2 #ifndef HYDROData_Region_HeaderFile
3 #define HYDROData_Region_HeaderFile
5 #include "HYDROData_ShapesGroup.h"
8 DEFINE_STANDARD_HANDLE(HYDROData_Region, HYDROData_Entity)
10 class Handle(HYDROData_Zone);
11 class Handle(HYDROData_Document);
16 /**\class HYDROData_Region
17 * \brief Regions are groups (lists) of zones, they can include one or several zones.
19 class HYDROData_Region : public HYDROData_Entity
25 * Enumeration of tags corresponding to the persistent object parameters.
29 DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
30 DataTag_ChildZone, ///< child zones
31 DataTag_Zone, ///< reference zones
35 DEFINE_STANDARD_RTTI(HYDROData_Region);
38 * Returns the kind of this object. Must be redefined in all objects of known type.
40 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_REGION; }
43 * Dump object to Python script representation.
45 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
48 * Returns flag indicating that object is updateble or not.
50 HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
54 * Removes object and it child sub-objects from the data structure.
55 * Reimplemented to update names of regions in father calculation.
57 HYDRODATA_EXPORT virtual void Remove();
60 * Returns flag indicating that object can be removed or not.
62 HYDRODATA_EXPORT virtual bool CanRemove();
65 * Returns the list of all reference objects of this object.
67 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
71 * Add new one reference zone for region.
72 * The label of theZone is changed in case if old parent is not this region.
74 HYDRODATA_EXPORT virtual bool AddZone( const Handle(HYDROData_Zone)& theZone );
77 * Returns all reference zone of region.
79 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetZones() const;
82 * Removes reference zone from region.
84 HYDRODATA_EXPORT virtual void RemoveZone( const Handle(HYDROData_Zone)& theZone );
87 * Removes all reference zones from region.
89 HYDRODATA_EXPORT virtual void RemoveZones();
92 * \brief Returns the shape of the region.
93 * Shape of the region could be:
94 * - a face which is the union of the region zones faces
95 * - a shell if the zones faces can't be united into one face
96 * \return shape as TopoDS_Shape
98 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape( HYDROData_ShapesGroup::SeqOfGroupsDefs* theSeqOfGroups = 0 ) const;
103 * Create new one reference zone for region on child label.
104 * The new zone is added into the list of reference zones.
106 HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) addNewZone( const Handle(HYDROData_Document)& theDoc,
107 const QString& thePrefix,
108 const TopoDS_Face& theFace,
109 const QStringList& theRefObjects );
113 friend class HYDROData_CalculationCase;
114 friend class HYDROData_Iterator;
117 * Creates new object in the internal data structure. Use higher level objects
118 * to create objects with real content.
120 HYDRODATA_EXPORT HYDROData_Region();
123 * Destructs properties of the object and object itself, removes it from the document.
125 HYDRODATA_EXPORT ~HYDROData_Region();