configurer.h

Go to the documentation of this file.

/* Copyright 2015 CyberTech Labs Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License. */

#pragma once

#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QHash>

class QDomElement;

namespace trikKernel {

class Configurer
{
public:
    Configurer(const QString &systemConfig, const QString &modelConfig);

    QString attributeByDevice(const QString &deviceClass, const QString &attributeName) const;

    QString attributeByPort(const QString &port, const QString &attributeName) const;

    bool isEnabled(const QString &deviceName) const;

    QStringList ports() const;

    QString deviceClass(const QString &port) const;

    QStringList initScripts() const;

    void configure(const QString &portName, const QString &deviceName);

    QString version() const;

private:
    struct Device {
        QString name;
        QHash<QString, QString> attributes;
        QHash<QString, QHash<QString, QString>> portSpecificAttributes;
        bool isOptional = false;
    };

    struct DeviceType {
        QString name;
        QString deviceClass;
        QHash<QString, QString> attributes;
    };

    struct ModelConfigurationElement {
        QString port;
        QString deviceType;
        QHash<QString, QString> attributes;
    };

    struct AdditionalModelConfigurationElement {
        QString deviceClass;
        QHash<QString, QString> attributes;
    };

    void parseDeviceClasses(const QDomElement &element);
    void parseDevicePorts(const QDomElement &element);
    void parseDeviceTypes(const QDomElement &element);
    void parseInitScript(const QDomElement &element);
    void parseAdditionalConfigurations(const QDomElement &element);
    void parseModelConfig(const QDomElement &element);

    QStringList mInitScripts;

    QHash<QString, Device> mDevices;

    QHash<QString, DeviceType> mDeviceTypes;

    QHash<QString, Device> mAdditionalConfiguration;

    QHash<QString, ModelConfigurationElement> mModelConfiguration;

    QHash<QString, AdditionalModelConfigurationElement> mAdditionalModelConfiguration;

    QString mVersion;
};

}