Changeset 201 in pacpusframework for trunk/include

Timestamp:

10/28/13 15:24:14 (11 years ago)

Author:

Marek Kurdej

Message:

Major: rethrow PacpusException on parameter parsing, set configurationState to ComponentBase::CONFIGURED_FAILED.

File:

• trunk/include/Pacpus/kernel/ComponentBase.h (modified) (2 diffs)

trunk/include/Pacpus/kernel/ComponentBase.h

@@ -59 +59 @@
 using ::boost::program_options::value;
 
-/** ComponentBase
- * @brief Base class of a Pacpus component.
- */
+/// @brief Base class of a Pacpus component.
 class PACPUSLIB_API ComponentBase
 {
@@ -67 +65 @@
 
 public:
-    /**
-     * Enumeration of the state that can take a component, the three last states suppose
-     * that the component is started.
-     */
-    enum COMPONENT_STATE
-    {
-      STOPPED,
-      NOT_MONITORED,
-      MONITOR_OK,
-      MONITOR_NOK
+    /// Enumeration of the state that can take a component, the three last states suppose
+    /// that the component is started.
+    enum COMPONENT_STATE {
+        STOPPED,
+        NOT_MONITORED,
+        MONITOR_OK,
+        MONITOR_NOK
     };
 
-    /** Resulting state of a component after its configuration. */
-    enum COMPONENT_CONFIGURATION
-    {
-      CONFIGURED_OK,
-      NOT_CONFIGURED,
-      CONFIGURATION_DELAYED,
-      CONFIGURED_FAILED
+    /// Resulting state of a component after its configuration.
+    enum COMPONENT_CONFIGURATION {
+        CONFIGURED_OK,
+        NOT_CONFIGURED,
+        CONFIGURATION_DELAYED,
+        CONFIGURED_FAILED
     };
 
-    /** Ctor of ComponentBase.
-     * @param name Name of your component.
-     */
+    /// Ctor of ComponentBase.
+    /// @param name Name of your component.
     ComponentBase(const QString& name);
 
-    /** Dtor of ComponentBase. */
+    /// Dtor of ComponentBase.
     virtual ~ComponentBase();
 
-    /** Return the state of the component.
-     * @return Value of the current state.
-     */
+    /// Returns the state of the component.
+    /// @return Value of the current state.
     COMPONENT_STATE getState();
 
-    /** Check whether the component if configurer or not.
-     * @return True if the component is configured, otherwise false.
-     */
+    /// Checks whether the component if configurer or not.
+    /// @return @b true if the component is configured, otherwise @b false.
     bool isConfigured() const;
 
-    /** Return the name of the component.
-     * @return Name of the component.
-     */
+    /// Returns the name of the component.
+    /// @return Name of the component.
     QString getName() const;
 
+    /// @todo DOC
     InputInterfaceBase * getInput(QString name) const;
 
+    /// @todo DOC
     OutputInterfaceBase * getOutput(QString name) const;
 
 protected:
-    /** Change the state of the component.
-     * @param state New component state.
-     */
+    /// Changes the state of the component.
+    /// @param state New component state.
     void setState(COMPONENT_STATE state);
 
-    /** Called when the component starts, you must override this function. */
+    /// Called when the component starts, you must override this function.
     virtual void startActivity() = 0;
 
-    /** Called when the component stops, you must override this function. */
+    /// Called when the component stops, you must override this function.
     virtual void stopActivity() = 0;
 
-    /** Called by the ComponentManager, it configure the component thanks a XML node.
-     * @param config Component's XML node.
-     * @return State of the configuration.
-     * FIXME: 'config' should be const, but we can't change the prototype without breaking
-     * old stuff.
-     */
+    /// Called by the ComponentManager, it configure the component thanks a XML node.
+    /// @param config Component's XML node.
+    /// @return State of the configuration.
+    /// @todo FIXME: 'config' should be const, but it will be a breaking change
+    /// old stuff.
     virtual COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config) = 0;
 
     // virtual QString getType() = 0;
 
-    // Not Pure virtual, no need to implement if not needed !!!
+    /// @todo FIXME: should be pure virtual, but it will be a breaking change
     virtual void addInputs() {}
     virtual void addOutputs() {}
 
+    /// Returns an object permitting to add component parameters.
     ::boost::program_options::options_description_easy_init addParameters();