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);
12 /**\class HYDROData_Region
13 * \brief Regions are groups (lists) of zones, they can include one or several zones.
15 class HYDROData_Region : public HYDROData_Entity
21 * Enumeration of tags corresponding to the persistent object parameters.
25 DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
26 DataTag_Zone ///< reference zones
30 * Enumeration of tags corresponding to the child sub-objects of object.
34 ChildTag_First = HYDROData_Entity::ChildTag_First + 100, ///< first tag, to reserve
35 ChildTag_Zone ///< child zones
39 DEFINE_STANDARD_RTTI(HYDROData_Region);
42 * Returns the kind of this object. Must be redefined in all objects of known type.
44 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_REGION; }
47 * Dump object to Python script representation.
49 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
53 * Create new one reference zone for region on child label.
54 * The new zone is not added into the list of reference zones.
56 HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) AddNewZone();
59 * Removes all child zones from region.
61 HYDRODATA_EXPORT virtual void RemoveChildZones();
65 * Returns number of reference zones of region.
70 * Add new one reference zone for region.
72 HYDRODATA_EXPORT virtual void AddZone( const Handle(HYDROData_Zone)& theZone );
75 * Replace the reference zone for region.
77 HYDRODATA_EXPORT virtual void SetZone( const int theIndex,
78 const Handle(HYDROData_Zone)& theZone );
81 * Inserts the reference zone for region before given index.
83 HYDRODATA_EXPORT virtual void InsertZone( const int theBeforeIndex,
84 const Handle(HYDROData_Zone)& theZone );
87 * Sets reference zones for calculation region.
89 HYDRODATA_EXPORT virtual void SetZones( const HYDROData_SequenceOfObjects& theZones );
92 * Returns reference zone of region by index.
94 HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZone( const int theIndex ) const;
97 * Returns all reference zone of region.
99 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetZones() const;
102 * Removes reference zone from region.
104 HYDRODATA_EXPORT virtual void RemoveZone( const Handle(HYDROData_Zone)& theZone );
107 * Removes reference zone from region by it index.
109 HYDRODATA_EXPORT virtual void RemoveZone( const int theIndex );
112 * Removes all reference zones from region.
114 HYDRODATA_EXPORT virtual void RemoveZones();
119 friend class HYDROData_Calculation;
120 friend class HYDROData_Iterator;
123 * Creates new object in the internal data structure. Use higher level objects
124 * to create objects with real content.
129 * Destructs properties of the object and object itself, removes it from the document.