X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_DataMapOfShapeShape.h;h=545608fdef8b26f2bc821165a17e2487e5e9ce49;hb=8f060aedd5949990421a96e3b4086f43efa13d24;hp=e67645e72efdb0a8cb2f8fdee2a617cf30ee28fb;hpb=a7f44a41bdf29e7bd978ff3b8c8bd514d1223be7;p=modules%2Fshaper.git diff --git a/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h b/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h index e67645e72..545608fde 100644 --- a/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h +++ b/src/GeomAPI/GeomAPI_DataMapOfShapeShape.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: GeomAPI_DataMapOfShapeShape.h // Created: 28 Oct 2014 // Author: Sergey Zaritchny @@ -8,39 +10,53 @@ #include #include -class GeomAPI_Pnt; -class GeomAPI_Dir; +#include /**\class GeomAPI_DataMapOfShapeShape * \ingroup DataModel * \brief DataMap of Shape - Shape defined by TopoDS_Shapes */ - -class GEOMAPI_EXPORT GeomAPI_DataMapOfShapeShape : public GeomAPI_Interface +class GeomAPI_DataMapOfShapeShape : public GeomAPI_Interface { public: - /// Creation of plane by the point and normal + /// Constructor. + GEOMAPI_EXPORT GeomAPI_DataMapOfShapeShape(); - /// Clear + /// Clears map. + GEOMAPI_EXPORT void clear(); - /// Size of the map + /// Size of the map. + GEOMAPI_EXPORT int size(); - /// Adds the Key to the Map with the Item. Returns True if the Key was not already in the map - 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. + GEOMAPI_EXPORT void merge(const GeomAPI_DataMapOfShapeShape& theDataMap); + + /// Merges two maps. + GEOMAPI_EXPORT void merge(const std::shared_ptr theDataMap); + + /// \return true if theKey is stored in the map. + GEOMAPI_EXPORT + bool isBound (const std::shared_ptr theKey); - /// Returns true if theKey is stored in the map. - bool isBound (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); - /// Returns the Item stored with the Key in the Map. - const std::shared_ptr find(std::shared_ptr theKey); - - /// Removes the Key from the map. Returns true if the Key was in the Map - bool unBind(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_DataMapOfShapeShape(); };