Changeset 176 in pacpusframework for trunk/src

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/src

Files:

• DBITEPlayerLib/DbtPlyEngine.cpp (modified) (1 diff)
• DBITEPlayerLib/DbtPlyFileManager.cpp (modified) (2 diffs)
• PacpusLib/ComponentBase.cpp (modified) (5 diffs)
• PacpusLib/ComponentManager.cpp (modified) (1 diff)
• PacpusLib/Log.cpp (modified) (2 diffs)
• PacpusLib/XmlComponentConfig.cpp (modified) (2 diffs)

trunk/src/DBITEPlayerLib/DbtPlyEngine.cpp

@@ -162 +162 @@
              << dataDir_ << "\"");
     if (dataDir_.isNull()) {
-        LOG_FATAL("The data directory '" << name() << "' is invalid or unavailable!");
+        LOG_FATAL("The data directory '" << getName() << "' is invalid or unavailable!");
     }
 

trunk/src/DBITEPlayerLib/DbtPlyFileManager.cpp

@@ -181 +181 @@
 void DbtPlyFileManager::displayUI()
 {
-    LOG_WARN("component '" << name() << "' has no user interface. Please set ui property to 0 in your XML configuration");
+    LOG_WARN("component '" << getName() << "' has no user interface. Please set ui property to 0 in your XML configuration");
 }
 
@@ -301 +301 @@
     deltaTDbtTab_[(deltaTDbtTabLoop_++)%1000] = deltaT;
     if (deltaT > kMaxPendingTimeFromEngineMicrosecs) {
-        LOG_WARN(name() << ": data not replayed: elapsed time since engine notification too big:" << deltaT << "us");
+        LOG_WARN(getName() << ": data not replayed: elapsed time since engine notification too big:" << deltaT << "us");
         return;
     }

trunk/src/PacpusLib/ComponentBase.cpp

@@ -9 +9 @@
 #include <Pacpus/kernel/Log.h>
 
+#include <boost/program_options/parsers.hpp>
+#include <boost/program_options/variables_map.hpp>
+#include <string>
+#include <vector>
+
+namespace po = boost::program_options;
 using namespace pacpus;
+using namespace std;
+
+std::vector<std::string> convertAttributesToArgumentVector(const QDomNamedNodeMap & attributes);
+void logVariablesMap(boost::program_options::variables_map vm);
 
 DECLARE_STATIC_LOGGER("pacpus.core.ComponentBase");
@@ -20 +30 @@
   , m_ui(NULL)
   , m_componentState(NOT_MONITORED)
+  , mOptionsDescription("Component parameters")
 {
     LOG_TRACE("constructor");
     // Get a pointer on the instance of ComponentManager.
     m_manager = ComponentManager::getInstance();
-    LOG_INFO("component " << name() << " was created");
+    LOG_INFO("component " << getName() << " was created");
+
+    addParameters()
+        ("name", po::value<string>(&mName)->required(), "component name")
+        ("type", po::value<string>(&mTypeName)->required(), "component type")
+        ("ui", po::value<bool>(&mHasGui)->default_value(false), "whether to show GUI")
+        ("verbose", po::value<bool>(&mVerbose)->default_value(false), "set output verbose")
+        ("verbosity-level", po::value<int>(&mVerbosityLevel)->default_value(0), "set verbosity level")
+        ("recording", po::value<bool>(&m_isRecording)->default_value(false), "whether to record data")
+    ;
 }
 
@@ -113 +133 @@
 }
 
-QString ComponentBase::name() const
-{
-    return m_componentName;
-}
-
 QString ComponentBase::getName() const
 {
@@ -148 +163 @@
         return inputs()[inputName];
     }
-    LOG_WARN("Component " << name() << " does not contain input " << inputName);
+    LOG_WARN("Component " << getName() << " does not contain input " << inputName);
     return NULL;
 }
@@ -161 +176 @@
         return outputs()[outputName];
     }
-    LOG_WARN("Component " << name() << " does not containt output " << outputName);
+    LOG_WARN("Component " << getName() << " does not containt output " << outputName);
     return NULL;
 }
+
+po::options_description_easy_init ComponentBase::addParameters()
+{
+    return mOptionsDescription.add_options();
+}
+
+void ComponentBase::parseParameters(const XmlComponentConfig & cfg)
+{
+    LOG_INFO("Parsing parameters...");
+    LOG_INFO(mOptionsDescription);
+    
+    vector<string> xargs = convertAttributesToArgumentVector(cfg.getProperties());
+    
+    boost::program_options::variables_map vm;
+    try {
+        po::store(
+            po::command_line_parser(xargs)
+                .options(mOptionsDescription)
+                //.allow_unregistered()
+                .run()
+        , vm);
+        po::notify(vm);
+    } catch (po::error & e) {
+        LOG_ERROR(e.what());
+        throw;
+    }
+
+    logVariablesMap(vm);
+}
+
+void logVariablesMap(boost::program_options::variables_map vm)
+{
+    for (po::variables_map::iterator i = vm.begin(); i != vm.end(); ++i) { 
+        const po::variable_value& v = i->second;
+        if (v.empty()) {
+            continue;
+        }
+        const type_info & type = v.value().type();
+        if (type == typeid(string)) {
+            const string & val = v.as<string>();
+            LOG_INFO(i->first << "=" << val);
+        } else if (type == typeid(int)) {
+            int val = v.as<int>();
+            LOG_INFO(i->first << "=" << val);
+        } else if (type == typeid(bool)) {
+            int val = v.as<bool>();
+            LOG_INFO(i->first << "=" << val);
+        }
+    }
+}
+
+vector<string> convertAttributesToArgumentVector(const QDomNamedNodeMap & attributes)
+{
+    vector<string> xargs;
+    xargs.reserve(attributes.size());
+
+    for (int i = 0; i < attributes.size(); ++i) {
+        QDomAttr parameter = attributes.item(i).toAttr();
+        if (parameter.isNull()) {
+            LOG_WARN("node is not a parameter");
+            continue;
+        }
+        
+        QString arg = QString("--") + parameter.name() + "=";
+        
+        bool shouldAddQuotes = parameter.value().contains(' ');
+        if (shouldAddQuotes) {
+            arg += '\"';
+            arg += parameter.value();
+            arg += '\"';
+        } else {
+            arg += parameter.value();
+        }
+        
+        LOG_DEBUG("parameter: " << arg);
+        xargs.push_back(arg.toStdString());
+    }
+
+    return xargs;
+}

trunk/src/PacpusLib/ComponentManager.cpp

@@ -255 +255 @@
         } else {
             component->param.localCopy(cfg.qDomElement());
+            component->parseParameters(cfg);
             component->setConfigurationState(component->configureComponent(cfg));
         }

trunk/src/PacpusLib/Log.cpp

@@ -71 +71 @@
     
     logging::add_common_attributes();
+    logging::core::get()->add_global_attribute(
+        "ProcessID",
+        attrs::current_process_id());
+    logging::core::get()->add_global_attribute(
+        "ThreadID",
+        attrs::current_thread_id());
+
     logging::core::get()->set_filter
     (
@@ -93 +100 @@
             expr::stream
                 << std::setfill('0') << std::setw(6) << expr::attr< unsigned int >("LineID")
-                //<< " [" << expr::format_date_time< posix_time::ptime >("TimeStamp", date_time::iso_extended_format) << "] "
-                << " [" << expr::format_date_time< posix_time::ptime >("TimeStamp", "%Y-%m-%d %T.%f") << "] "
-                << "<" << logging::trivial::severity << ">"
-                << " "
-                << expr::smessage
+                //<< " [" << expr::format_date_time< posix_time::ptime >("TimeStamp", date_time::iso_extended_format) << "]"
+                << " [" << expr::format_date_time< posix_time::ptime >("TimeStamp", "%Y-%m-%d %T.%f") << "]"
+                << " <" << logging::trivial::severity << ">"
+                << " <" << expr::attr< attrs::current_process_id::value_type >("ProcessID")
+                << ":" << expr::attr< attrs::current_thread_id::value_type >("ThreadID") << ">"
+                << " " << expr::smessage
         )
     );

trunk/src/PacpusLib/XmlComponentConfig.cpp

@@ -8 +8 @@
 #include <Pacpus/kernel/Log.h>
 #include <Pacpus/kernel/XmlConfigFile.h>
+#include <QDomNamedNodeMap>
 
 using namespace pacpus;
@@ -37 +38 @@
 }
 
+QDomNamedNodeMap XmlComponentConfig::getProperties() const
+{
+    return component_.attributes();
+}
+
 void XmlComponentConfig::addProperty(const QString& name)
 {
-    if (hasProperty(name))
-    {
+    if (hasProperty(name)) {
         LOG_ERROR("cannot add component property:"
                   << " component '" << component_.attribute(kPropertyComponentName) << "'"