2 #ifndef HYDROData_Region_HeaderFile
3 #define HYDROData_Region_HeaderFile
5 #include "HYDROData_Entity.h"
8 DEFINE_STANDARD_HANDLE(HYDROData_Region, HYDROData_Entity)
10 class Handle(HYDROData_Zone);
14 /**\class HYDROData_Region
15 * \brief Regions are groups (lists) of zones, they can include one or several zones.
17 class HYDROData_Region : public HYDROData_Entity
23 * Enumeration of tags corresponding to the persistent object parameters.
27 DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
28 DataTag_ChildZone, ///< child zones
29 DataTag_Zone, ///< reference zones
33 DEFINE_STANDARD_RTTI(HYDROData_Region);
36 * Returns the kind of this object. Must be redefined in all objects of known type.
38 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_REGION; }
41 * Dump object to Python script representation.
43 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
47 * Removes object and it child sub-objects from the data structure.
48 * Reimplemented to update names of regions in father calculation.
50 HYDRODATA_EXPORT virtual void Remove();
54 * Add new one reference zone for region.
55 * The label of theZone is changed in case if old parent is not this region.
57 HYDRODATA_EXPORT virtual bool AddZone( const Handle(HYDROData_Zone)& theZone );
60 * Returns all reference zone of region.
62 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetZones() const;
65 * Removes reference zone from region.
67 HYDRODATA_EXPORT virtual void RemoveZone( const Handle(HYDROData_Zone)& theZone );
70 * Removes all reference zones from region.
72 HYDRODATA_EXPORT virtual void RemoveZones();
75 * \brief Returns the shape of the region.
76 * Shape of the region could be:
77 * - a face which is the union of the region zones faces
78 * - a shell if the zones faces can't be united into one face
79 * \return shape as TopoDS_Shape
81 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const;
86 * Create new one reference zone for region on child label.
87 * The new zone is added into the list of reference zones.
89 HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) addNewZone();
93 friend class HYDROData_CalculationCase;
94 friend class HYDROData_Iterator;
97 * Creates new object in the internal data structure. Use higher level objects
98 * to create objects with real content.
100 HYDRODATA_EXPORT HYDROData_Region();
103 * Destructs properties of the object and object itself, removes it from the document.
105 HYDRODATA_EXPORT ~HYDROData_Region();