distributor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_SIMULATION_DISTRIBUTOR_H
#define SWIFT_MISC_SIMULATION_DISTRIBUTOR_H
 
#include <QJsonObject>
#include <QMap>
#include <QMetaType>
#include <QSet>
#include <QString>
 
#include "misc/db/datastore.h"
#include "misc/metaclass.h"
#include "misc/orderable.h"
#include "misc/propertyindexref.h"
#include "misc/simulation/simulatorinfo.h"
#include "misc/statusmessagelist.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::simulation, CDistributor)
 
namespace swift::misc::simulation
{
    class SWIFT_MISC_EXPORT CDistributor :
        public CValueObject<CDistributor>,
        public db::IDatastoreObjectWithStringKey,
        public IOrderable
    {
    public:
        enum ColumnIndex
        {
            IndexDescription = CPropertyIndexRef::GlobalIndexCDistributor,
            IndexAlias1,
            IndexAlias2,
            IndexSimulator
        };
 
        CDistributor();
 
        CDistributor(const QString &key);
 
        CDistributor(
            const QString &id, const QString &description, const QString &alias1, const QString &alias2,
            const swift::misc::simulation::CSimulatorInfo &simulator = swift::misc::simulation::CSimulatorInfo());
 
        const QString &getDescription() const { return m_description; }
 
        QString getIdAndDescription() const;
 
        void setDescription(const QString &description) { m_description = description.trimmed(); }
 
        bool hasDescription() const { return !m_description.isEmpty(); }
 
        const QString &getAlias1() const { return m_alias1; }
 
        const QString &getAlias2() const { return m_alias2; }
 
        void setAlias1(const QString &alias) { m_alias1 = alias; }
 
        void setAlias2(const QString &alias) { m_alias2 = alias; }
 
        bool hasAlias1() const { return !m_alias1.isEmpty(); }
 
        bool hasAlias2() const { return !m_alias2.isEmpty(); }
 
        const swift::misc::simulation::CSimulatorInfo &getSimulator() const { return m_simulator; }
 
        void setSimulator(const swift::misc::simulation::CSimulatorInfo &simulator) { m_simulator = simulator; }
 
        bool matchesKeyOrAlias(const QString &keyOrAlias) const;
 
        bool matchesKeyOrAlias(const CDistributor &distributor) const;
 
        bool matchesSimulator(const CSimulatorInfo &simulator) const;
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        int comparePropertyByIndex(CPropertyIndexRef index, const CDistributor &compareValue) const;
 
        QString convertToQString(bool i18n = false) const;
 
        bool hasCompleteData() const;
 
        swift::misc::CStatusMessageList validate() const;
 
        void updateMissingParts(const CDistributor &otherDistributor);
 
        static CDistributor fromDatabaseJson(const QJsonObject &json, const QString &prefix = QString());
 
        static const QString &standardFSX();
        static const QString &standardP3D();
        static const QString &standardFS9();
        static const QString &standardXPlane();
        static const QString &standardFlightGear();
        static const QSet<QString> &standardAllFsFamily();
        static const QSet<QString> &xplaneMostPopular();
        static const QString &xplaneBlueBell();
        static const QString &xplaneXcsl();
        static const QString &standardMsfs();
        static const QString &standardMsfs2024();
 
    private:
        QString m_description; 
        QString m_alias1; 
        QString m_alias2; 
        swift::misc::simulation::CSimulatorInfo m_simulator; 
 
        static QString unifyKeyOrAlias(const QString &value);
 
        SWIFT_METACLASS(
            CDistributor,
            SWIFT_METAMEMBER(dbKey, 0, CaseInsensitiveComparison),
            SWIFT_METAMEMBER(loadedFromDb),
            SWIFT_METAMEMBER(timestampMSecsSinceEpoch),
            SWIFT_METAMEMBER(order),
            SWIFT_METAMEMBER(description),
            SWIFT_METAMEMBER(alias1, 0, CaseInsensitiveComparison),
            SWIFT_METAMEMBER(alias2, 0, CaseInsensitiveComparison),
            SWIFT_METAMEMBER(simulator));
    };
 
    using DistributorIdMap = QMap<QString, CDistributor>;
 
} // namespace swift::misc::simulation
 
Q_DECLARE_METATYPE(swift::misc::simulation::CDistributor)
 
#endif // SWIFT_MISC_SIMULATION_DISTRIBUTOR_H