Changeset 176 in pacpusframework for trunk/include

Timestamp:

Oct 11, 2013, 2:10:06 PM (11 years ago)

Author:

Marek Kurdej

Message:

Added: addParameters() method in ComponentBase using Boost.Program_Options.
Each component can declare its parameters and they will be read automatically before configureComponent() method.
See example ProducerConsumerExample constructors.

Location:

trunk/include/Pacpus/kernel

Files:

• ComponentBase.h (modified) (5 diffs)
• Log.h (modified) (1 diff)
• XmlComponentConfig.h (modified) (3 diffs)

trunk/include/Pacpus/kernel/ComponentBase.h

@@ -31 +31 @@
 #include <QMap>
 
+#include <boost/program_options/options_description.hpp>
+#include <boost/program_options/value_semantic.hpp>
+#include <string>
+
 class QWidget;
+
+namespace boost {
+namespace program_options {
+    class options_description_easy_init;
+}
+}
 
 namespace pacpus {
@@ -94 +104 @@
      * @return Name of the component.
      */
-    QString name() const;
     QString getName() const;
 
@@ -127 +136 @@
     virtual void addOutputs() {}
 
+    boost::program_options::options_description_easy_init addParameters();
+
 protected:
     typedef QMap<QString, InputInterfaceBase *> InputsMap;
@@ -177 +188 @@
 
     const XmlComponentConfig xmlParameters() const;
+
+protected:
+    std::string mName;
+    std::string mTypeName;
+    bool mHasGui;
+    bool mVerbose;
+    int mVerbosityLevel;
     
 private:
+    /// Called by ComponentManager to handle parameters
+    /// @throws
+    void parseParameters(const XmlComponentConfig & cfg);
+
     /// called by the ComponentManager to start the component
     int startComponent();
@@ -186 +208 @@
 
 private:
+    boost::program_options::options_description mOptionsDescription;
+
     /// The XML node that is got in the configureComponent method
     XmlComponentConfig param;

trunk/include/Pacpus/kernel/Log.h

@@ -35 +35 @@
 
 #if defined(PACPUS_USE_LOG)
+#   include <boost/log/attributes/named_scope.hpp>
+#   include <boost/log/trivial.hpp>
+#   include <iosfwd>
 
-#include <boost/log/trivial.hpp>
-#include <iosfwd>
 class QString;
-
 template< typename CharT, typename TraitsT >
 PACPUSLIB_API std::basic_ostream< CharT, TraitsT >& operator<< (std::basic_ostream< CharT, TraitsT >& strm, QString const& s);
 
-#define DECLARE_STATIC_LOGGER(name) 
-
-#define LOG(level, message)         BOOST_LOG_TRIVIAL(level) << message
-#define LOG_TRACE(message)          LOG(trace, message)
-#define LOG_DEBUG(message)          LOG(debug, message)
-#define LOG_INFO(message)           LOG(info, message)
-#define LOG_WARN(message)           LOG(warning, message)
-#define LOG_ERROR(message)          LOG(error, message)
-#define LOG_FATAL(message)          LOG(fatal, message)
-
+#   define DECLARE_STATIC_LOGGER(name)        //BOOST_LOG_NAMED_SCOPE(name)
+#   define PACPUS_LOG_FUNCTION()              BOOST_LOG_FUNCTION()
+#   define PACPUS_LOG_NAMED_SCOPE(name)       BOOST_LOG_NAMED_SCOPE(name)
+#   define PACPUS_LOG(level, message)         BOOST_LOG_TRIVIAL(level) << message
 #else
-
 /// @param name Name of the logger, displayed when logging a message.
-#define DECLARE_STATIC_LOGGER(name)
-/// Logs a message at TRACE level using default logger
-#define LOG_TRACE(message)
-/// Logs a message at DEBUG level using default logger
-#define LOG_DEBUG(message)
-/// Logs a message at INFO level using default logger
-#define LOG_INFO(message)
-/// Logs a message at WARN level using default logger
-#define LOG_WARN(message)
-/// Logs a message at ERROR level using default logger
-#define LOG_ERROR(message)
-/// Logs a message at FATAL level using default logger
-#define LOG_FATAL(message)
-
+#   define DECLARE_STATIC_LOGGER(name)
+#   define PACPUS_LOG_FUNCTION()              ((void) 0)
+#   define PACPUS_LOG_NAMED_SCOPE(name)       ((void) 0)
+#   define PACPUS_LOG(level, message)         ((void) 0)
 #endif // PACPUS_USE_LOG
 
+/// Logs a message at TRACE level using default logger
+#define LOG_TRACE(message)          PACPUS_LOG(trace, message)
+/// Logs a message at DEBUG level using default logger
+#define LOG_DEBUG(message)          PACPUS_LOG(debug, message)
+/// Logs a message at INFO level using default logger
+#define LOG_INFO(message)           PACPUS_LOG(info, message)
+/// Logs a message at WARN level using default logger
+#define LOG_WARN(message)           PACPUS_LOG(warning, message)
+/// Logs a message at ERROR level using default logger
+#define LOG_ERROR(message)          PACPUS_LOG(error, message)
+/// Logs a message at FATAL level using default logger
+#define LOG_FATAL(message)          PACPUS_LOG(fatal, message)
+
 #endif // DEF_PACPUS_LOG_H

trunk/include/Pacpus/kernel/XmlComponentConfig.h

@@ -22 +22 @@
 namespace pacpus {
     
+//class QDomNamedNodeMap;
 class XmlConfigFile;
 
@@ -38 +39 @@
     /** Dtor of XmlComponentConfig. */
     ~XmlComponentConfig();
+
+    QDomNamedNodeMap getProperties() const;
 
     /** Add the property @em name to the XML and set its value to @em 0 if it does not exist.
@@ -94 +97 @@
 
     // Copy internally the node in the internal QDomElement. 
-    void localCopy(const QDomElement& elementToCopy);
+    void localCopy(const QDomElement & elementToCopy);
 
     QString const getComponentName() const;
     QString const getComponentType() const;
-
 
     QString const getConnectionType() const;