X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_CalculationCase.h;h=1a4eb3115bb565fa6739cdd2ccb5d625e4c50455;hb=545854182f0363f61284d5abe34c3627d4f3b088;hp=4f0ed90f7ed4aa8b15d77e4a788a0145b6ab38f4;hpb=4b4f8231de194f5830fe198d00b9c687de081a4a;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_CalculationCase.h b/src/HYDROData/HYDROData_CalculationCase.h index 4f0ed90f..1a4eb311 100644 --- a/src/HYDROData/HYDROData_CalculationCase.h +++ b/src/HYDROData/HYDROData_CalculationCase.h @@ -1,4 +1,20 @@ - +// 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 @@ -9,9 +25,19 @@ #include #include +#ifdef WIN32 + #pragma warning ( disable: 4251 ) +#endif + +#ifndef LIGHT_MODE // IDL includes #include #include CORBA_SERVER_HEADER(GEOM_Gen) +#endif + +#ifdef WIN32 + #pragma warning( default: 4251 ) +#endif class gp_XY; @@ -26,6 +52,8 @@ class Handle(HYDROData_PolylineXY); class Handle(HYDROData_ShapesGroup); class Handle(HYDROData_SplittedShapesGroup); class Handle(HYDROData_Document); +class Handle(HYDROData_StricklerTable); +class Handle(HYDROData_LandCoverMap); DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity) @@ -59,14 +87,22 @@ public: 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_CustomRules, ///< custom rules - DataTag_AssignmentMode, ///< assignment mode + 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_Obsolete, ///< reference land covers + DataTag_CustomLandCoverRules_Obsolete, ///< custom rules for land covers priority + DataTag_AssignmentLandCoverMode_Obsolete, ///< assignment mode of land covers priority + DataTag_ChildLandCoverRegion_Obsolete, ///< child land cover regions + DataTag_LandCoverRegion_Obsolete ///< reference land cover regions + }; public: @@ -82,7 +118,7 @@ public: * Updates the name of this object. * 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. @@ -115,6 +151,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 ); @@ -126,6 +163,7 @@ public: /** * 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 ); @@ -136,6 +174,7 @@ public: /** * Removes reference geometry group from calculation case. + * \param theGroup the group to remove */ HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup ); @@ -161,23 +200,47 @@ 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(); + + /** + * Returns reference Land Cover Map of calculation case. + * \return the referenced Land Cover Map + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_LandCoverMap) GetLandCoverMap() const; + /** * 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. + * \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 ); /** * Add new one reference region for calculation case. * The label of theRegion is changed in case if old parent is not this calculation. + * \return true in case of success */ HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion ); /** * Returns all reference regions of calculation case. + * \return the list of reference regions */ HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions() const; @@ -188,15 +251,15 @@ public: /** * Removes reference region from calculation case. + * \param theRegion the region to remove */ - HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion ); + HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion ); /** * Removes all reference regions from calculation case. */ HYDRODATA_EXPORT virtual void RemoveRegions(); - /** * Returns all reference geometry groups of calculation case. */ @@ -218,11 +281,16 @@ public: * 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 + * \param theGeomObjEntry the published GEOM object entry + * \param theErrorMsg the error message * \return true in case of success */ +#ifndef LIGHT_MODE HYDRODATA_EXPORT virtual bool Export( GEOM::GEOM_Gen_var theGeomEngine, SALOMEDS::Study_ptr theStudy, - QString& theGeomObjEntry ) const; + QString& theGeomObjEntry, + QString& theErrorMsg ) const; +#endif public: // Public methods to work with Calculation services @@ -252,6 +320,13 @@ public: HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint, const Handle(HYDROData_Zone)& theZone ) const; + /** + * Returns strickler coefficient for given point. + * \param thePoint the point to examine + * \return result strickler coefficient + */ + HYDRODATA_EXPORT double GetStricklerCoefficientForPoint( const gp_XY& thePoint ) const; + /** * Returns altitudes for given points on given region. * \param thePoints the points to examine @@ -275,6 +350,7 @@ public: /** * Returns region to which the point is belongs. * \param thePoint the point to examine + * if it is needed to search Land Cover region * \return result region */ HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint ) const; @@ -282,6 +358,7 @@ public: /** * Returns zone to which the point is belongs. * \param thePoint the point to examine + * if it is needed to search Land Cover zone * \return result zone */ HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint ) const; @@ -299,16 +376,19 @@ public: HYDRODATA_EXPORT void SetAssignmentMode( AssignmentMode theMode ); HYDRODATA_EXPORT AssignmentMode GetAssignmentMode() const; - HYDRODATA_EXPORT void ClearRules( const bool theIsSetToUpdate = true ); - HYDRODATA_EXPORT void AddRule( const Handle(HYDROData_Object)& theObject1, - HYDROData_PriorityType thePriority, - const Handle(HYDROData_Object)& theObject2, - HYDROData_Zone::MergeAltitudesType theMergeType ); + 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_Object)& theObject1, + Handle(HYDROData_Entity)& theObject1, HYDROData_PriorityType& thePriority, - Handle(HYDROData_Object)& theObject2, - HYDROData_Zone::MergeAltitudesType& theMergeType ) const; + Handle(HYDROData_Entity)& theObject2, + HYDROData_Zone::MergeType& theMergeType, + HYDROData_CalculationCase::DataTag& theDataTag ) const; HYDRODATA_EXPORT QString DumpRules() const; @@ -337,26 +417,14 @@ private: * \param theSplittedGroups the list of groups * \return true in case of success */ +#ifndef LIGHT_MODE bool Export( GEOM::GEOM_Gen_var theGeomEngine, SALOMEDS::Study_ptr theStudy, const TopTools_ListOfShape& theFaces, const HYDROData_ShapesGroup::SeqOfGroupsDefs& theGroupsDefs, QString& theGeomObjEntry ) const; - - /** - * Publish the given shape in GEOM as a GEOM object. - * \param theGeomEngine GEOM module engine - * \param theStudy SALOMEDS study, used for publishing of the shape - * \param theShape the shape to publish as a GEOM object - * \param theName the name of the published object - * \return the published GEOM object - */ - GEOM::GEOM_Object_ptr publishShapeInGEOM( GEOM::GEOM_Gen_var theGeomEngine, - SALOMEDS::Study_ptr theStudy, - const TopoDS_Shape& theShape, - const QString& theName, - QString& theGeomObjEntry ) const; - +#endif + void CreateRegionsDef( const Handle(HYDROData_Document)& theDoc, const HYDROData_SplitToZonesTool::SplitDataList& theZones ); void CreateRegionsAuto( const Handle(HYDROData_Document)& theDoc, @@ -369,6 +437,14 @@ private: 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;