src/HYDROData/HYDROData_CalculationCase.h

   1
   2
   3 #ifndef HYDROData_CalculationCase_HeaderFile
   4 #define HYDROData_CalculationCase_HeaderFile
   5
   6 #include <HYDROData_Entity.h>
   7
   8 class TopoDS_Shell;
   9
  10 class Handle(HYDROData_Object);
  11 class Handle(HYDROData_Region);
  12 class Handle(HYDROData_Zone);
  13 class Handle(HYDROData_Polyline);
  14
  15 DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
  16
  17
  18 /**\class HYDROData_CalculationCase
  19  * \brief Calculation case is defined by selection of Geometry objects with or without \93Zone of water\94.
  20  *
  21  */
  22 class HYDROData_CalculationCase : public HYDROData_Entity
  23 {
  24
  25 protected:
  26
  27   /**
  28    * Enumeration of tags corresponding to the persistent object parameters.
  29    */
  30   enum DataTag
  31   {
  32     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
  33     DataTag_GeometryObject,   ///< reference geometry objects
  34     DataTag_ChildRegion,      ///< child regions
  35     DataTag_Region,           ///< reference regions
  36     DataTag_Polyline          ///< reference boundary polyline
  37   };
  38
  39 public:
  40
  41   DEFINE_STANDARD_RTTI(HYDROData_CalculationCase);
  42
  43   /**
  44    * Returns the kind of this object. Must be redefined in all objects of known type.
  45    */
  46   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_CALCULATION; }
  47
  48   /**
  49    * Updates the name of this object.
  50    * Reimplemented to update the names of regions and zones.
  51    */
  52   HYDRODATA_EXPORT virtual void SetName( const QString& theName );
  53
  54   /**
  55    * Dump Calculation object to Python script representation.
  56    */
  57   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  58
  59 public:
  60   // Public methods to work with Calculation
  61
  62   /**
  63    * Split reference geometry objects to non-intersected regions.
  64    */
  65   HYDRODATA_EXPORT virtual void SplitGeometryObjects();
  66
  67
  68   /**
  69    * Add new one reference geometry object for calculation case.
  70    */
  71   HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject );
  72
  73   /**
  74    * Returns all reference geometry objects of calculation case.
  75    */
  76   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const;
  77
  78   /**
  79    * Removes reference geometry object from calculation case.
  80    */
  81   HYDRODATA_EXPORT virtual void RemoveGeometryObject( const Handle(HYDROData_Object)& theObject );
  82
  83   /**
  84    * Removes all reference geometry objects from calculation case.
  85    */
  86   HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
  87
  88
  89   /**
  90    * Sets reference boundary polyline object for calculation case.
  91    */
  92   HYDRODATA_EXPORT virtual void SetBoundaryPolyline( const Handle(HYDROData_Polyline)& thePolyline );
  93
  94   /**
  95    * Returns reference boundary polyline object of calculation case.
  96    */
  97   HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline) GetBoundaryPolyline() const;
  98
  99   /**
 100    * Remove reference boundary polyline object from calculation case.
 101    */
 102   HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline();
 103
 104
 105   /**
 106    * Add new one child region for calculation case.
 107    * The new region is added into the list of reference regions.
 108    * The label of theZone is changed during this operation
 109    * because of new region becomes the new parent for this zone.
 110    */
 111   HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone );
 112
 113
 114   /**
 115    * Add new one reference region for calculation case.
 116    * The label of theRegion is changed in case if old parent is not this calculation.
 117    */
 118   HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion );
 119
 120   /**
 121    * Returns all reference regions of calculation case.
 122    */
 123   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions() const;
 124
 125   /**
 126    * Updates names of regions to correct order.
 127    */
 128   HYDRODATA_EXPORT virtual void UpdateRegionsOrder();
 129
 130   /**
 131    * Removes reference region from calculation case.
 132    */
 133   HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion );
 134
 135   /**
 136    * Removes all reference regions from calculation case.
 137    */
 138   HYDRODATA_EXPORT virtual void RemoveRegions();
 139
 140   /**
 141    * Returns shell containing faces which correspond to regions.
 142    * \return shell as TopoDS_Shell
 143    */
 144   HYDRODATA_EXPORT virtual TopoDS_Shell GetShell();
 145
 146 private:
 147
 148   /**
 149    * Add new one region for calculation case.
 150    * The new region is added into the list of reference regions.
 151    */
 152   HYDRODATA_EXPORT virtual Handle(HYDROData_Region) addNewRegion();
 153
 154
 155 protected:
 156
 157   friend class HYDROData_Iterator;
 158
 159   /**
 160    * Creates new object in the internal data structure. Use higher level objects
 161    * to create objects with real content.
 162    */
 163   HYDRODATA_EXPORT HYDROData_CalculationCase();
 164
 165   /**
 166    * Destructs properties of the object and object itself, removes it from the document.
 167    */
 168   HYDRODATA_EXPORT ~HYDROData_CalculationCase();
 169 };
 170
 171 #endif