Changeset 116 in pacpusframework for trunk/include/Pacpus/kernel/ComponentBase.h

Timestamp:

06/25/13 13:44:25 (11 years ago)

Author:

Marek Kurdej

Message:

Added: PacpusException - base class for all exceptions. DbiteExceptions inherits from it.
Added: PacpusLibConfig.h - dllimport/dllexport clauses separated from pacpus.h.
Update: comments.

File:

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

trunk/include/Pacpus/kernel/ComponentBase.h

@@ -23 +23 @@
 
 #include <Pacpus/kernel/ComponentManager.h>
-#include <Pacpus/kernel/pacpus.h>
+#include <Pacpus/kernel/PacpusLibConfig.h>
 #include <Pacpus/kernel/XmlComponentConfig.h>
 
@@ -33 +33 @@
 class ComponentManager;
 
-/** ComponentBase
- * @brief Base class of a Pacpus component.
- */
+/// Base class of a Pacpus component.
 class PACPUSLIB_API ComponentBase
 {
     friend class ComponentManager;
+
 public:
-    /**
-     * Enumeration of the state that can take a component, the three last states suppose
-     * that the component is started.
-     */
+    /// 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
+        STOPPED,
+        NOT_MONITORED,
+        MONITOR_OK,
+        MONITOR_NOK
     };
 
-    /** Resulting state of a component after its configuration. */
+    /// Resulting state of a component after its configuration.
     enum COMPONENT_CONFIGURATION
     {
-      CONFIGURED_OK,
-      NOT_CONFIGURED,
-      CONFIGURATION_DELAYED,
-      CONFIGURED_FAILED
+        CONFIGURED_OK,
+        NOT_CONFIGURED,
+        CONFIGURATION_DELAYED,
+        CONFIGURED_FAILED
     };
 
-    /** Ctor of ComponentBase.
-     * @param name Name of your component.
-     */
-    ComponentBase(const QString& name);
+    /// 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 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.
+    /// @returns @b true if the component is configured, @b false otherwise.
     bool isConfigured() const;
 
 protected:
-    /** Change the state of the component.
-     * @param state New component state.
-     */
+    /// Change 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.
+    /// @returns State of the configuration.
+    /// @todo FIXME: 'config' should be const, but we can't change the prototype without breaking old stuff.
     virtual COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config) = 0;
-    
+
 protected:
     /// The XML node that is got in the configureComponent method
@@ -132 +122 @@
 };
 
-} // pacpus
+} // namespace pacpus
 
 #endif // DEF_PACPUS_COMPONENTBASE_H