X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_CalculationCase.h;h=0dd025ed46cd18f2937a8c9b0ec96977a039eaff;hb=40075335fb504d596f21e9459488a56c1277dbde;hp=f6787a2790e790d0c8d0f21e43b2c08427c36bd6;hpb=1c6465288cda49e75392724ddc01aba7cfe4ef68;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_CalculationCase.h b/src/HYDROData/HYDROData_CalculationCase.h index f6787a27..0dd025ed 100644 --- a/src/HYDROData/HYDROData_CalculationCase.h +++ b/src/HYDROData/HYDROData_CalculationCase.h @@ -1,16 +1,49 @@ - +// Copyright (C) 2014-2015 EDF-R&D +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef HYDROData_CalculationCase_HeaderFile #define HYDROData_CalculationCase_HeaderFile -#include +#include +#include +#include +#include +#include + +// IDL includes +#include +#include CORBA_SERVER_HEADER(GEOM_Gen) + +class gp_XY; +class TopoDS_Shape; class TopoDS_Shell; +class TopTools_ListOfShape; class Handle(HYDROData_Object); class Handle(HYDROData_Region); class Handle(HYDROData_Zone); class Handle(HYDROData_PolylineXY); +class Handle(HYDROData_ShapesGroup); +class Handle(HYDROData_SplittedShapesGroup); +class Handle(HYDROData_Document); +class Handle(HYDROData_StricklerTable); +class Handle(HYDROData_LandCover); DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity) @@ -21,8 +54,22 @@ DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity) */ class HYDROData_CalculationCase : public HYDROData_Entity { +public: -protected: + enum PointClassification + { + POINT_OUT, ///< point is out of zone face + POINT_IN, ///< point is inside of zone face + POINT_ON ///< point is on the edge of zone face + }; + + enum AssignmentMode + { + MANUAL = 0, + AUTOMATIC, + }; + +public: /** * Enumeration of tags corresponding to the persistent object parameters. @@ -30,10 +77,20 @@ protected: enum DataTag { DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve - DataTag_GeometryObject, ///< reference geometry objects - DataTag_ChildRegion, ///< child regions - DataTag_Region, ///< reference regions - DataTag_Polyline ///< reference boundary polyline + DataTag_GeometryObject, ///< reference geometry objects + DataTag_ChildRegion, ///< child regions + DataTag_Region, ///< reference regions + DataTag_Polyline, ///< reference boundary polyline + DataTag_GeometryGroup, ///< reference geometry groups + DataTag_SplittedGroups, ///< reference splitted groups + DataTag_CustomRules, ///< custom rules + DataTag_AssignmentMode, ///< assignment mode + DataTag_StricklerTable, ///< reference Strickler table + DataTag_LandCover, ///< reference land covers + DataTag_CustomLandCoverRules, ///< custom rules for land covers priority + DataTag_AssignmentLandCoverMode, ///< assignment mode of land covers priority + DataTag_ChildLandCoverRegion, ///< child land cover regions + DataTag_LandCoverRegion ///< reference land cover regions }; public: @@ -47,9 +104,9 @@ public: /** * Updates the name of this object. - * Reimplemented to update the names of regions and zones. + * Reimplemented to update the names of regions, zones and splitted groups. */ - HYDRODATA_EXPORT virtual void SetName( const QString& theName ); + HYDRODATA_EXPORT virtual void SetName( const QString& theName ); /** * Dump Calculation object to Python script representation. @@ -82,6 +139,7 @@ public: /** * Removes reference geometry object from calculation case. + * \param theObject the object to remove */ HYDRODATA_EXPORT virtual void RemoveGeometryObject( const Handle(HYDROData_Object)& theObject ); @@ -91,6 +149,29 @@ public: HYDRODATA_EXPORT virtual void RemoveGeometryObjects(); + /** + * Add new one reference geometry group for calculation case. + * \param theGroup the group to add + */ + HYDRODATA_EXPORT virtual bool AddGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup ); + + /** + * Returns all reference geometry groups of calculation case. + */ + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryGroups() const; + + /** + * Removes reference geometry group from calculation case. + * \param theGroup the group to remove + */ + HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup ); + + /** + * Removes all reference geometry groups from calculation case. + */ + HYDRODATA_EXPORT virtual void RemoveGeometryGroups(); + + /** * Sets reference boundary polyline object for calculation case. */ @@ -107,25 +188,74 @@ public: HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline(); + /** + * Sets reference Strickler table for calculation case. + */ + HYDRODATA_EXPORT virtual void SetStricklerTable( const Handle(HYDROData_StricklerTable)& theStricklerTable ); + + /** + * Returns reference Strickler table of calculation case. + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_StricklerTable) GetStricklerTable() const; + + /** + * Remove reference Strickler table from calculation case. + */ + HYDRODATA_EXPORT virtual void RemoveStricklerTable(); + + + /** + * Add new one reference Land Cover for calculation case. + * \param theLandCover the Land Cover to add + * \return true in case of success + */ + HYDRODATA_EXPORT virtual bool AddLandCover( const Handle(HYDROData_LandCover)& theLandCover ); + + /** + * Returns all reference Land Covers of calculation case. + * \return the list of referenced Land Covers + */ + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetLandCovers() const; + + /** + * Removes reference Land Cover from calculation case. + * \param theLandCover the Land Cover to remove + */ + HYDRODATA_EXPORT virtual void RemoveLandCover( const Handle(HYDROData_LandCover)& theLandCover ); + + /** + * Removes all reference Land Covers from calculation case. + */ + HYDRODATA_EXPORT virtual void RemoveLandCovers(); + + /** * Add new one child region for calculation case. * The new region is added into the list of reference regions. * The label of theZone is changed during this operation * because of new region becomes the new parent for this zone. + * \param theLandCover if true - Land Cover region will be added + * \return the created region */ - HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone ); + HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone, + const bool theLandCover ); /** * Add new one reference region for calculation case. * The label of theRegion is changed in case if old parent is not this calculation. + * \param theLandCover if true - Land Cover region will bw created + * \return true in case of success */ - HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion ); + HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion, + const bool theLandCover ); /** * Returns all reference regions of calculation case. + * \param theLandCover if true - Land Cover regions will be returned + * \return the list of reference regions */ - HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions() const; + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions( const bool theLandCover ) const; /** * Updates names of regions to correct order. @@ -134,19 +264,147 @@ public: /** * Removes reference region from calculation case. + * \param theRegion the region to remove + * \param theLandCover if true - it means that Land Cover region to be removed */ - HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion ); + HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion, + const bool theLandCover ); /** * Removes all reference regions from calculation case. + * \param theLandCover if true - it means that Land Cover regions to be removed + */ + HYDRODATA_EXPORT virtual void RemoveRegions( const bool theLandCover ); + + /** + * Returns all reference geometry groups of calculation case. + */ + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetSplittedGroups() const; + + /** + * Removes all reference geometry groups from calculation case. + */ + HYDRODATA_EXPORT virtual void RemoveSplittedGroups(); + + /** + * Exports the calculation case data (shell and groups) to GEOM module. + * \param theStudyId the id of the study where the GEOM module should be used for export + * \return the entry of the GEOM object (empty string in the case of error) + */ + HYDRODATA_EXPORT virtual QString Export( int theStudyId ) const; + + /** + * Exports the calculation case data (shell and groups) to GEOM module. + * \param theGeomEngine GEOM module engine + * \param theStudy SALOMEDS study, is used for publishing of GEOM objects + * \return true in case of success + */ + HYDRODATA_EXPORT virtual bool Export( GEOM::GEOM_Gen_var theGeomEngine, + SALOMEDS::Study_ptr theStudy, + QString& theGeomObjEntry ) const; + +public: + // Public methods to work with Calculation services + + /** + * Returns altitude for given point. + * \param thePoint the point to examine + * \return result altitude value + */ + HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const; + + /** + * Returns altitude for given point on given region. + * \param thePoint the point to examine + * \param theRegion reference region to check + * \return result altitude value + */ + HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint, + const Handle(HYDROData_Region)& theRegion ) const; + + /** + * Returns altitude for given point on given zone. + * \param thePoint the point to examine + * \param theZone reference zone to check + * \return result altitude value + */ + HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint, + const Handle(HYDROData_Zone)& theZone ) const; + + /** + * Returns altitudes for given points on given region. + * \param thePoints the points to examine + * \param theRegion reference region to check + * \return result altitude value + */ + HYDRODATA_EXPORT virtual NCollection_Sequence GetAltitudesForPoints( + const NCollection_Sequence& thePoints, + const Handle(HYDROData_Region)& theRegion ) const; + + /** + * Returns altitudes for given points on given zone. + * \param thePoints the points to examine + * \param theZone reference zone to check + * \return result altitude value + */ + HYDRODATA_EXPORT virtual NCollection_Sequence GetAltitudesForPoints( + const NCollection_Sequence& thePoints, + const Handle(HYDROData_Zone)& theZone ) const; + + /** + * Returns region to which the point is belongs. + * \param thePoint the point to examine + * \param theLandCover the flag indicating, + * if it is needed to search Land Cover region + * \return result region */ - HYDRODATA_EXPORT virtual void RemoveRegions(); + HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint, + const bool theLandCover ) const; /** - * Returns shell containing faces which correspond to regions. - * \return shell as TopoDS_Shell + * Returns zone to which the point is belongs. + * \param thePoint the point to examine + * \param theLandCover the flag indicating, + * if it is needed to search Land Cover zone + * \return result zone */ - HYDRODATA_EXPORT virtual TopoDS_Shell GetShell(); + HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint, + const bool theLandCover ) const; + + /** + * Returns classification of point for given zone. + * \param thePoint the point to examine + * \param theZone the zone to examine + * \return result classification + */ + HYDRODATA_EXPORT virtual PointClassification GetPointClassification( + const gp_XY& thePoint, + const Handle(HYDROData_Zone)& theZone ) const; + + HYDRODATA_EXPORT void SetAssignmentMode( AssignmentMode theMode ); + HYDRODATA_EXPORT AssignmentMode GetAssignmentMode() const; + + HYDRODATA_EXPORT void ClearRules( HYDROData_CalculationCase::DataTag theDataTag, + const bool theIsSetToUpdate = true ); + HYDRODATA_EXPORT void AddRule( const Handle(HYDROData_Entity)& theObject1, + HYDROData_PriorityType thePriority, + const Handle(HYDROData_Entity)& theObject2, + HYDROData_Zone::MergeType theMergeType, + HYDROData_CalculationCase::DataTag theDataTag ); + HYDRODATA_EXPORT bool GetRule( int theIndex, + Handle(HYDROData_Entity)& theObject1, + HYDROData_PriorityType& thePriority, + Handle(HYDROData_Entity)& theObject2, + HYDROData_Zone::MergeType& theMergeType, + HYDROData_CalculationCase::DataTag& theDataTag ) const; + + HYDRODATA_EXPORT void SetAssignmentLandCoverMode( AssignmentMode theMode ); + HYDRODATA_EXPORT AssignmentMode GetAssignmentLandCoverMode() const; + + HYDRODATA_EXPORT QString DumpRules() const; + HYDRODATA_EXPORT QString DumpLandCoverRules() const; + + HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const; private: @@ -154,11 +412,54 @@ private: * Add new one region for calculation case. * The new region is added into the list of reference regions. */ - HYDRODATA_EXPORT virtual Handle(HYDROData_Region) addNewRegion(); + Handle(HYDROData_Region) addNewRegion( const Handle(HYDROData_Document)& theDoc, + const QString& thePrefixOrName, + const bool theLandCover, + bool isPrefix = true ); + /** + * Add new one splitted edges group for calculation case. + */ + Handle(HYDROData_SplittedShapesGroup) addNewSplittedGroup( const QString& theName ); -protected: + /** + * Exports the given faces as shell and the given groups to GEOM module. + * \param theGeomEngine GEOM module engine + * \param theStudy SALOMEDS study, is used for publishing of GEOM objects + * \param theFaces the list of faces to make shell + * \param theSplittedGroups the list of groups + * \return true in case of success + */ + bool Export( GEOM::GEOM_Gen_var theGeomEngine, + SALOMEDS::Study_ptr theStudy, + const TopTools_ListOfShape& theFaces, + const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs, + QString& theGeomObjEntry ) const; + + void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc, + const HYDROData_SplitToZonesTool::SplitDataList& theZones, + const bool theLandCover ); + void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc, + const HYDROData_SplitToZonesTool::SplitDataList& theZones, + const bool theLandCover ); + + void CreateEdgeGroupsDef( const Handle(HYDROData_Document)& theDoc, + const HYDROData_SplitToZonesTool::SplitDataList& theEdges ); + + void DumpRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const; + void DumpLandCoverRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const; + + void SetWarning( HYDROData_WarningType theType = WARN_OK, const QString& theData = "" ); + + void UpdateRegionsNames( const HYDROData_SequenceOfObjects& theRegions, + const QString& theOldCaseName, + const QString& theName ); + + void DumpRegionsToPython( QStringList& theResList, + MapOfTreatedObjects& theTreatedObjects, + const HYDROData_SequenceOfObjects& theRegions ) const; +protected: friend class HYDROData_Iterator; /** @@ -171,6 +472,14 @@ protected: * Destructs properties of the object and object itself, removes it from the document. */ HYDRODATA_EXPORT ~HYDROData_CalculationCase(); + + void DumpSampleMeshing( QStringList& theScript, + const QString& theStudyName, + const QString& theGeomShapeName, + const QString& theMeshName ) const; + +private: + HYDROData_Warning myLastWarning; }; #endif