Salome HOME
Update the doxygen documentation for plugins
[modules/shaper.git] / src / PartSetPlugin / PartSetPlugin_Plugin.h
index a4c7e336da1c6cc755d351a9698d0b08c11f4396..59ace5aa844925d932003f95b08eb89d41727d25 100644 (file)
@@ -1,24 +1,38 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        PartSetPlugin_Plugin.hxx
 // Created:     31 Mar 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef PartSetPlugin_Plugin_HeaderFile
-#define PartSetPlugin_Plugin_HeaderFile
+#ifndef PartSetPlugin_Plugin_H_
+#define PartSetPlugin_Plugin_H_
+
+#include <PartSetPlugin.h>
+#include <ModelAPI_Plugin.h>
+#include <ModelAPI_Feature.h>
+#include <ModelAPI_Events.h>
 
+#include <Events_Listener.h>
 
-#include "PartSetPlugin.h"
-#include "ModelAPI_Plugin.h"
+#include <memory>
 
-class PARTSETPLUGIN_EXPORT PartSetPlugin_Plugin: public ModelAPI_Plugin
+/**\class FeaturesPlugin_Plugin
+ * \ingroup Plugins
+ * \brief The main class for management the part set operations as plugin.
+ */
+class PARTSETPLUGIN_EXPORT PartSetPlugin_Plugin : public ModelAPI_Plugin,
+                                                  public Events_Listener
 {
-public:
+ public:
   /// Creates the feature object of this plugin by the feature string ID
-  virtual std::shared_ptr<ModelAPI_Feature> createFeature(
-    std::string theFeatureID, const bool theAddToDoc);
+  virtual FeaturePtr createFeature(std::string theFeatureID);
 
-public:
   /// Is needed for python wrapping by swig
   PartSetPlugin_Plugin();
+
+  //! Redefinition of Events_Listener method
+  virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
+  std::shared_ptr<ModelAPI_FeatureStateMessage> getFeaturesState();
 };
 
 #endif