src/HYDROData/HYDROData_CalculationCase.h

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 #ifndef HYDROData_CalculationCase_HeaderFile
  20 #define HYDROData_CalculationCase_HeaderFile
  21
  22 #include <HYDROData_ShapesGroup.h>
  23 #include <HYDROData_SplitToZonesTool.h>
  24 #include <HYDROData_PriorityQueue.h>
  25 #include <HYDROData_Zone.h>
  26 #include <HYDROData_Warning.h>
  27
  28 // IDL includes
  29 #include <SALOMEconfig.h>
  30 #include CORBA_SERVER_HEADER(GEOM_Gen)
  31
  32 class gp_XY;
  33
  34 class TopoDS_Shape;
  35 class TopoDS_Shell;
  36 class TopTools_ListOfShape;
  37
  38 class Handle(HYDROData_Object);
  39 class Handle(HYDROData_Region);
  40 class Handle(HYDROData_Zone);
  41 class Handle(HYDROData_PolylineXY);
  42 class Handle(HYDROData_ShapesGroup);
  43 class Handle(HYDROData_SplittedShapesGroup);
  44 class Handle(HYDROData_Document);
  45 class Handle(HYDROData_StricklerTable);
  46 class Handle(HYDROData_LandCover);
  47
  48 DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
  49
  50
  51 /**\class HYDROData_CalculationCase
  52  * \brief Calculation case is defined by selection of Geometry objects with or without \93Zone of water\94.
  53  *
  54  */
  55 class HYDROData_CalculationCase : public HYDROData_Entity
  56 {
  57 public:
  58
  59   enum PointClassification
  60   {
  61     POINT_OUT,  ///< point is out of zone face
  62     POINT_IN,   ///< point is inside of zone face
  63     POINT_ON    ///< point is on the edge of zone face
  64   };
  65
  66   enum AssignmentMode
  67   {
  68     MANUAL = 0,
  69     AUTOMATIC,
  70   };
  71
  72 public:
  73
  74   /**
  75    * Enumeration of tags corresponding to the persistent object parameters.
  76    */
  77   enum DataTag
  78   {
  79     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
  80     DataTag_GeometryObject,            ///< reference geometry objects
  81     DataTag_ChildRegion,               ///< child regions
  82     DataTag_Region,                    ///< reference regions
  83     DataTag_Polyline,                  ///< reference boundary polyline
  84     DataTag_GeometryGroup,             ///< reference geometry groups
  85     DataTag_SplittedGroups,            ///< reference splitted groups
  86     DataTag_CustomRules,               ///< custom rules
  87     DataTag_AssignmentMode,            ///< assignment mode
  88     DataTag_StricklerTable,            ///< reference Strickler table
  89     DataTag_LandCover,                 ///< reference land covers
  90     DataTag_CustomLandCoverRules,      ///< custom rules for land covers priority
  91     DataTag_AssignmentLandCoverMode,   ///< assignment mode of land covers priority
  92     DataTag_ChildLandCoverRegion,      ///< child land cover regions
  93     DataTag_LandCoverRegion            ///< reference land cover regions
  94   };
  95
  96 public:
  97
  98   DEFINE_STANDARD_RTTI(HYDROData_CalculationCase);
  99
 100   /**
 101    * Returns the kind of this object. Must be redefined in all objects of known type.
 102    */
 103   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_CALCULATION; }
 104
 105   /**
 106    * Updates the name of this object.
 107    * Reimplemented to update the names of regions, zones and splitted groups.
 108    */
 109   HYDRODATA_EXPORT virtual void SetName( const QString& theName );
 110
 111   /**
 112    * Dump Calculation object to Python script representation.
 113    */
 114   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
 115
 116   /**
 117    * Update the calcualtion case object.
 118    * Call this method whenever you made changes for object data.
 119    */
 120   HYDRODATA_EXPORT virtual void Update();
 121
 122   /**
 123    * Returns the list of all reference objects of this object.
 124    */
 125   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 126
 127 public:
 128   // Public methods to work with Calculation
 129
 130   /**
 131    * Add new one reference geometry object for calculation case.
 132    */
 133   HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject );
 134
 135   /**
 136    * Returns all reference geometry objects of calculation case.
 137    */
 138   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const;
 139
 140   /**
 141    * Removes reference geometry object from calculation case.
 142    */
 143   HYDRODATA_EXPORT virtual void RemoveGeometryObject( const Handle(HYDROData_Object)& theObject );
 144
 145   /**
 146    * Removes all reference geometry objects from calculation case.
 147    */
 148   HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
 149
 150
 151   /**
 152    * Add new one reference geometry group for calculation case.
 153    */
 154   HYDRODATA_EXPORT virtual bool AddGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
 155
 156   /**
 157    * Returns all reference geometry groups of calculation case.
 158    */
 159   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryGroups() const;
 160
 161   /**
 162    * Removes reference geometry group from calculation case.
 163    */
 164   HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
 165
 166   /**
 167    * Removes all reference geometry groups from calculation case.
 168    */
 169   HYDRODATA_EXPORT virtual void RemoveGeometryGroups();
 170
 171
 172   /**
 173    * Sets reference boundary polyline object for calculation case.
 174    */
 175   HYDRODATA_EXPORT virtual void SetBoundaryPolyline( const Handle(HYDROData_PolylineXY)& thePolyline );
 176
 177   /**
 178    * Returns reference boundary polyline object of calculation case.
 179    */
 180   HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetBoundaryPolyline() const;
 181
 182   /**
 183    * Remove reference boundary polyline object from calculation case.
 184    */
 185   HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline();
 186
 187
 188     /**
 189    * Sets reference Strickler table for calculation case.
 190    */
 191   HYDRODATA_EXPORT virtual void SetStricklerTable( const Handle(HYDROData_StricklerTable)& theStricklerTable );
 192
 193   /**
 194    * Returns reference Strickler table of calculation case.
 195    */
 196   HYDRODATA_EXPORT virtual Handle(HYDROData_StricklerTable) GetStricklerTable() const;
 197
 198   /**
 199    * Remove reference Strickler table from calculation case.
 200    */
 201   HYDRODATA_EXPORT virtual void RemoveStricklerTable();
 202
 203
 204   /**
 205    * Add new one reference land cover for calculation case.
 206    */
 207   HYDRODATA_EXPORT virtual bool AddLandCover( const Handle(HYDROData_LandCover)& theLandCover );
 208
 209   /**
 210    * Returns all reference land covers of calculation case.
 211    */
 212   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetLandCovers() const;
 213
 214   /**
 215    * Removes reference land cover from calculation case.
 216    */
 217   HYDRODATA_EXPORT virtual void RemoveLandCover( const Handle(HYDROData_LandCover)& theLandCover );
 218
 219   /**
 220    * Removes all reference land covers from calculation case.
 221    */
 222   HYDRODATA_EXPORT virtual void RemoveLandCovers();
 223
 224
 225   /**
 226    * Add new one child region for calculation case.
 227    * The new region is added into the list of reference regions.
 228    * The label of theZone is changed during this operation
 229    * because of new region becomes the new parent for this zone.
 230    */
 231   HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone,
 232                                                                   const bool theLandCover );
 233
 234
 235   /**
 236    * Add new one reference region for calculation case.
 237    * The label of theRegion is changed in case if old parent is not this calculation.
 238    */
 239   HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion,
 240                                            const bool theLandCover );
 241
 242   /**
 243    * Returns all reference regions of calculation case.
 244    */
 245   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions( const bool theLandCover ) const;
 246
 247   /**
 248    * Updates names of regions to correct order.
 249    */
 250   HYDRODATA_EXPORT virtual void UpdateRegionsOrder();
 251
 252   /**
 253    * Removes reference region from calculation case.
 254    */
 255   HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion );
 256
 257   /**
 258    * Removes all reference regions from calculation case.
 259    */
 260   HYDRODATA_EXPORT virtual void RemoveRegions( const bool theLandCover );
 261
 262   /**
 263    * Returns all reference geometry groups of calculation case.
 264    */
 265   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetSplittedGroups() const;
 266
 267   /**
 268    * Removes all reference geometry groups from calculation case.
 269    */
 270   HYDRODATA_EXPORT virtual void RemoveSplittedGroups();
 271
 272   /**
 273    * Exports the calculation case data (shell and groups) to GEOM module.
 274    * \param theStudyId the id of the study where the GEOM module should be used for export
 275    * \return the entry of the GEOM object (empty string in the case of error)
 276    */
 277   HYDRODATA_EXPORT virtual QString Export( int theStudyId ) const;
 278
 279   /**
 280    * Exports the calculation case data (shell and groups) to GEOM module.
 281    * \param theGeomEngine GEOM module engine
 282    * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
 283    * \return true in case of success
 284    */
 285   HYDRODATA_EXPORT virtual bool Export( GEOM::GEOM_Gen_var  theGeomEngine,
 286                                         SALOMEDS::Study_ptr theStudy,
 287                                         QString& theGeomObjEntry ) const;
 288
 289 public:
 290   // Public methods to work with Calculation services
 291
 292   /**
 293    * Returns altitude for given point.
 294    * \param thePoint the point to examine
 295    * \return result altitude value
 296    */
 297   HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const;
 298
 299   /**
 300    * Returns altitude for given point on given region.
 301    * \param thePoint the point to examine
 302    * \param theRegion reference region to check
 303    * \return result altitude value
 304    */
 305   HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY&                    thePoint,
 306                                                        const Handle(HYDROData_Region)& theRegion ) const;
 307
 308   /**
 309    * Returns altitude for given point on given zone.
 310    * \param thePoint the point to examine
 311    * \param theZone reference zone to check
 312    * \return result altitude value
 313    */
 314   HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY&                  thePoint,
 315                                                        const Handle(HYDROData_Zone)& theZone ) const;
 316
 317   /**
 318    * Returns altitudes for given points on given region.
 319    * \param thePoints the points to examine
 320    * \param theRegion reference region to check
 321    * \return result altitude value
 322    */
 323   HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints(
 324     const NCollection_Sequence<gp_XY>& thePoints,
 325     const Handle(HYDROData_Region)&    theRegion ) const;
 326
 327   /**
 328    * Returns altitudes for given points on given zone.
 329    * \param thePoints the points to examine
 330    * \param theZone reference zone to check
 331    * \return result altitude value
 332    */
 333   HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints(
 334     const NCollection_Sequence<gp_XY>& thePoints,
 335     const Handle(HYDROData_Zone)&      theZone ) const;
 336
 337   /**
 338    * Returns region to which the point is belongs.
 339    * \param thePoint the point to examine
 340    * \param theLandCover the flag indicating,
 341    * if it is needed to search land cover region
 342    * \return result region
 343    */
 344   HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint,
 345                                                                         const bool theLandCover ) const;
 346
 347   /**
 348    * Returns zone to which the point is belongs.
 349    * \param thePoint the point to examine
 350    * \param theLandCover the flag indicating,
 351    * if it is needed to search land cover zone
 352    * \return result zone
 353    */
 354   HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint,
 355                                                                     const bool theLandCover ) const;
 356
 357   /**
 358    * Returns classification of point for given zone.
 359    * \param thePoint the point to examine
 360    * \param theZone the zone to examine
 361    * \return result classification
 362    */
 363   HYDRODATA_EXPORT virtual PointClassification GetPointClassification(
 364     const gp_XY&                  thePoint,
 365     const Handle(HYDROData_Zone)& theZone ) const;
 366
 367   HYDRODATA_EXPORT void SetAssignmentMode( AssignmentMode theMode );
 368   HYDRODATA_EXPORT AssignmentMode GetAssignmentMode() const;
 369
 370   HYDRODATA_EXPORT void ClearRules( HYDROData_CalculationCase::DataTag theDataTag,
 371                                     const bool theIsSetToUpdate = true );
 372   HYDRODATA_EXPORT void AddRule( const Handle(HYDROData_Entity)&     theObject1,
 373                                  HYDROData_PriorityType              thePriority,
 374                                  const Handle(HYDROData_Entity)&     theObject2,
 375                                  HYDROData_Zone::MergeAltitudesType  theMergeType,
 376                                  HYDROData_CalculationCase::DataTag  theDataTag );
 377   HYDRODATA_EXPORT bool GetRule( int theIndex,
 378                                  Handle(HYDROData_Entity)&           theObject1,
 379                                  HYDROData_PriorityType&             thePriority,
 380                                  Handle(HYDROData_Entity)&           theObject2,
 381                                  HYDROData_Zone::MergeAltitudesType& theMergeType,
 382                                  HYDROData_CalculationCase::DataTag& theDataTag ) const;
 383
 384   HYDRODATA_EXPORT void SetAssignmentLandCoverMode( AssignmentMode theMode );
 385   HYDRODATA_EXPORT AssignmentMode GetAssignmentLandCoverMode() const;
 386
 387   HYDRODATA_EXPORT QString DumpRules() const;
 388
 389   HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const;
 390
 391 private:
 392
 393   /**
 394    * Add new one region for calculation case.
 395    * The new region is added into the list of reference regions.
 396    */
 397   Handle(HYDROData_Region) addNewRegion( const Handle(HYDROData_Document)& theDoc,
 398                                          const QString& thePrefixOrName,
 399                                          const bool theLandCover,
 400                                          bool isPrefix = true );
 401
 402   /**
 403    * Add new one splitted edges group for calculation case.
 404    */
 405   Handle(HYDROData_SplittedShapesGroup) addNewSplittedGroup( const QString& theName );
 406
 407   /**
 408    * Exports the given faces as shell and the given groups to GEOM module.
 409    * \param theGeomEngine GEOM module engine
 410    * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
 411    * \param theFaces the list of faces to make shell
 412    * \param theSplittedGroups the list of groups
 413    * \return true in case of success
 414    */
 415   bool Export( GEOM::GEOM_Gen_var                            theGeomEngine,
 416                SALOMEDS::Study_ptr                           theStudy,
 417                const TopTools_ListOfShape&                   theFaces,
 418                const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs,
 419                QString& theGeomObjEntry ) const;
 420
 421   /**
 422    * Publish the given shape in GEOM as a GEOM object.
 423    * \param theGeomEngine GEOM module engine
 424    * \param theStudy SALOMEDS study, used for publishing of the shape
 425    * \param theShape the shape to publish as a GEOM object
 426    * \param theName the name of the published object
 427    * \return the published GEOM object
 428    */
 429   GEOM::GEOM_Object_ptr publishShapeInGEOM( GEOM::GEOM_Gen_var  theGeomEngine,
 430                                             SALOMEDS::Study_ptr theStudy,
 431                                             const TopoDS_Shape& theShape,
 432                                             const QString&      theName,
 433                                             QString& theGeomObjEntry ) const;
 434
 435   void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc,
 436                          const HYDROData_SplitToZonesTool::SplitDataList& theZones,
 437                          const bool theLandCover );
 438   void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc,
 439                           const HYDROData_SplitToZonesTool::SplitDataList& theZones,
 440                           const bool theLandCover );
 441
 442   void CreateEdgeGroupsDef( const Handle(HYDROData_Document)& theDoc,
 443                             const HYDROData_SplitToZonesTool::SplitDataList& theEdges );
 444
 445   void DumpRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const;
 446
 447   void SetWarning( HYDROData_WarningType theType = WARN_OK, const QString& theData = "" );
 448
 449   void UpdateRegionsNames( const HYDROData_SequenceOfObjects& theRegions,
 450                            const QString& theOldCaseName,
 451                            const QString& theName );
 452
 453   void DumpRegionsToPython( QStringList& theResList,
 454                             MapOfTreatedObjects& theTreatedObjects,
 455                             const HYDROData_SequenceOfObjects& theRegions ) const;
 456
 457 protected:
 458   friend class HYDROData_Iterator;
 459
 460   /**
 461    * Creates new object in the internal data structure. Use higher level objects
 462    * to create objects with real content.
 463    */
 464   HYDRODATA_EXPORT HYDROData_CalculationCase();
 465
 466   /**
 467    * Destructs properties of the object and object itself, removes it from the document.
 468    */
 469   HYDRODATA_EXPORT ~HYDROData_CalculationCase();
 470
 471   void DumpSampleMeshing( QStringList& theScript,
 472                           const QString& theStudyName,
 473                           const QString& theGeomShapeName,
 474                           const QString& theMeshName ) const;
 475
 476 private:
 477   HYDROData_Warning myLastWarning;
 478 };
 479
 480 #endif