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 #pragma warning ( disable: 4251 )
34 #include <SALOMEconfig.h>
35 #include CORBA_SERVER_HEADER(GEOM_Gen)
39 #pragma warning( default: 4251 )
46 class TopTools_ListOfShape;
48 class Handle(HYDROData_Object);
49 class Handle(HYDROData_Region);
50 class Handle(HYDROData_Zone);
51 class Handle(HYDROData_PolylineXY);
52 class Handle(HYDROData_ShapesGroup);
53 class Handle(HYDROData_SplitShapesGroup);
54 class Handle(HYDROData_Document);
55 class Handle(HYDROData_StricklerTable);
56 class Handle(HYDROData_LandCoverMap);
58 DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
61 /**\class HYDROData_CalculationCase
62 * \brief Calculation case is defined by selection of Geometry objects with or without �Zone of water�.
65 class HYDROData_CalculationCase : public HYDROData_Entity
69 enum PointClassification
71 POINT_OUT, ///< point is out of zone face
72 POINT_IN, ///< point is inside of zone face
73 POINT_ON ///< point is on the edge of zone face
85 * Enumeration of tags corresponding to the persistent object parameters.
89 DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
90 DataTag_GeometryObject, ///< reference geometry objects
91 DataTag_ChildRegion, ///< child regions
92 DataTag_Region, ///< reference regions
93 DataTag_Polyline, ///< reference boundary polyline
94 DataTag_GeometryGroup, ///< reference geometry groups
95 DataTag_SplitGroups, ///< reference split groups
96 DataTag_CustomRules, ///< custom rules
97 DataTag_AssignmentMode, ///< assignment mode
98 DataTag_StricklerTable, ///< reference Strickler table
100 DataTag_LandCover_Obsolete, ///< reference land covers
101 DataTag_CustomLandCoverRules_Obsolete, ///< custom rules for land covers priority
102 DataTag_AssignmentLandCoverMode_Obsolete, ///< assignment mode of land covers priority
103 DataTag_ChildLandCoverRegion_Obsolete, ///< child land cover regions
104 DataTag_LandCoverRegion_Obsolete, ///< reference land cover regions
106 DataTag_LandCoverMap, ///< reference to land cover map
111 DEFINE_STANDARD_RTTI(HYDROData_CalculationCase);
114 * Returns the kind of this object. Must be redefined in all objects of known type.
116 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_CALCULATION; }
119 * Updates the name of this object.
120 * Reimplemented to update the names of regions, zones and split groups.
122 HYDRODATA_EXPORT virtual void SetName( const QString& theName );
125 * Dump Calculation object to Python script representation.
127 HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
128 MapOfTreatedObjects& theTreatedObjects ) const;
131 * Update the calcualtion case object.
132 * Call this method whenever you made changes for object data.
134 HYDRODATA_EXPORT virtual void Update();
137 * Returns the list of all reference objects of this object.
139 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
142 // Public methods to work with Calculation
145 * Add new one reference geometry object for calculation case.
147 HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject );
150 * Returns all reference geometry objects of calculation case.
152 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const;
155 * Removes reference geometry object from calculation case.
156 * \param theObject the object to remove
158 HYDRODATA_EXPORT virtual void RemoveGeometryObject( const Handle(HYDROData_Object)& theObject );
161 * Removes all reference geometry objects from calculation case.
163 HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
167 * Add new one reference geometry group for calculation case.
168 * \param theGroup the group to add
170 HYDRODATA_EXPORT virtual bool AddGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
173 * Returns all reference geometry groups of calculation case.
175 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryGroups() const;
178 * Removes reference geometry group from calculation case.
179 * \param theGroup the group to remove
181 HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
184 * Removes all reference geometry groups from calculation case.
186 HYDRODATA_EXPORT virtual void RemoveGeometryGroups();
190 * Sets reference boundary polyline object for calculation case.
192 HYDRODATA_EXPORT virtual void SetBoundaryPolyline( const Handle(HYDROData_PolylineXY)& thePolyline );
195 * Returns reference boundary polyline object of calculation case.
197 HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetBoundaryPolyline() const;
200 * Remove reference boundary polyline object from calculation case.
202 HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline();
206 * Sets reference Strickler table for calculation case.
208 HYDRODATA_EXPORT virtual void SetStricklerTable( const Handle(HYDROData_StricklerTable)& theStricklerTable );
211 * Returns reference Strickler table of calculation case.
213 HYDRODATA_EXPORT virtual Handle(HYDROData_StricklerTable) GetStricklerTable() const;
216 * Remove reference Strickler table from calculation case.
218 HYDRODATA_EXPORT virtual void RemoveStricklerTable();
221 * Returns reference Land Cover Map of calculation case.
222 * \return the referenced Land Cover Map
224 HYDRODATA_EXPORT Handle(HYDROData_LandCoverMap) GetLandCoverMap() const;
226 HYDRODATA_EXPORT void SetLandCoverMap( const Handle(HYDROData_LandCoverMap)& );
229 * Add new one child region for calculation case.
230 * The new region is added into the list of reference regions.
231 * The label of theZone is changed during this operation
232 * because of new region becomes the new parent for this zone.
233 * \return the created region
235 HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone );
239 * Add new one reference region for calculation case.
240 * The label of theRegion is changed in case if old parent is not this calculation.
241 * \return true in case of success
243 HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion );
246 * Returns all reference regions of calculation case.
247 * \return the list of reference regions
249 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions() const;
252 * Updates names of regions to correct order.
254 HYDRODATA_EXPORT virtual void UpdateRegionsOrder();
257 * Removes reference region from calculation case.
258 * \param theRegion the region to remove
260 HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion );
263 * Removes all reference regions from calculation case.
265 HYDRODATA_EXPORT virtual void RemoveRegions();
268 * Returns all reference geometry groups of calculation case.
270 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetSplitGroups() const;
273 * Removes all reference geometry groups from calculation case.
275 HYDRODATA_EXPORT virtual void RemoveSplitGroups();
278 * Exports the calculation case data (shell and groups) to GEOM module.
279 * \param theStudyId the id of the study where the GEOM module should be used for export
280 * \return the entry of the GEOM object (empty string in the case of error)
282 HYDRODATA_EXPORT virtual QString Export( int theStudyId ) const;
285 * Exports the calculation case data (shell and groups) to GEOM module.
286 * \param theGeomEngine GEOM module engine
287 * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
288 * \param theGeomObjEntry the published GEOM object entry
289 * \param theErrorMsg the error message
290 * \return true in case of success
293 HYDRODATA_EXPORT virtual bool Export( GEOM::GEOM_Gen_var theGeomEngine,
294 SALOMEDS::Study_ptr theStudy,
295 QString& theGeomObjEntry,
296 QString& theErrorMsg ) const;
300 // Public methods to work with Calculation services
303 * Returns altitude for given point.
304 * \param thePoint the point to examine
305 * \return result altitude value
307 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const;
310 * Returns altitude for given point on given region.
311 * \param thePoint the point to examine
312 * \param theRegion reference region to check
313 * \return result altitude value
315 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint,
316 const Handle(HYDROData_Region)& theRegion,
317 int theMethod = 0) const;
320 * Returns altitude for given point on given zone.
321 * \param thePoint the point to examine
322 * \param theZone reference zone to check
323 * \return result altitude value
325 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint,
326 const Handle(HYDROData_Zone)& theZone,
327 int theMethod = 0) const;
330 * Returns strickler coefficient for given point.
331 * \param thePoint the point to examine
332 * \return result strickler coefficient
334 HYDRODATA_EXPORT double GetStricklerCoefficientForPoint( const gp_XY& thePoint ) const;
337 * Returns altitudes for given points on given region.
338 * \param thePoints the points to examine
339 * \param theRegion reference region to check
340 * \return result altitude value
342 HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints(
343 const NCollection_Sequence<gp_XY>& thePoints,
344 const Handle(HYDROData_Region)& theRegion,
345 int theMethod = 0) 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,
356 int theMethod = 0) const;
359 * Returns region to which the point is belongs.
360 * \param thePoint the point to examine
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 ) const;
367 * Returns zone to which the point is belongs.
368 * \param thePoint the point to examine
369 * if it is needed to search Land Cover zone
370 * \return result zone
372 HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint ) const;
375 * Returns classification of point for given zone.
376 * \param thePoint the point to examine
377 * \param theZone the zone to examine
378 * \return result classification
380 HYDRODATA_EXPORT virtual PointClassification GetPointClassification(
381 const gp_XY& thePoint,
382 const Handle(HYDROData_Zone)& theZone ) const;
384 HYDRODATA_EXPORT void SetAssignmentMode( AssignmentMode theMode );
385 HYDRODATA_EXPORT AssignmentMode GetAssignmentMode() const;
387 HYDRODATA_EXPORT void ClearRules( HYDROData_CalculationCase::DataTag theDataTag,
388 const bool theIsSetToUpdate = true );
389 HYDRODATA_EXPORT void AddRule( const Handle(HYDROData_Entity)& theObject1,
390 HYDROData_PriorityType thePriority,
391 const Handle(HYDROData_Entity)& theObject2,
392 HYDROData_Zone::MergeType theMergeType,
393 HYDROData_CalculationCase::DataTag theDataTag );
394 HYDRODATA_EXPORT bool GetRule( int theIndex,
395 Handle(HYDROData_Entity)& theObject1,
396 HYDROData_PriorityType& thePriority,
397 Handle(HYDROData_Entity)& theObject2,
398 HYDROData_Zone::MergeType& theMergeType,
399 HYDROData_CalculationCase::DataTag& theDataTag ) const;
401 HYDRODATA_EXPORT QString DumpRules() const;
403 HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const;
408 * Add new one region for calculation case.
409 * The new region is added into the list of reference regions.
411 Handle(HYDROData_Region) addNewRegion( const Handle(HYDROData_Document)& theDoc,
412 const QString& thePrefixOrName,
413 bool isPrefix = true );
416 * Add new one split edges group for calculation case.
418 Handle(HYDROData_SplitShapesGroup) addNewSplitGroup( const QString& theName );
421 * Exports the given faces as shell and the given groups to GEOM module.
422 * \param theGeomEngine GEOM module engine
423 * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
424 * \param theFaces the list of faces to make shell
425 * \param theSplitGroups the list of groups
426 * \return true in case of success
429 bool Export( GEOM::GEOM_Gen_var theGeomEngine,
430 SALOMEDS::Study_ptr theStudy,
431 const TopTools_ListOfShape& theFaces,
432 const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs,
433 QString& theGeomObjEntry ) const;
436 void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc,
437 const HYDROData_SplitToZonesTool::SplitDataList& theZones );
438 void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc,
439 const HYDROData_SplitToZonesTool::SplitDataList& theZones );
441 void CreateEdgeGroupsDef( const Handle(HYDROData_Document)& theDoc,
442 const HYDROData_SplitToZonesTool::SplitDataList& theEdges );
444 void DumpRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const;
446 void SetWarning( HYDROData_WarningType theType = WARN_OK, const QString& theData = "" );
448 void UpdateRegionsNames( const HYDROData_SequenceOfObjects& theRegions,
449 const QString& theOldCaseName,
450 const QString& theName );
452 void DumpRegionsToPython( QStringList& theResList,
453 const QString& thePyScriptPath,
454 MapOfTreatedObjects& theTreatedObjects,
455 const HYDROData_SequenceOfObjects& theRegions ) const;
458 friend class HYDROData_Iterator;
461 * Creates new object in the internal data structure. Use higher level objects
462 * to create objects with real content.
464 HYDRODATA_EXPORT HYDROData_CalculationCase();
467 * Destructs properties of the object and object itself, removes it from the document.
469 HYDRODATA_EXPORT ~HYDROData_CalculationCase();
471 void DumpSampleMeshing( QStringList& theScript,
472 const QString& theStudyName,
473 const QString& theGeomShapeName,
474 const QString& theMeshName ) const;
477 HYDROData_Warning myLastWarning;