preset.h

Go to the documentation of this file.

// Copyright (C) 2015-2019 Edouard Griffiths, F4EXB.                             //
//                                                                               //
// Swagger server adapter interface                                              //
//                                                                               //
// This program is free software; you can redistribute it and/or modify          //
// it under the terms of the GNU General Public License as published by          //
// the Free Software Foundation as version 3 of the License, or                  //
// (at your option) any later version.                                           //
//                                                                               //
// This program is distributed in the hope that it will be useful,               //
// but WITHOUT ANY WARRANTY; without even the implied warranty of                //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                  //
// GNU General Public License V3 for more details.                               //
//                                                                               //
// You should have received a copy of the GNU General Public License             //
// along with this program. If not, see <http://www.gnu.org/licenses/>.          //
#ifndef INCLUDE_PRESET_H
#define INCLUDE_PRESET_H

#include <QString>
#include <QList>
#include <QMetaType>

#include "export.h"

class SDRBASE_API Preset {
public:
    struct ChannelConfig {
        QString m_channelIdURI; 
        QString m_channelId;    
        QByteArray m_config;

        ChannelConfig(const QString& channelIdURI, const QByteArray& config) :
            m_channelIdURI(channelIdURI),
            m_config(config)
        { }
    };
    typedef QList<ChannelConfig> ChannelConfigs;

    struct DeviceConfig
    {
        QString m_deviceId;
        QString m_deviceSerial;
        int m_deviceSequence;
        QByteArray m_config;

        DeviceConfig(const QString& deviceId,
                const QString& deviceSerial,
                int deviceSequence,
                const QByteArray& config) :
                    m_deviceId(deviceId),
                    m_deviceSerial(deviceSerial),
                    m_deviceSequence(deviceSequence),
                    m_config(config)
        { }
    };
    typedef QList<DeviceConfig> DeviceeConfigs;

    Preset();

    void resetToDefaults();

    void setSourcePreset(bool isSourcePreset) { m_sourcePreset = isSourcePreset; }
    bool isSourcePreset() const { return m_sourcePreset; }

    QByteArray serialize() const;
    bool deserialize(const QByteArray& data);

    void setGroup(const QString& group) { m_group = group; }
    const QString& getGroup() const { return m_group; }
    void setDescription(const QString& description) { m_description = description; }
    const QString& getDescription() const { return m_description; }
    void setCenterFrequency(const quint64 centerFrequency) { m_centerFrequency = centerFrequency; }
    quint64 getCenterFrequency() const { return m_centerFrequency; }

    void setSpectrumConfig(const QByteArray& data) { m_spectrumConfig = data; }
    const QByteArray& getSpectrumConfig() const { return m_spectrumConfig; }

    void setLayout(const QByteArray& data) { m_layout = data; }
    const QByteArray& getLayout() const { return m_layout; }

    void clearChannels() { m_channelConfigs.clear(); }
    void addChannel(const QString& channel, const QByteArray& config) { m_channelConfigs.append(ChannelConfig(channel, config)); }
    int getChannelCount() const { return m_channelConfigs.count(); }
    const ChannelConfig& getChannelConfig(int index) const { return m_channelConfigs.at(index); }

    void setDeviceConfig(const QString& deviceId, const QString& deviceSerial, int deviceSequence, const QByteArray& config)
    {
        addOrUpdateDeviceConfig(deviceId, deviceSerial, deviceSequence, config);
    }

    void addOrUpdateDeviceConfig(const QString& deviceId,
            const QString& deviceSerial,
            int deviceSequence,
            const QByteArray& config);

    const QByteArray* findBestDeviceConfig(const QString& deviceId,
            const QString& deviceSerial,
            int deviceSequence) const;

    static bool presetCompare(const Preset *p1, Preset *p2)
    {
        if (p1->m_group != p2->m_group)
        {
            return p1->m_group < p2->m_group;
        }
        else
        {
            if (p1->m_centerFrequency != p2->m_centerFrequency) {
                return p1->m_centerFrequency < p2->m_centerFrequency;
            } else {
                return p1->m_description < p2->m_description;
            }
        }
    }

    friend class WebAPIAdapterBase;

protected:
    bool m_sourcePreset;

    // group and preset description
    QString m_group;
    QString m_description;
    quint64 m_centerFrequency;

    // general configuration
    QByteArray m_spectrumConfig;

    // dc offset and i/q imbalance correction TODO: move it into the source data
    bool m_dcOffsetCorrection;
    bool m_iqImbalanceCorrection;

    // channels and configurations
    ChannelConfigs m_channelConfigs;

    // devices and configurations
    DeviceeConfigs m_deviceConfigs;

    // screen and dock layout
    QByteArray m_layout;

private:
    const QByteArray* findBestDeviceConfigSoapy(const QString& sourceId, const QString& deviceSerial) const;
};

Q_DECLARE_METATYPE(const Preset*);
Q_DECLARE_METATYPE(Preset*);

#endif // INCLUDE_PRESET_H