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.
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.
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
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #ifndef HYDROData_CalculationCase_HeaderFile
20 #define HYDROData_CalculationCase_HeaderFile
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>
29 #include <SALOMEconfig.h>
30 #include CORBA_SERVER_HEADER(GEOM_Gen)
36 class TopTools_ListOfShape;
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);
48 DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
51 /**\class HYDROData_CalculationCase
52 * \brief Calculation case is defined by selection of Geometry objects with or without
\93Zone of water
\94.
55 class HYDROData_CalculationCase : public HYDROData_Entity
59 enum PointClassification
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
75 * Enumeration of tags corresponding to the persistent object parameters.
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
98 DEFINE_STANDARD_RTTI(HYDROData_CalculationCase);
101 * Returns the kind of this object. Must be redefined in all objects of known type.
103 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_CALCULATION; }
106 * Updates the name of this object.
107 * Reimplemented to update the names of regions, zones and splitted groups.
109 HYDRODATA_EXPORT virtual void SetName( const QString& theName );
112 * Dump Calculation object to Python script representation.
114 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
117 * Update the calcualtion case object.
118 * Call this method whenever you made changes for object data.
120 HYDRODATA_EXPORT virtual void Update();
123 * Returns the list of all reference objects of this object.
125 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
128 // Public methods to work with Calculation
131 * Add new one reference geometry object for calculation case.
133 HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject );
136 * Returns all reference geometry objects of calculation case.
138 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const;
141 * Removes reference geometry object from calculation case.
142 * \param theObject the object to remove
144 HYDRODATA_EXPORT virtual void RemoveGeometryObject( const Handle(HYDROData_Object)& theObject );
147 * Removes all reference geometry objects from calculation case.
149 HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
153 * Add new one reference geometry group for calculation case.
154 * \param theGroup the group to add
156 HYDRODATA_EXPORT virtual bool AddGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
159 * Returns all reference geometry groups of calculation case.
161 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryGroups() const;
164 * Removes reference geometry group from calculation case.
165 * \param theGroup the group to remove
167 HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
170 * Removes all reference geometry groups from calculation case.
172 HYDRODATA_EXPORT virtual void RemoveGeometryGroups();
176 * Sets reference boundary polyline object for calculation case.
178 HYDRODATA_EXPORT virtual void SetBoundaryPolyline( const Handle(HYDROData_PolylineXY)& thePolyline );
181 * Returns reference boundary polyline object of calculation case.
183 HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetBoundaryPolyline() const;
186 * Remove reference boundary polyline object from calculation case.
188 HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline();
192 * Sets reference Strickler table for calculation case.
194 HYDRODATA_EXPORT virtual void SetStricklerTable( const Handle(HYDROData_StricklerTable)& theStricklerTable );
197 * Returns reference Strickler table of calculation case.
199 HYDRODATA_EXPORT virtual Handle(HYDROData_StricklerTable) GetStricklerTable() const;
202 * Remove reference Strickler table from calculation case.
204 HYDRODATA_EXPORT virtual void RemoveStricklerTable();
208 * Add new one reference Land Cover for calculation case.
209 * \param theLandCover the Land Cover to add
210 * \return true in case of success
212 HYDRODATA_EXPORT virtual bool AddLandCover( const Handle(HYDROData_LandCover)& theLandCover );
215 * Returns all reference Land Covers of calculation case.
216 * \return the list of referenced Land Covers
218 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetLandCovers() const;
221 * Removes reference Land Cover from calculation case.
222 * \param theLandCover the Land Cover to remove
224 HYDRODATA_EXPORT virtual void RemoveLandCover( const Handle(HYDROData_LandCover)& theLandCover );
227 * Removes all reference Land Covers from calculation case.
229 HYDRODATA_EXPORT virtual void RemoveLandCovers();
233 * Add new one child region for calculation case.
234 * The new region is added into the list of reference regions.
235 * The label of theZone is changed during this operation
236 * because of new region becomes the new parent for this zone.
237 * \param theLandCover if true - Land Cover region will be added
238 * \return the created region
240 HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone,
241 const bool theLandCover );
245 * Add new one reference region for calculation case.
246 * The label of theRegion is changed in case if old parent is not this calculation.
247 * \param theLandCover if true - Land Cover region will bw created
248 * \return true in case of success
250 HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion,
251 const bool theLandCover );
254 * Returns all reference regions of calculation case.
255 * \param theLandCover if true - Land Cover regions will be returned
256 * \return the list of reference regions
258 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions( const bool theLandCover ) const;
261 * Updates names of regions to correct order.
263 HYDRODATA_EXPORT virtual void UpdateRegionsOrder();
266 * Removes reference region from calculation case.
267 * \param theRegion the region to remove
268 * \param theLandCover if true - it means that Land Cover region to be removed
270 HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion,
271 const bool theLandCover );
274 * Removes all reference regions from calculation case.
275 * \param theLandCover if true - it means that Land Cover regions to be removed
277 HYDRODATA_EXPORT virtual void RemoveRegions( const bool theLandCover );
280 * Returns all reference geometry groups of calculation case.
282 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetSplittedGroups() const;
285 * Removes all reference geometry groups from calculation case.
287 HYDRODATA_EXPORT virtual void RemoveSplittedGroups();
290 * Exports the calculation case data (shell and groups) to GEOM module.
291 * \param theStudyId the id of the study where the GEOM module should be used for export
292 * \return the entry of the GEOM object (empty string in the case of error)
294 HYDRODATA_EXPORT virtual QString Export( int theStudyId ) const;
297 * Exports the calculation case data (shell and groups) to GEOM module.
298 * \param theGeomEngine GEOM module engine
299 * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
300 * \param theGeomObjEntry the published GEOM object entry
301 * \param theErrorMsg the error message
302 * \return true in case of success
304 HYDRODATA_EXPORT virtual bool Export( GEOM::GEOM_Gen_var theGeomEngine,
305 SALOMEDS::Study_ptr theStudy,
306 QString& theGeomObjEntry,
307 QString& theErrorMsg ) const;
310 // Public methods to work with Calculation services
313 * Returns altitude for given point.
314 * \param thePoint the point to examine
315 * \return result altitude value
317 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const;
320 * Returns altitude for given point on given region.
321 * \param thePoint the point to examine
322 * \param theRegion reference region to check
323 * \return result altitude value
325 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint,
326 const Handle(HYDROData_Region)& theRegion ) const;
329 * Returns altitude for given point on given zone.
330 * \param thePoint the point to examine
331 * \param theZone reference zone to check
332 * \return result altitude value
334 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint,
335 const Handle(HYDROData_Zone)& theZone ) const;
338 * Returns altitudes for given points on given region.
339 * \param thePoints the points to examine
340 * \param theRegion reference region to check
341 * \return result altitude value
343 HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints(
344 const NCollection_Sequence<gp_XY>& thePoints,
345 const Handle(HYDROData_Region)& theRegion ) const;
348 * Returns altitudes for given points on given zone.
349 * \param thePoints the points to examine
350 * \param theZone reference zone to check
351 * \return result altitude value
353 HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints(
354 const NCollection_Sequence<gp_XY>& thePoints,
355 const Handle(HYDROData_Zone)& theZone ) const;
358 * Returns region to which the point is belongs.
359 * \param thePoint the point to examine
360 * \param theLandCover the flag indicating,
361 * if it is needed to search Land Cover region
362 * \return result region
364 HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint,
365 const bool theLandCover ) const;
368 * Returns zone to which the point is belongs.
369 * \param thePoint the point to examine
370 * \param theLandCover the flag indicating,
371 * if it is needed to search Land Cover zone
372 * \return result zone
374 HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint,
375 const bool theLandCover ) const;
378 * Returns classification of point for given zone.
379 * \param thePoint the point to examine
380 * \param theZone the zone to examine
381 * \return result classification
383 HYDRODATA_EXPORT virtual PointClassification GetPointClassification(
384 const gp_XY& thePoint,
385 const Handle(HYDROData_Zone)& theZone ) const;
387 HYDRODATA_EXPORT void SetAssignmentMode( AssignmentMode theMode );
388 HYDRODATA_EXPORT AssignmentMode GetAssignmentMode() const;
390 HYDRODATA_EXPORT void ClearRules( HYDROData_CalculationCase::DataTag theDataTag,
391 const bool theIsSetToUpdate = true );
392 HYDRODATA_EXPORT void AddRule( const Handle(HYDROData_Entity)& theObject1,
393 HYDROData_PriorityType thePriority,
394 const Handle(HYDROData_Entity)& theObject2,
395 HYDROData_Zone::MergeType theMergeType,
396 HYDROData_CalculationCase::DataTag theDataTag );
397 HYDRODATA_EXPORT bool GetRule( int theIndex,
398 Handle(HYDROData_Entity)& theObject1,
399 HYDROData_PriorityType& thePriority,
400 Handle(HYDROData_Entity)& theObject2,
401 HYDROData_Zone::MergeType& theMergeType,
402 HYDROData_CalculationCase::DataTag& theDataTag ) const;
404 HYDRODATA_EXPORT void SetAssignmentLandCoverMode( AssignmentMode theMode );
405 HYDRODATA_EXPORT AssignmentMode GetAssignmentLandCoverMode() const;
407 HYDRODATA_EXPORT QString DumpRules() const;
408 HYDRODATA_EXPORT QString DumpLandCoverRules() const;
410 HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const;
415 * Add new one region for calculation case.
416 * The new region is added into the list of reference regions.
418 Handle(HYDROData_Region) addNewRegion( const Handle(HYDROData_Document)& theDoc,
419 const QString& thePrefixOrName,
420 const bool theLandCover,
421 bool isPrefix = true );
424 * Add new one splitted edges group for calculation case.
426 Handle(HYDROData_SplittedShapesGroup) addNewSplittedGroup( const QString& theName );
429 * Exports the given faces as shell and the given groups to GEOM module.
430 * \param theGeomEngine GEOM module engine
431 * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
432 * \param theFaces the list of faces to make shell
433 * \param theSplittedGroups the list of groups
434 * \return true in case of success
436 bool Export( GEOM::GEOM_Gen_var theGeomEngine,
437 SALOMEDS::Study_ptr theStudy,
438 const TopTools_ListOfShape& theFaces,
439 const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs,
440 QString& theGeomObjEntry ) const;
442 void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc,
443 const HYDROData_SplitToZonesTool::SplitDataList& theZones,
444 const bool theLandCover );
445 void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc,
446 const HYDROData_SplitToZonesTool::SplitDataList& theZones,
447 const bool theLandCover );
449 void CreateEdgeGroupsDef( const Handle(HYDROData_Document)& theDoc,
450 const HYDROData_SplitToZonesTool::SplitDataList& theEdges );
452 void DumpRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const;
453 void DumpLandCoverRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const;
455 void SetWarning( HYDROData_WarningType theType = WARN_OK, const QString& theData = "" );
457 void UpdateRegionsNames( const HYDROData_SequenceOfObjects& theRegions,
458 const QString& theOldCaseName,
459 const QString& theName );
461 void DumpRegionsToPython( QStringList& theResList,
462 MapOfTreatedObjects& theTreatedObjects,
463 const HYDROData_SequenceOfObjects& theRegions ) const;
466 friend class HYDROData_Iterator;
469 * Creates new object in the internal data structure. Use higher level objects
470 * to create objects with real content.
472 HYDRODATA_EXPORT HYDROData_CalculationCase();
475 * Destructs properties of the object and object itself, removes it from the document.
477 HYDRODATA_EXPORT ~HYDROData_CalculationCase();
479 void DumpSampleMeshing( QStringList& theScript,
480 const QString& theStudyName,
481 const QString& theGeomShapeName,
482 const QString& theMeshName ) const;
485 HYDROData_Warning myLastWarning;