Changeset 201 in pacpusframework for trunk

Timestamp:

Oct 28, 2013, 3:24:14 PM (11 years ago)

Author:

Marek Kurdej

Message:

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

Location:

trunk

Files:

• include/Pacpus/kernel/ComponentBase.h (modified) (2 diffs)
• src/PacpusLib/ComponentBase.cpp (modified) (3 diffs)
• src/PacpusLib/ComponentManager.cpp (modified) (9 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();
     

trunk/src/PacpusLib/ComponentBase.cpp

@@ -9 +9 @@
 #include <Pacpus/kernel/ComponentManager.h>
 #include <Pacpus/kernel/Log.h>
+#include <Pacpus/kernel/PacpusException.h>
 
 #include <boost/program_options/parsers.hpp>
@@ -210 +211 @@
     vector<string> xargs = convertAttributesToArgumentVector(cfg.getProperties());
     
-    boost::program_options::variables_map vm;
+    po::variables_map vm;
     try {
         po::store(
@@ -220 +221 @@
         po::notify(vm);
     } catch (po::error & e) {
-        LOG_ERROR(e.what());
-        throw;
+        LOG_WARN(e.what());
+        throw PacpusException(e.what());
     }
 

trunk/src/PacpusLib/ComponentManager.cpp

@@ -13 +13 @@
 #include <Pacpus/kernel/InputOutputBase.h>
 #include <Pacpus/kernel/Log.h>
+#include <Pacpus/kernel/PacpusException.h>
 
 #include <QDomNodeList>
@@ -290 +291 @@
         if (NULL == component) {
             LOG_WARN("component '" << componentName << "' does not exist");
-        } else {
-            component->param.localCopy(cfg.qDomElement());
+            continue;
+        }
+
+        component->param.localCopy(cfg.qDomElement());
+        try {
             component->parseParameters(cfg);
             component->setConfigurationState(component->configureComponent(cfg));
+        } catch (PacpusException & e) {
+            LOG_ERROR("component '" << componentName << "' has thrown an exception");
+            LOG_ERROR(e.what());
+            component->setConfigurationState(ComponentBase::CONFIGURED_FAILED);
         }
     } // for
 
     // Third, if some components requested a delayed configuration, retry
-    for (int i = 0; i < componentsNodeList.size(); ++i) {
+    for (int i = 0, iend = componentsNodeList.size(); i < iend; ++i) {
         cfg.localCopy(componentsNodeList.item(i).toElement());
         QString componentName = cfg.getComponentName();
@@ -305 +313 @@
         if (NULL == component) {
             LOG_WARN("component '" << componentName << "' does not exist");
+            continue;
+        }
+         
+        // Pacpus 2.0 : add inputs and outputs
+        component->addInputs();
+        component->addOutputs();
+
+        if (ComponentBase::CONFIGURATION_DELAYED == component->configurationState()) {
+            LOG_DEBUG("try to configure component '" << componentName << "'");
+
+            // copy locally the config parameters of the component
+            component->param.localCopy(cfg.qDomElement());
+            component->setConfigurationState(component->configureComponent(cfg));
+        }
+
+        if (ComponentBase::CONFIGURED_OK == component->configurationState()) {
+            --componentsToConfigureCount;
         } else {
-           // Pacpus 2.0 : add inputs and outputs
-            component->addInputs();
-            component->addOutputs();
-
-            if (ComponentBase::CONFIGURATION_DELAYED == component->configurationState()) {
-                LOG_DEBUG("try to configure component '" << componentName << "'");
-
-                // copy locally the config parameters of the component
-                component->param.localCopy(cfg.qDomElement());
-                component->setConfigurationState(component->configureComponent(cfg));
-            }
-
-            if (ComponentBase::CONFIGURED_OK == component->configurationState()) {
-                --componentsToConfigureCount;
-            } else {
-                LOG_ERROR("cannot configure component '" << componentName << "'"
-                          << ". Dependencies with other components are too complex"
-                          << ". It was not configured, please review your configuration and/or your component"
-                          );
-                component->setConfigurationState(ComponentBase::CONFIGURED_FAILED);
-            }
+            LOG_ERROR("cannot configure component '" << componentName << "'"
+                        << ". Dependencies with other components are too complex"
+                        << ". It was not configured, please review your configuration and/or your component"
+                        );
+            component->setConfigurationState(ComponentBase::CONFIGURED_FAILED);
         }
     } // for
@@ -338 +347 @@
     QDomNodeList connectionsNodeList = xmlTree_->getAllConnections();
 
-    for (int i = 0; i < connectionsNodeList.size(); ++i) {
+    for (int i = 0, iend = connectionsNodeList.size(); i < iend; ++i) {
         cfg.localCopy(connectionsNodeList.item(i).toElement());
         QString connectionInput = cfg.getConnectionInput();
@@ -372 +381 @@
 }
 
-bool ComponentManager::start(const QString& componentName)
+bool ComponentManager::start(const QString & componentName)
 {
     LOG_TRACE("start(component=" << componentName << ")");
@@ -382 +391 @@
     }
 
+    if (ComponentBase::CONFIGURED_OK != component->configurationState()) {
+        LOG_WARN("cannot start component '" << componentName << "'.  It has not been configured properly!");
+        return false;
+    }
+
     LOG_INFO("starting component '" << componentName << "'...");
     if (!component->startComponent()) {
@@ -402 +416 @@
 }
 
-bool ComponentManager::stop(ComponentBase* component) const
+bool ComponentManager::stop(ComponentBase * component) const
 {
     if (!component) {
@@ -414 +428 @@
 }
 
-bool ComponentManager::stop(const QString& componentName)
+bool ComponentManager::stop(const QString & componentName)
 {
     LOG_TRACE("stop(component=" << componentName << ")");
@@ -432 +446 @@
 }
 
-ComponentBase* ComponentManager::getComponent(const QString& name)
+ComponentBase * ComponentManager::getComponent(const QString & name)
 {
     LOG_TRACE("getComponent(name=" << name << ")");