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_SplittedShapesGroup);
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
\93Zone of water
\94.
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_SplittedGroups, ///< reference splitted 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
110 DEFINE_STANDARD_RTTI(HYDROData_CalculationCase);
113 * Returns the kind of this object. Must be redefined in all objects of known type.
115 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_CALCULATION; }
118 * Updates the name of this object.
119 * Reimplemented to update the names of regions, zones and splitted groups.
121 HYDRODATA_EXPORT virtual void SetName( const QString& theName );
124 * Dump Calculation object to Python script representation.
126 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
129 * Update the calcualtion case object.
130 * Call this method whenever you made changes for object data.
132 HYDRODATA_EXPORT virtual void Update();
135 * Returns the list of all reference objects of this object.
137 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
140 // Public methods to work with Calculation
143 * Add new one reference geometry object for calculation case.
145 HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject );
148 * Returns all reference geometry objects of calculation case.
150 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const;
153 * Removes reference geometry object from calculation case.
154 * \param theObject the object to remove
156 HYDRODATA_EXPORT virtual void RemoveGeometryObject( const Handle(HYDROData_Object)& theObject );
159 * Removes all reference geometry objects from calculation case.
161 HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
165 * Add new one reference geometry group for calculation case.
166 * \param theGroup the group to add
168 HYDRODATA_EXPORT virtual bool AddGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
171 * Returns all reference geometry groups of calculation case.
173 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryGroups() const;
176 * Removes reference geometry group from calculation case.
177 * \param theGroup the group to remove
179 HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
182 * Removes all reference geometry groups from calculation case.
184 HYDRODATA_EXPORT virtual void RemoveGeometryGroups();
188 * Sets reference boundary polyline object for calculation case.
190 HYDRODATA_EXPORT virtual void SetBoundaryPolyline( const Handle(HYDROData_PolylineXY)& thePolyline );
193 * Returns reference boundary polyline object of calculation case.
195 HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetBoundaryPolyline() const;
198 * Remove reference boundary polyline object from calculation case.
200 HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline();
204 * Sets reference Strickler table for calculation case.
206 HYDRODATA_EXPORT virtual void SetStricklerTable( const Handle(HYDROData_StricklerTable)& theStricklerTable );
209 * Returns reference Strickler table of calculation case.
211 HYDRODATA_EXPORT virtual Handle(HYDROData_StricklerTable) GetStricklerTable() const;
214 * Remove reference Strickler table from calculation case.
216 HYDRODATA_EXPORT virtual void RemoveStricklerTable();
219 * Returns reference Land Cover Map of calculation case.
220 * \return the referenced Land Cover Map
222 HYDRODATA_EXPORT virtual Handle(HYDROData_LandCoverMap) GetLandCoverMap() const;
225 * Add new one child region for calculation case.
226 * The new region is added into the list of reference regions.
227 * The label of theZone is changed during this operation
228 * because of new region becomes the new parent for this zone.
229 * \return the created region
231 HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone );
235 * Add new one reference region for calculation case.
236 * The label of theRegion is changed in case if old parent is not this calculation.
237 * \return true in case of success
239 HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion );
242 * Returns all reference regions of calculation case.
243 * \return the list of reference regions
245 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions() const;
248 * Updates names of regions to correct order.
250 HYDRODATA_EXPORT virtual void UpdateRegionsOrder();
253 * Removes reference region from calculation case.
254 * \param theRegion the region to remove
256 HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion );
259 * Removes all reference regions from calculation case.
261 HYDRODATA_EXPORT virtual void RemoveRegions();
264 * Returns all reference geometry groups of calculation case.
266 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetSplittedGroups() const;
269 * Removes all reference geometry groups from calculation case.
271 HYDRODATA_EXPORT virtual void RemoveSplittedGroups();
274 * Exports the calculation case data (shell and groups) to GEOM module.
275 * \param theStudyId the id of the study where the GEOM module should be used for export
276 * \return the entry of the GEOM object (empty string in the case of error)
278 HYDRODATA_EXPORT virtual QString Export( int theStudyId ) const;
281 * Exports the calculation case data (shell and groups) to GEOM module.
282 * \param theGeomEngine GEOM module engine
283 * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
284 * \param theGeomObjEntry the published GEOM object entry
285 * \param theErrorMsg the error message
286 * \return true in case of success
289 HYDRODATA_EXPORT virtual bool Export( GEOM::GEOM_Gen_var theGeomEngine,
290 SALOMEDS::Study_ptr theStudy,
291 QString& theGeomObjEntry,
292 QString& theErrorMsg ) const;
296 // Public methods to work with Calculation services
299 * Returns altitude for given point.
300 * \param thePoint the point to examine
301 * \return result altitude value
303 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const;
306 * Returns altitude for given point on given region.
307 * \param thePoint the point to examine
308 * \param theRegion reference region to check
309 * \return result altitude value
311 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint,
312 const Handle(HYDROData_Region)& theRegion ) const;
315 * Returns altitude for given point on given zone.
316 * \param thePoint the point to examine
317 * \param theZone reference zone to check
318 * \return result altitude value
320 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint,
321 const Handle(HYDROData_Zone)& theZone ) const;
324 * Returns strickler coefficient for given point.
325 * \param thePoint the point to examine
326 * \return result strickler coefficient
328 HYDRODATA_EXPORT double GetStricklerCoefficientForPoint( const gp_XY& thePoint ) const;
331 * Returns altitudes for given points on given region.
332 * \param thePoints the points to examine
333 * \param theRegion reference region to check
334 * \return result altitude value
336 HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints(
337 const NCollection_Sequence<gp_XY>& thePoints,
338 const Handle(HYDROData_Region)& theRegion ) const;
341 * Returns altitudes for given points on given zone.
342 * \param thePoints the points to examine
343 * \param theZone reference zone to check
344 * \return result altitude value
346 HYDRODATA_EXPORT virtual NCollection_Sequence<double> GetAltitudesForPoints(
347 const NCollection_Sequence<gp_XY>& thePoints,
348 const Handle(HYDROData_Zone)& theZone ) const;
351 * Returns region to which the point is belongs.
352 * \param thePoint the point to examine
353 * if it is needed to search Land Cover region
354 * \return result region
356 HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint ) const;
359 * Returns zone to which the point is belongs.
360 * \param thePoint the point to examine
361 * if it is needed to search Land Cover zone
362 * \return result zone
364 HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint ) const;
367 * Returns classification of point for given zone.
368 * \param thePoint the point to examine
369 * \param theZone the zone to examine
370 * \return result classification
372 HYDRODATA_EXPORT virtual PointClassification GetPointClassification(
373 const gp_XY& thePoint,
374 const Handle(HYDROData_Zone)& theZone ) const;
376 HYDRODATA_EXPORT void SetAssignmentMode( AssignmentMode theMode );
377 HYDRODATA_EXPORT AssignmentMode GetAssignmentMode() const;
379 HYDRODATA_EXPORT void ClearRules( HYDROData_CalculationCase::DataTag theDataTag,
380 const bool theIsSetToUpdate = true );
381 HYDRODATA_EXPORT void AddRule( const Handle(HYDROData_Entity)& theObject1,
382 HYDROData_PriorityType thePriority,
383 const Handle(HYDROData_Entity)& theObject2,
384 HYDROData_Zone::MergeType theMergeType,
385 HYDROData_CalculationCase::DataTag theDataTag );
386 HYDRODATA_EXPORT bool GetRule( int theIndex,
387 Handle(HYDROData_Entity)& theObject1,
388 HYDROData_PriorityType& thePriority,
389 Handle(HYDROData_Entity)& theObject2,
390 HYDROData_Zone::MergeType& theMergeType,
391 HYDROData_CalculationCase::DataTag& theDataTag ) const;
393 HYDRODATA_EXPORT QString DumpRules() const;
395 HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const;
400 * Add new one region for calculation case.
401 * The new region is added into the list of reference regions.
403 Handle(HYDROData_Region) addNewRegion( const Handle(HYDROData_Document)& theDoc,
404 const QString& thePrefixOrName,
405 bool isPrefix = true );
408 * Add new one splitted edges group for calculation case.
410 Handle(HYDROData_SplittedShapesGroup) addNewSplittedGroup( const QString& theName );
413 * Exports the given faces as shell and the given groups to GEOM module.
414 * \param theGeomEngine GEOM module engine
415 * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
416 * \param theFaces the list of faces to make shell
417 * \param theSplittedGroups the list of groups
418 * \return true in case of success
421 bool Export( GEOM::GEOM_Gen_var theGeomEngine,
422 SALOMEDS::Study_ptr theStudy,
423 const TopTools_ListOfShape& theFaces,
424 const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs,
425 QString& theGeomObjEntry ) const;
428 void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc,
429 const HYDROData_SplitToZonesTool::SplitDataList& theZones );
430 void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc,
431 const HYDROData_SplitToZonesTool::SplitDataList& theZones );
433 void CreateEdgeGroupsDef( const Handle(HYDROData_Document)& theDoc,
434 const HYDROData_SplitToZonesTool::SplitDataList& theEdges );
436 void DumpRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const;
438 void SetWarning( HYDROData_WarningType theType = WARN_OK, const QString& theData = "" );
440 void UpdateRegionsNames( const HYDROData_SequenceOfObjects& theRegions,
441 const QString& theOldCaseName,
442 const QString& theName );
444 void DumpRegionsToPython( QStringList& theResList,
445 MapOfTreatedObjects& theTreatedObjects,
446 const HYDROData_SequenceOfObjects& theRegions ) const;
449 friend class HYDROData_Iterator;
452 * Creates new object in the internal data structure. Use higher level objects
453 * to create objects with real content.
455 HYDRODATA_EXPORT HYDROData_CalculationCase();
458 * Destructs properties of the object and object itself, removes it from the document.
460 HYDRODATA_EXPORT ~HYDROData_CalculationCase();
462 void DumpSampleMeshing( QStringList& theScript,
463 const QString& theStudyName,
464 const QString& theGeomShapeName,
465 const QString& theMeshName ) const;
468 HYDROData_Warning myLastWarning;