Salome HOME
Issue #1942: group - names are empty strings
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_MakeShapeList.h
index 7de5773503df3e456d68b4733eaa6fcebeb4b887..179e0d1832f52d54ba3465cb3f544c07d5f26350 100644 (file)
 
 #include <memory>
 
-/** \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<GeomAlgoAPI_MakeShape> theMakeShape);
+
   /// \return a shape built by the shape construction algorithms
-  GEOMALGOAPI_EXPORT const std::shared_ptr<GeomAPI_Shape> shape() const;
+  GEOMALGOAPI_EXPORT virtual const std::shared_ptr<GeomAPI_Shape> shape() const;
 
   /// \return the list of shapes generated from the shape \a theShape
   GEOMALGOAPI_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape> theShape,
@@ -48,17 +49,16 @@ public:
   GEOMALGOAPI_EXPORT virtual void modified(const std::shared_ptr<GeomAPI_Shape> theShape,
                                            ListOfShape& theHistory);
 
-  /// Returns whether the shape is deleted
+  /// \return whether the shape is deleted
   GEOMALGOAPI_EXPORT virtual bool isDeleted(const std::shared_ptr<GeomAPI_Shape> theShape);
 
 private:
   void result(const std::shared_ptr<GeomAPI_Shape> theShape,
-              ListOfShape& theHistory,
-              OperationType theOperationType);
-
+              OperationType theOperationType,
+              ListOfShape& theHistory);
 
 protected:
-  ListOfMakeShape myListOfMakeShape;
+  ListOfMakeShape myListOfMakeShape; ///< List of make shape algos.
 };
 
 #endif