vatsimsettings.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2016 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_CORE_VATSIM_SETTINGS_H
#define SWIFT_CORE_VATSIM_SETTINGS_H
 
#include "core/swiftcoreexport.h"
#include "misc/directoryutils.h"
#include "misc/network/serverlist.h"
#include "misc/pq/time.h"
#include "misc/settingscache.h"
#include "misc/swiftdirectories.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::core::vatsim, CReaderSettings)
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::core::vatsim, CRawFsdMessageSettings)
 
namespace swift::core::vatsim
{
    class SWIFT_CORE_EXPORT CReaderSettings : public swift::misc::CValueObject<swift::core::vatsim::CReaderSettings>
    {
    public:
        enum ColumnIndex
        {
            IndexInitialTime = swift::misc::CPropertyIndexRef::GlobalIndexCSettingsReaders,
            IndexPeriodicTime,
            IndexNeverUpdate
        };
 
        CReaderSettings();
 
        CReaderSettings(const swift::misc::physical_quantities::CTime &initialTime,
                        const swift::misc::physical_quantities::CTime &periodicTime, bool neverUpdate = false);
 
        const swift::misc::physical_quantities::CTime &getInitialTime() const { return m_initialTime; }
 
        void setInitialTime(const swift::misc::physical_quantities::CTime &time) { m_initialTime = time; }
 
        const swift::misc::physical_quantities::CTime &getPeriodicTime() const { return m_periodicTime; }
 
        void setPeriodicTime(const swift::misc::physical_quantities::CTime &time) { m_periodicTime = time; }
 
        bool isNeverUpdate() const { return m_neverUpdate; }
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        QString convertToQString(bool i18n = false) const;
 
        static const CReaderSettings &neverUpdateSettings();
 
    private:
        swift::misc::physical_quantities::CTime m_initialTime { 30.0,
                                                                swift::misc::physical_quantities::CTimeUnit::s() };
        swift::misc::physical_quantities::CTime m_periodicTime { 30.0,
                                                                 swift::misc::physical_quantities::CTimeUnit::s() };
        bool m_neverUpdate = false;
 
        SWIFT_METACLASS(
            CReaderSettings,
            SWIFT_METAMEMBER(initialTime),
            SWIFT_METAMEMBER(periodicTime),
            SWIFT_METAMEMBER(neverUpdate));
    };
 
    struct TVatsimDataFile : public swift::misc::TSettingTrait<CReaderSettings>
    {
        static const char *key() { return "vatsimreaders/datafile"; }
 
        static const QString &humanReadable()
        {
            static const QString name("VATSIM data file");
            return name;
        }
 
        static const swift::core::vatsim::CReaderSettings &defaultValue()
        {
            static const swift::core::vatsim::CReaderSettings reader {
                { 25.0, swift::misc::physical_quantities::CTimeUnit::s() },
                { 120.0, swift::misc::physical_quantities::CTimeUnit::s() }
            };
            return reader;
        }
    };
 
    struct TVatsimMetars : public swift::misc::TSettingTrait<CReaderSettings>
    {
        static const char *key() { return "vatsimreaders/metars"; }
 
        static const QString &humanReadable()
        {
            static const QString name("VATSIM METARs");
            return name;
        }
 
        static const swift::core::vatsim::CReaderSettings &defaultValue()
        {
            static const swift::core::vatsim::CReaderSettings reader {
                { 35.0, swift::misc::physical_quantities::CTimeUnit::s() },
                { 300.0, swift::misc::physical_quantities::CTimeUnit::s() }
            };
            return reader;
        }
    };
 
    class SWIFT_CORE_EXPORT CRawFsdMessageSettings :
        public swift::misc::CValueObject<swift::core::vatsim::CRawFsdMessageSettings>
    {
    public:
        enum FileWriteMode
        {
            None,
            Truncate,
            Append,
            Timestamped
        };
 
        enum ColumnIndex
        {
            IndexRawFsdMessagesEnabled = swift::misc::CPropertyIndexRef::GlobalIndexRawFsdMessageSettings,
            IndexFileDir,
            IndexFileWriteMode
        };
 
        CRawFsdMessageSettings();
 
        CRawFsdMessageSettings(bool enabled, const QString &fileDir);
 
        bool areRawFsdMessagesEnabled() const { return m_rawFsdMessagesEnabled; }
 
        QString getFileDir() const { return m_FileDir; }
 
        FileWriteMode getFileWriteMode() const { return m_fileWriteMode; }
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        QString convertToQString(bool i18n = false) const;
 
    private:
        bool m_rawFsdMessagesEnabled = false;
        QString m_FileDir;
        FileWriteMode m_fileWriteMode = None;
 
        SWIFT_METACLASS(
            CRawFsdMessageSettings,
            SWIFT_METAMEMBER(rawFsdMessagesEnabled),
            SWIFT_METAMEMBER(FileDir),
            SWIFT_METAMEMBER(fileWriteMode));
    };
 
    struct TRawFsdMessageSetting : public swift::misc::TSettingTrait<CRawFsdMessageSettings>
    {
        static const char *key() { return "network/rawfsdmessagelog"; }
 
        static const QString &humanReadable()
        {
            static const QString name("FSD message Logging");
            return name;
        }
 
        /* //! \copydoc swift::misc::TSettingTrait::isValid
        static bool isValid(const CRawFsdMessageSettings &setting, QString &)
        {
            if (setting.areRawFsdMessagesEnabled()) { return !setting.getFileDir().isEmpty(); }
            return true;
        }*/
 
        static const CRawFsdMessageSettings &defaultValue()
        {
            static const CRawFsdMessageSettings setting { false, swift::misc::CSwiftDirectories::logDirectory() };
            return setting;
        }
    };
} // namespace swift::core::vatsim
 
Q_DECLARE_METATYPE(swift::core::vatsim::CReaderSettings)
Q_DECLARE_METATYPE(swift::misc::CCollection<swift::core::vatsim::CReaderSettings>)
Q_DECLARE_METATYPE(swift::core::vatsim::CRawFsdMessageSettings)
Q_DECLARE_METATYPE(swift::core::vatsim::CRawFsdMessageSettings::FileWriteMode)
 
#endif // SWIFT_CORE_VATSIM_SETTINGS_H