From 91e77c1e07844994d87378f18b8f577c211852ba Mon Sep 17 00:00:00 2001 From: mzn Date: Fri, 19 Jun 2015 17:21:11 +0300 Subject: [PATCH] refs #570: documentation update. --- src/HYDROData/HYDROData_CalculationCase.h | 31 +++++++++++++++++------ src/HYDROData/HYDROData_Zone.h | 8 ++++++ 2 files changed, 31 insertions(+), 8 deletions(-) diff --git a/src/HYDROData/HYDROData_CalculationCase.h b/src/HYDROData/HYDROData_CalculationCase.h index 79e78705..9d84b3d4 100644 --- a/src/HYDROData/HYDROData_CalculationCase.h +++ b/src/HYDROData/HYDROData_CalculationCase.h @@ -139,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 ); @@ -150,6 +151,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 ); @@ -160,6 +162,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 ); @@ -185,7 +188,7 @@ public: HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline(); - /** + /** * Sets reference Strickler table for calculation case. */ HYDRODATA_EXPORT virtual void SetStricklerTable( const Handle(HYDROData_StricklerTable)& theStricklerTable ); @@ -202,22 +205,26 @@ public: /** - * Add new one reference land cover for calculation case. + * 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. + * 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. + * 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. + * Removes all reference Land Covers from calculation case. */ HYDRODATA_EXPORT virtual void RemoveLandCovers(); @@ -227,6 +234,8 @@ public: * 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, const bool theLandCover ); @@ -235,13 +244,16 @@ public: /** * 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, const bool theLandCover ); /** * Returns all reference regions of calculation case. - * \param theLandCover if true - land cover regions will be returned + * \param theLandCover if true - Land Cover regions will be returned + * \return the list of reference regions */ HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions( const bool theLandCover ) const; @@ -252,12 +264,15 @@ 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, 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 ); @@ -340,7 +355,7 @@ public: * 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 + * if it is needed to search Land Cover region * \return result region */ HYDRODATA_EXPORT virtual Handle(HYDROData_Region) GetRegionFromPoint( const gp_XY& thePoint, @@ -350,7 +365,7 @@ public: * 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 + * if it is needed to search Land Cover zone * \return result zone */ HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint, diff --git a/src/HYDROData/HYDROData_Zone.h b/src/HYDROData/HYDROData_Zone.h index 3f95324c..cde3b789 100644 --- a/src/HYDROData/HYDROData_Zone.h +++ b/src/HYDROData/HYDROData_Zone.h @@ -135,11 +135,13 @@ public: /** * Sets the reference object to resolve the conflict. * This object is used only in case of "Merge_Object" merge type. + * \param theObject the merge object */ HYDRODATA_EXPORT virtual void SetMergeObject( const Handle(HYDROData_Entity)& theObject ); /** * Returns the reference object to resolve the conflict. + * \return the merge object */ HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetMergeObject() const; @@ -150,11 +152,13 @@ public: /** * Add new one object for zone. + * \param theObject the object to add */ HYDRODATA_EXPORT virtual bool AddObject( const Handle(HYDROData_Entity)& theObject ); /** * Returns all objects of zone. + * \return the list of objects */ HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetObjects() const; @@ -163,6 +167,10 @@ public: */ HYDRODATA_EXPORT virtual void RemoveObjects(); + /** + * Returns submersible flag. + * \return true if all objects of the zone is submersible + */ HYDRODATA_EXPORT bool IsSubmersible() const; protected: -- 2.39.2