X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_DataMapOfShapeShape.h;h=545608fdef8b26f2bc821165a17e2487e5e9ce49;hb=8f060aedd5949990421a96e3b4086f43efa13d24;hp=42c8a86d1329e631ef4c4cb3a595d34545a2dc62;hpb=a95effb94656e5d4721f86ccb6ffbc2572bb1214;p=modules%2Fshaper.git diff --git a/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h b/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h index 42c8a86d1..545608fde 100644 --- a/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h +++ b/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h @@ -10,8 +10,7 @@ #include #include -class GeomAPI_Pnt; -class GeomAPI_Dir; +#include /**\class GeomAPI_DataMapOfShapeShape * \ingroup DataModel @@ -20,42 +19,44 @@ class GeomAPI_Dir; class GeomAPI_DataMapOfShapeShape : public GeomAPI_Interface { public: - /// Creation of plane by the point and normal - GEOMAPI_EXPORT + /// Constructor. + GEOMAPI_EXPORT GeomAPI_DataMapOfShapeShape(); - /// Clear - GEOMAPI_EXPORT + /// Clears map. + GEOMAPI_EXPORT void clear(); - /// Size of the map - GEOMAPI_EXPORT + /// Size of the map. + GEOMAPI_EXPORT int size(); - /// Adds \a theKey to me with \a theItem. Returns True if the Key was not already in the map - GEOMAPI_EXPORT - bool bind (std::shared_ptr theKey, std::shared_ptr theItem); + /// Adds \a theKey to me with \a theItem. Returns True if the Key was not already in the map. + GEOMAPI_EXPORT + bool bind (const std::shared_ptr theKey, + const std::shared_ptr theItem); - /// Merges two maps + /// Merges two maps. GEOMAPI_EXPORT void merge(const GeomAPI_DataMapOfShapeShape& theDataMap); - /// Merges two maps + /// Merges two maps. GEOMAPI_EXPORT void merge(const std::shared_ptr theDataMap); - /// Returns true if theKey is stored in the map. - GEOMAPI_EXPORT - bool isBound (std::shared_ptr theKey); + /// \return true if theKey is stored in the map. + GEOMAPI_EXPORT + bool isBound (const std::shared_ptr theKey); - /// Returns the Item stored with the Key in the Map. - GEOMAPI_EXPORT - const std::shared_ptr find(std::shared_ptr theKey); - - /// Removes the Key from the map. Returns true if the Key was in the Map - GEOMAPI_EXPORT - bool unBind(std::shared_ptr theKey); + /// \return the Item stored with the Key in the Map. + GEOMAPI_EXPORT + const std::shared_ptr find(const std::shared_ptr theKey); + + /// \brief Removes the Key from the map. + /// \return true if the Key was in the Map. + GEOMAPI_EXPORT + bool unBind(const std::shared_ptr theKey); /// Destructor - GEOMAPI_EXPORT + GEOMAPI_EXPORT ~GeomAPI_DataMapOfShapeShape(); };