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 TopoDS_Shape;
  13
  14 /**\class HYDROData_Region
  15  * \brief Regions are groups (lists) of zones, they can include one or several zones.
  16  */
  17 class HYDROData_Region : public HYDROData_Entity
  18 {
  19
  20 protected:
  21
  22   /**
  23    * Enumeration of tags corresponding to the persistent object parameters.
  24    */
  25   enum DataTag
  26   {
  27     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
  28     DataTag_ChildZone,    ///< child zones
  29     DataTag_Zone,         ///< reference zones
  30   };
  31
  32 public:
  33   DEFINE_STANDARD_RTTI(HYDROData_Region);
  34
  35   /**
  36    * Returns the kind of this object. Must be redefined in all objects of known type.
  37    */
  38   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_REGION; }
  39
  40   /**
  41    * Dump object to Python script representation.
  42    */
  43   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  44
  45
  46   /**
  47    * Removes object and it child sub-objects from the data structure.
  48    * Reimplemented to update names of regions in father calculation.
  49    */
  50   HYDRODATA_EXPORT virtual void Remove();
  51
  52   /**
  53    * Returns flag indicating that object can be removed or not.
  54    */
  55   HYDRODATA_EXPORT virtual bool CanRemove();
  56
  57   /**
  58    * Returns the list of all reference objects of this object.
  59    */
  60   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
  61
  62
  63   /**
  64    * Add new one reference zone for region.
  65    * The label of theZone is changed in case if old parent is not this region.
  66    */
  67   HYDRODATA_EXPORT virtual bool AddZone( const Handle(HYDROData_Zone)& theZone );
  68
  69   /**
  70    * Returns all reference zone of region.
  71    */
  72   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetZones() const;
  73
  74   /**
  75    * Removes reference zone from region.
  76    */
  77   HYDRODATA_EXPORT virtual void RemoveZone( const Handle(HYDROData_Zone)& theZone );
  78
  79   /**
  80    * Removes all reference zones from region.
  81    */
  82   HYDRODATA_EXPORT virtual void RemoveZones();
  83
  84   /**
  85    * \brief Returns the shape of the region.
  86    * Shape of the region could be:
  87    * - a face which is the union of the region zones faces
  88    * - a shell if the zones faces can't be united into one face
  89    * \return shape as TopoDS_Shape
  90    */
  91   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const;
  92
  93 protected:
  94
  95   /**
  96    * Create new one reference zone for region on child label.
  97    * The new zone is added into the list of reference zones.
  98    */
  99   HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) addNewZone();
 100
 101 protected:
 102
 103   friend class HYDROData_CalculationCase;
 104   friend class HYDROData_Iterator;
 105
 106   /**
 107    * Creates new object in the internal data structure. Use higher level objects
 108    * to create objects with real content.
 109    */
 110   HYDRODATA_EXPORT HYDROData_Region();
 111
 112   /**
 113    * Destructs properties of the object and object itself, removes it from the document.
 114    */
 115   HYDRODATA_EXPORT ~HYDROData_Region();
 116 };
 117
 118 #endif