X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROPy%2FHYDROData_CalculationCase.sip;h=01b1ae04f7d8ef86a4e7cb3120f2f5bd5ea94729;hb=39b1848f103d89cfb544a1651b3fbf221fc2c401;hp=f282d5a9569f0c3027ffeb41c171ab510c5901c6;hpb=0c1af0edfc8153b4572e8758825ec21cc20be1a8;p=modules%2Fhydro.git diff --git a/src/HYDROPy/HYDROData_CalculationCase.sip b/src/HYDROPy/HYDROData_CalculationCase.sip index f282d5a9..01b1ae04 100644 --- a/src/HYDROPy/HYDROData_CalculationCase.sip +++ b/src/HYDROPy/HYDROData_CalculationCase.sip @@ -1,12 +1,8 @@ -// Copyright (C) 2007-2013 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 -// +// 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. +// 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 @@ -22,8 +18,15 @@ %ExportedHeaderCode #include +#include %End +enum HYDROData_PriorityType +{ + LESS, + GREATER, +}; + class HYDROData_CalculationCase : public HYDROData_Entity { @@ -53,6 +56,33 @@ public: POINT_ON ///< point is on the edge of zone face }; + enum AssignmentMode + { + MANUAL = 0, + AUTOMATIC, + }; + +public: + + enum DataTag + { + 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_SplitGroups, ///< reference split 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: /** * Add new one reference geometry object for calculation case. @@ -78,7 +108,8 @@ public: /** * Removes reference geometry object from calculation case. */ - void RemoveGeometryObject( HYDROData_Object theObject ) [void ( const Handle_HYDROData_Object& )]; + void RemoveGeometryObject( HYDROData_Object theObject ) + [void ( const Handle_HYDROData_Object& )]; %MethodCode Handle(HYDROData_Object) aRef = Handle(HYDROData_Object)::DownCast( createHandle( a0 ) ); @@ -264,12 +295,12 @@ public: /** * Returns all reference geometry groups of calculation case. */ - HYDROData_SequenceOfObjects GetSplittedGroups() const; + HYDROData_SequenceOfObjects GetSplitGroups() const; /** * Removes all reference geometry groups from calculation case. */ - void RemoveSplittedGroups(); + void RemoveSplitGroups(); /** @@ -280,10 +311,28 @@ public: */ //TODO: virtual bool Export( GEOM::GEOM_Gen_var theGeomEngine, // SALOMEDS::Study_ptr theStudy ); + + QString Export( int theStudyId ) const; public: // Public methods to work with Calculation services + /** + * Returns strickler coefficient for given point. + * \param thePoint the point to examine + * \return result strickler coefficient + */ + double GetStricklerCoefficientForPoint( const double theCoordX, + const double theCoordY ) const [double ( const gp_XY& ) ]; + %MethodCode + gp_XY aPnt( a0, a1 ); + + Py_BEGIN_ALLOW_THREADS + sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetStricklerCoefficientForPoint( aPnt ) : + sipCpp->GetStricklerCoefficientForPoint( aPnt ); + Py_END_ALLOW_THREADS + %End + /** * Returns altitude for given point. * \param thePoint the point to examine @@ -300,6 +349,27 @@ public: Py_END_ALLOW_THREADS %End + /** + * Returns altitude for given point on given region. + * \param thePoint the point to examine + * \param theRegion reference region to check + * \return result altitude value + */ + double GetAltitudeForPoint( const double theCoordX, + const double theCoordY, + HYDROData_Region theRegion ) const + [double ( const gp_XY&, const Handle_HYDROData_Region& )]; + %MethodCode + gp_XY aPnt( a0, a1 ); + Handle(HYDROData_Region) aRefRegion = + Handle(HYDROData_Region)::DownCast( createHandle( a2 ) ); + + Py_BEGIN_ALLOW_THREADS + sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudeForPoint( aPnt, aRefRegion ) : + sipCpp->GetAltitudeForPoint( aPnt, aRefRegion ); + Py_END_ALLOW_THREADS + %End + /** * Returns altitude for given point on given zone. * \param thePoint the point to examine @@ -309,16 +379,129 @@ public: double GetAltitudeForPoint( const double theCoordX, const double theCoordY, HYDROData_Zone theZone ) const - [double ( const Handle_HYDROData_Zone&, const gp_XY& )]; + [double ( const gp_XY&, const Handle_HYDROData_Zone& )]; %MethodCode gp_XY aPnt( a0, a1 ); - Handle(HYDROData_Zone) aRef = + Handle(HYDROData_Zone) aRefZone = + Handle(HYDROData_Zone)::DownCast( createHandle( a2 ) ); + + Py_BEGIN_ALLOW_THREADS + sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudeForPoint( aPnt, aRefZone ) : + sipCpp->GetAltitudeForPoint( aPnt, aRefZone ); + Py_END_ALLOW_THREADS + %End + + /** + * Returns altitudes for given points on given region. + * \param thePoints the points to examine + * \param theZone reference region to check + * \return result altitude value + */ + NCollection_Sequence GetAltitudesForPoints( const NCollection_Sequence& theCoordsX, + const NCollection_Sequence& theCoordsY, + HYDROData_Region theRegion, + int theMethod = 0) const + [NCollection_Sequence ( const NCollection_Sequence&, const Handle_HYDROData_Region&, int)]; + %MethodCode + + NCollection_Sequence aPnts; + + int aLen = qMin( a0->Length(), a1->Length() ); + for ( int i = 1; i <= aLen; ++i ) + { + gp_XY aPnt( a0->Value( i ), a1->Value( i ) ); + aPnts.Append( aPnt ); + } + + Handle(HYDROData_Region) aRefRegion = + Handle(HYDROData_Region)::DownCast( createHandle( a2 ) ); + int aMethod = a3; + + NCollection_Sequence aRes; + Py_BEGIN_ALLOW_THREADS + aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudesForPoints( aPnts, aRefRegion, aMethod ) : + sipCpp->GetAltitudesForPoints( aPnts, aRefRegion, aMethod ); + Py_END_ALLOW_THREADS + + sipRes = new NCollection_Sequence( aRes ); + %End + + std::vector GetStricklerCoefficientForPoints( const NCollection_Sequence& theCoordsX, + const NCollection_Sequence& theCoordsY, + double DefValue, + bool UseMax ) const + [std::vector ( const NCollection_Sequence&, double, bool)]; + %MethodCode + std::vector aPnts; + int aLen = qMin( a0->Length(), a1->Length() ); + for ( int i = 1; i <= aLen; ++i ) + { + gp_XY aPnt( a0->Value( i ), a1->Value( i ) ); + aPnts.push_back( aPnt ); + } + std::vector aRes; + Py_BEGIN_ALLOW_THREADS + aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetStricklerCoefficientForPoints( aPnts, a2, a3 ) : + sipCpp->GetStricklerCoefficientForPoints( aPnts, a2, a3 ); + Py_END_ALLOW_THREADS + sipRes = new std::vector( aRes ); + %End + + + /** + * Returns altitudes for given points on given zone. + * \param thePoints the points to examine + * \param theZone reference zone to check + * \return result altitude value + */ + NCollection_Sequence GetAltitudesForPoints( const NCollection_Sequence& theCoordsX, + const NCollection_Sequence& theCoordsY, + HYDROData_Zone theZone, + int theMethod = 0) const + [NCollection_Sequence ( const NCollection_Sequence&, const Handle_HYDROData_Zone&, int )]; + %MethodCode + + NCollection_Sequence aPnts; + + int aLen = qMin( a0->Length(), a1->Length() ); + for ( int i = 1; i <= aLen; ++i ) + { + gp_XY aPnt( a0->Value( i ), a1->Value( i ) ); + aPnts.Append( aPnt ); + } + + Handle(HYDROData_Zone) aRefZone = Handle(HYDROData_Zone)::DownCast( createHandle( a2 ) ); + int aMethod = a3; + NCollection_Sequence aRes; + Py_BEGIN_ALLOW_THREADS + aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudesForPoints( aPnts, aRefZone, aMethod ) : + sipCpp->GetAltitudesForPoints( aPnts, aRefZone, aMethod ); + Py_END_ALLOW_THREADS + + sipRes = new NCollection_Sequence( aRes ); + %End + + /** + * Returns region to which the point is belongs. + * \param thePoint the point to examine + * \return result region + */ + HYDROData_Region GetRegionFromPoint( const double theCoordX, + const double theCoordY ) const + [Handle_HYDROData_Region ( const gp_XY& )]; + %MethodCode + Handle(HYDROData_Region) aRes; + + gp_XY aPnt( a0, a1 ); + Py_BEGIN_ALLOW_THREADS - sipRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetAltitudeForPoint( aPnt, aRef ) : - sipCpp->GetAltitudeForPoint( aPnt, aRef ); + aRes = sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::GetRegionFromPoint( aPnt ) : + sipCpp->GetRegionFromPoint( aPnt ); Py_END_ALLOW_THREADS + + sipRes = (HYDROData_Region*)createPointer( aRes ); %End /** @@ -364,6 +547,32 @@ public: Py_END_ALLOW_THREADS %End + + void ClearRules( HYDROData_CalculationCase::DataTag theDataTag ); + + void AddRule( HYDROData_Entity theObject1, + HYDROData_PriorityType thePriority, + HYDROData_Entity theObject2, + HYDROData_Zone::MergeType theMergeType, + HYDROData_CalculationCase::DataTag theDataTag ) + [void ( const Handle_HYDROData_Entity&, HYDROData_PriorityType, const Handle_HYDROData_Entity&, HYDROData_Zone::MergeType, HYDROData_CalculationCase::DataTag )]; + %MethodCode + Handle(HYDROData_Entity) anObject1 = + Handle(HYDROData_Entity)::DownCast( createHandle( a0 ) ); + Handle(HYDROData_Entity) anObject2 = + Handle(HYDROData_Entity)::DownCast( createHandle( a2 ) ); + + Py_BEGIN_ALLOW_THREADS + sipSelfWasArg ? sipCpp->HYDROData_CalculationCase::AddRule( anObject1, a1, anObject2, a3, a4 ) : + sipCpp->AddRule( anObject1, a1, anObject2, a3, a4 ); + Py_END_ALLOW_THREADS + %End + + QString DumpRules(); + + void SetAssignmentMode( AssignmentMode theMode ); + AssignmentMode GetAssignmentMode() const; + protected: /**