X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_CalculationCase.h;h=750fbfe3e679202f600a8fc6b39ef1253f8c9cc7;hb=c7cf59e092fe050003d1e556715e3ac97acf6bd4;hp=83d75bbeab969b72f10f63a9f6982b7d3d580b40;hpb=34310fe4f26db0f23c2edfef1678e5b02f578204;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_CalculationCase.h b/src/HYDROData/HYDROData_CalculationCase.h index 83d75bbe..750fbfe3 100644 --- a/src/HYDROData/HYDROData_CalculationCase.h +++ b/src/HYDROData/HYDROData_CalculationCase.h @@ -1,16 +1,51 @@ - +// Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE +// +// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS +// +// 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); DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity) @@ -21,8 +56,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. @@ -33,7 +82,11 @@ protected: DataTag_GeometryObject, ///< reference geometry objects DataTag_ChildRegion, ///< child regions DataTag_Region, ///< reference regions - DataTag_Polyline ///< reference boundary polyline + DataTag_Polyline, ///< reference boundary polyline + DataTag_GeometryGroup, ///< reference geometry groups + DataTag_SplittedGroups, ///< reference splitted groups + DataTag_CustomRules, ///< custom rules + DataTag_AssignmentMode, ///< assignment mode }; public: @@ -47,7 +100,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 ); @@ -56,6 +109,12 @@ public: */ HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const; + /** + * Update the calcualtion case object. + * Call this method whenever you made changes for object data. + */ + HYDRODATA_EXPORT virtual void Update(); + /** * Returns the list of all reference objects of this object. */ @@ -64,12 +123,6 @@ public: public: // Public methods to work with Calculation - /** - * Split reference geometry objects to non-intersected regions. - */ - HYDRODATA_EXPORT virtual void SplitGeometryObjects(); - - /** * Add new one reference geometry object for calculation case. */ @@ -91,6 +144,27 @@ public: HYDRODATA_EXPORT virtual void RemoveGeometryObjects(); + /** + * Add new one reference geometry group for calculation case. + */ + 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. + */ + 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. */ @@ -142,11 +216,123 @@ public: */ HYDRODATA_EXPORT virtual void RemoveRegions(); + + /** + * 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(); + /** - * Returns shell containing faces which correspond to regions. - * \return shell as TopoDS_Shell + * 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 TopoDS_Shell GetShell(); + 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 + * \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 + * \return result zone + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint ) 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( 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 bool GetRule( int theIndex, + Handle(HYDROData_Object)& theObject1, + HYDROData_PriorityType& thePriority, + Handle(HYDROData_Object)& theObject2, + HYDROData_Zone::MergeAltitudesType& theMergeType ) const; + + HYDRODATA_EXPORT QString DumpRules() const; + + HYDRODATA_EXPORT HYDROData_Warning GetLastWarning() const; private: @@ -154,11 +340,56 @@ 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; + /** + * 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; + + 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; /** @@ -171,6 +402,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