X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_MakeShapeList.h;h=179e0d1832f52d54ba3465cb3f544c07d5f26350;hb=f0cec241aae9ca16d86e166f45cb5c4987d2c792;hp=7de5773503df3e456d68b4733eaa6fcebeb4b887;hpb=98c1bd47dd95b02b7c512f9fb8b368ef21037635;p=modules%2Fshaper.git diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShapeList.h b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShapeList.h index 7de577350..179e0d183 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShapeList.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShapeList.h @@ -12,10 +12,9 @@ #include -/** \class GeomAlgoAPI_MakeShapeList - * \ingroup DataAlgo - * \brief Interface to the root class of all topological shapes constructions - */ +/// \class GeomAlgoAPI_MakeShapeList +/// \ingroup DataAlgo +/// \brief List of topological shapes constructions class GeomAlgoAPI_MakeShapeList : public GeomAlgoAPI_MakeShape { enum OperationType { @@ -27,18 +26,20 @@ public: /// Default constructor GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShapeList(); - /** \brief Constructor - * \param[in] theMakeShapeList list of algorithms. - */ + /// \brief Constructor + /// \param[in] theMakeShapeList list of algorithms. GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShapeList(const ListOfMakeShape& theMakeShapeList); - /** \brief Initializes a class with new list of algorithms. - * \param[in] theMakeShapeList list of algorithms. - */ + /// \brief Initializes a class with new list of algorithms. + /// \param[in] theMakeShapeList list of algorithms. GEOMALGOAPI_EXPORT void init(const ListOfMakeShape& theMakeShapeList); + /// \brief Adds algo to the end of list. + /// \param[in] theMakeShape algo to be added. + GEOMALGOAPI_EXPORT void appendAlgo(const std::shared_ptr theMakeShape); + /// \return a shape built by the shape construction algorithms - GEOMALGOAPI_EXPORT const std::shared_ptr shape() const; + GEOMALGOAPI_EXPORT virtual const std::shared_ptr shape() const; /// \return the list of shapes generated from the shape \a theShape GEOMALGOAPI_EXPORT virtual void generated(const std::shared_ptr theShape, @@ -48,17 +49,16 @@ public: GEOMALGOAPI_EXPORT virtual void modified(const std::shared_ptr theShape, ListOfShape& theHistory); - /// Returns whether the shape is deleted + /// \return whether the shape is deleted GEOMALGOAPI_EXPORT virtual bool isDeleted(const std::shared_ptr theShape); private: void result(const std::shared_ptr theShape, - ListOfShape& theHistory, - OperationType theOperationType); - + OperationType theOperationType, + ListOfShape& theHistory); protected: - ListOfMakeShape myListOfMakeShape; + ListOfMakeShape myListOfMakeShape; ///< List of make shape algos. }; #endif