src/HYDROData/HYDROData_Region.h

   1
   2 #ifndef HYDROData_Region_HeaderFile
   3 #define HYDROData_Region_HeaderFile
   4
   5 #include "HYDROData_Entity.h"
   6
   7
   8 DEFINE_STANDARD_HANDLE(HYDROData_Region, HYDROData_Entity)
   9
  10 class Handle(HYDROData_Zone);
  11
  12 /**\class HYDROData_Region
  13  * \brief Regions are groups (lists) of zones, they can include one or several zones.
  14  */
  15 class HYDROData_Region : public HYDROData_Entity
  16 {
  17
  18 protected:
  19
  20   /**
  21    * Enumeration of tags corresponding to the persistent object parameters.
  22    */
  23   enum DataTag
  24   {
  25     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
  26     DataTag_Zone,         ///< reference zones
  27   };
  28
  29   /**
  30    * Enumeration of tags corresponding to the child sub-objects of object.
  31    */
  32   enum ChildTag
  33   {
  34     ChildTag_First = HYDROData_Entity::ChildTag_First + 100, ///< first tag, to reserve
  35     ChildTag_Zone      ///< child zones
  36   };
  37
  38 public:
  39   DEFINE_STANDARD_RTTI(HYDROData_Region);
  40
  41   /**
  42    * Returns the kind of this object. Must be redefined in all objects of known type.
  43    */
  44   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_REGION; }
  45
  46   /**
  47    * Dump object to Python script representation.
  48    */
  49   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  50
  51
  52   /**
  53    * Add new one reference zone for region.
  54    * The label of theZone is changed in case if old parent is not this region.
  55    */
  56   HYDRODATA_EXPORT virtual bool AddZone( const Handle(HYDROData_Zone)& theZone );
  57
  58   /**
  59    * Returns all reference zone of region.
  60    */
  61   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetZones() const;
  62
  63   /**
  64    * Removes reference zone from region.
  65    */
  66   HYDRODATA_EXPORT virtual void RemoveZone( const Handle(HYDROData_Zone)& theZone );
  67
  68   /**
  69    * Removes all reference zones from region.
  70    */
  71   HYDRODATA_EXPORT virtual void RemoveZones();
  72
  73
  74 protected:
  75
  76   /**
  77    * Create new one reference zone for region on child label.
  78    * The new zone is added into the list of reference zones.
  79    */
  80   HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) addNewZone();
  81
  82 protected:
  83
  84   friend class HYDROData_Calculation;
  85   friend class HYDROData_Iterator;
  86
  87   /**
  88    * Creates new object in the internal data structure. Use higher level objects
  89    * to create objects with real content.
  90    */
  91   HYDROData_Region();
  92
  93   /**
  94    * Destructs properties of the object and object itself, removes it from the document.
  95    */
  96   ~HYDROData_Region();
  97 };
  98
  99 #endif