X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_CalculationCase.h;h=a54800f13544cbadbfe469cfdfa3d46cf2c9108a;hb=f9bd5128a1aed8c1974b1d1cfb87aff32191fa60;hp=d3f6bcda7dad82250078ef9e6f8067fbcde6ecdf;hpb=4564a2513ac7a519741895560f26d7eef1d1400d;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_CalculationCase.h b/src/HYDROData/HYDROData_CalculationCase.h index d3f6bcda..a54800f1 100644 --- a/src/HYDROData/HYDROData_CalculationCase.h +++ b/src/HYDROData/HYDROData_CalculationCase.h @@ -1,19 +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_EdgesGroup); +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) @@ -33,7 +63,13 @@ public: POINT_ON ///< point is on the edge of zone face }; -protected: + enum AssignmentMode + { + MANUAL = 0, + AUTOMATIC, + }; + +public: /** * Enumeration of tags corresponding to the persistent object parameters. @@ -41,12 +77,18 @@ 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_GeometryGroup, ///< reference geometry groups - DataTag_SplittedGroups, ///< reference splitted groups + 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 }; public: @@ -60,7 +102,7 @@ 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 ); @@ -107,7 +149,7 @@ public: /** * Add new one reference geometry group for calculation case. */ - HYDRODATA_EXPORT virtual bool AddGeometryGroup( const Handle(HYDROData_EdgesGroup)& theGroup ); + HYDRODATA_EXPORT virtual bool AddGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup ); /** * Returns all reference geometry groups of calculation case. @@ -117,7 +159,7 @@ public: /** * Removes reference geometry group from calculation case. */ - HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_EdgesGroup)& theGroup ); + HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup ); /** * Removes all reference geometry groups from calculation case. @@ -141,6 +183,43 @@ 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. + */ + HYDRODATA_EXPORT virtual bool AddLandCover( const Handle(HYDROData_LandCover)& theLandCover ); + + /** + * Returns all reference land covers of calculation case. + */ + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetLandCovers() const; + + /** + * Removes reference land cover from calculation case. + */ + 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. @@ -176,12 +255,33 @@ public: */ HYDRODATA_EXPORT virtual void RemoveRegions(); + /** - * Returns shell containing faces which correspond to regions. - * \return shell as TopoDS_Shell + * Returns all reference geometry groups of calculation case. */ - HYDRODATA_EXPORT virtual TopoDS_Shell GetShell(); + 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 @@ -193,6 +293,51 @@ public: */ 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 + * \return result region + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint ) const; + /** * Returns zone to which the point is belongs. * \param thePoint the point to examine @@ -210,17 +355,72 @@ public: 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::MergeAltitudesType theMergeType, + HYDROData_CalculationCase::DataTag theDataTag ); + HYDRODATA_EXPORT bool GetRule( int theIndex, + Handle(HYDROData_Entity)& theObject1, + HYDROData_PriorityType& thePriority, + Handle(HYDROData_Entity)& theObject2, + HYDROData_Zone::MergeAltitudesType& theMergeType, + HYDROData_CalculationCase::DataTag& theDataTag ) const; + + HYDRODATA_EXPORT void SetAssignmentLandCoverMode( AssignmentMode theMode ); + HYDRODATA_EXPORT AssignmentMode GetAssignmentLandCoverMode() const; + + HYDRODATA_EXPORT QString DumpRules() const; + + HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const; + 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, + 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 ); + void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc, + const HYDROData_SplitToZonesTool::SplitDataList& theZones ); + + void CreateEdgeGroupsDef( const Handle(HYDROData_Document)& theDoc, + const HYDROData_SplitToZonesTool::SplitDataList& theEdges ); + + void DumpRulesToPython( const QString& theCalcCaseName, QStringList& theScript ) const; + + void SetWarning( HYDROData_WarningType theType = WARN_OK, const QString& theData = "" ); +protected: friend class HYDROData_Iterator; /** @@ -233,6 +433,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