source: pacpusframework/trunk/src/PacpusLib/XmlComponentConfig.cpp@ 311

// %pacpus:license{
// This file is part of the PACPUS framework distributed under the
// CECILL-C License, Version 1.0.
// %pacpus:license}
/// @version    $Id: XmlComponentConfig.cpp 79 2013-01-14 08:52:06Z kurdejma $

#include <Pacpus/kernel/XmlComponentConfig.h>
#include <Pacpus/kernel/Log.h>
#include <Pacpus/kernel/XmlConfigFile.h>
#include <QDomNamedNodeMap>

using namespace pacpus;
using namespace std;

DECLARE_STATIC_LOGGER("pacpus.core.XmlComponentConfig");

static const char* kPropertyComponentName = "name";
static const char* kPropertyComponentType = "type";
static const char* kPropertyConnectionType = "type";
static const char* kPropertyConnectionInput = "input";
static const char* kPropertyConnectionOutput = "output";
static const char* kPropertyConnectionPriority = "priority";

XmlComponentConfig::XmlComponentConfig(QString const& name)
{
    LOG_TRACE("XmlComponentConfig(QString)");

    // Get the pointer to the document and create the component.
    parentDocument_ = XmlConfigFile::create();
    if (name != QString::null)
      component_ = parentDocument_->createComponent(name);
}

/// Destructor.
XmlComponentConfig::~XmlComponentConfig()
{
    LOG_TRACE("~XmlComponentConfig()");
}

QDomNamedNodeMap XmlComponentConfig::getProperties() const
{
    return component_.attributes();
}

void XmlComponentConfig::addProperty(QString const& name)
{
    if (hasProperty(name)) {
        LOG_ERROR("cannot add component property:"
                  << " component '" << component_.attribute(kPropertyComponentName) << "'"
                  << " already contains property '" << name << "'"
                  << " and its value is '" << component_.attribute(name) << "'"
                  );
        return;
    }

    // The property does not exist, it can be added.
    component_.setAttribute(name, 0);
    LOG_INFO("property '" << name << "'"
              << " was added to the component " << component_.attribute(kPropertyComponentName) << "'"
              << " and set to '" << component_.attribute(name) << "'"
              );
}

int XmlComponentConfig::delProperty(QString const& name)
{
    if (!hasProperty(name)) {
        LOG_WARN("cannot delete compoenent property '" << name << "'"
                 << " of component '" << component_.attribute(kPropertyComponentName) << "'"
                 << ". Component does not contain this property."
                 );
        return false;
    }

    // The property exists, it can be removed.
    component_.removeAttribute(name);
    LOG_INFO("property '" << name << "' "
      << " of component '" << component_.attribute(kPropertyComponentName) << "'"
      << " was deleted"
      );

    return true;
}

QString XmlComponentConfig::getProperty(QString const& name, QString const& defaultValue) const
{
    if (!hasProperty(name))
    {
        LOG_WARN("cannot retrieve component property '" << name << "'"
                 << " of component '" << component_.attribute(kPropertyComponentName) << "'"
                 << ". Component does not contain this property."
                 );
        return defaultValue;
    }

    // The property exists, the value can be retrieved.
    return component_.attribute(name);
}

bool XmlComponentConfig::getBoolProperty(QString const& name, bool defaultValue) const
{
  return hasProperty(name) ? getProperty(name) == "true" : defaultValue;
}

int XmlComponentConfig::getIntProperty(QString const& name, int defaultValue) const
{
  return hasProperty(name) ? getProperty(name).toInt() : defaultValue;
}

double XmlComponentConfig::getDoubleProperty(QString const& name, double defaultValue) const
{
  return hasProperty(name) ? getProperty(name).toDouble() : defaultValue;
}

void XmlComponentConfig::setProperty(QString const& name, QString const& value)
{
    component_.setAttribute(name, value);
    LOG_INFO("property " << name
             << " of the component " << component_.attribute(kPropertyComponentName)
             << " was set to : " << value
             );
}

bool XmlComponentConfig::hasProperty(QString const& name) const
{
    return component_.hasAttribute(name);
}

QDomElement const& XmlComponentConfig::getDomElement() const
{
    return component_;
}

void XmlComponentConfig::localCopy(const QDomElement& elementToCopy)
{
    component_ = elementToCopy;
}

QString const XmlComponentConfig::getComponentName() const
{
    return getProperty(kPropertyComponentName);
}

QString const XmlComponentConfig::getComponentType() const
{
    return getProperty(kPropertyComponentType);
}

QString const XmlComponentConfig::getConnectionType() const
{
    return getProperty(kPropertyConnectionType);
}

QString const XmlComponentConfig::getConnectionInput() const
{
    return getProperty(kPropertyConnectionInput);
}

QString const XmlComponentConfig::getConnectionOutput() const
{
    return getProperty(kPropertyConnectionOutput);
}

int const XmlComponentConfig::getConnectionPriority() const
{
    return getIntProperty(kPropertyConnectionPriority, /*defaultValue=*/0);
}