entityflags.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_NETWORK_ENTITRFLAGS_H
#define SWIFT_MISC_NETWORK_ENTITRFLAGS_H
 
#include <QFlags>
#include <QMetaType>
#include <QStringList>
 
#include "misc/statusmessage.h"
#include "misc/swiftmiscexport.h"
 
namespace swift::misc::network
{
    class SWIFT_MISC_EXPORT CEntityFlags
    {
    public:
        enum EntityFlag
        {
            NoEntity = 0, 
            DbInfoObjectEntity = 1 << 0, 
            SharedInfoObjectEntity = 1 << 1, 
            AircraftIcaoEntity = 1 << 2, 
            AirlineIcaoEntity = 1 << 3, 
            CountryEntity = 1 << 4, 
            DistributorEntity = 1 << 5, 
            LiveryEntity = 1 << 6, 
            ModelEntity = 1 << 7, 
            MetarEntity = 1 << 8, 
            VatsimDataFile = 1 << 9, 
            VatsimStatusFile = 1 << 10, 
            AirportEntity = 1 << 11, 
            AircraftCategoryEntity = 1 << 12, 
            AllEntities = ((1 << 13) - 1), 
            AllIcaoEntities = AircraftIcaoEntity | AirlineIcaoEntity, 
            AllIcaoAndCountries =
                AircraftIcaoEntity | AirlineIcaoEntity | CountryEntity, 
            AllIcaoCountriesCategory = AllIcaoAndCountries | AircraftCategoryEntity, 
            DistributorLiveryModel = DistributorEntity | LiveryEntity | ModelEntity, 
            ModelMatchingEntities = AllIcaoEntities | LiveryEntity | ModelEntity, 
            AllDbEntitiesNoInfoObjects =
                AllIcaoCountriesCategory | DistributorLiveryModel | AirportEntity, 
            AllDbEntities = AllDbEntitiesNoInfoObjects | DbInfoObjectEntity, 
            AllDbEntitiesNoInfoObjectsNoAirportsAndCategories =
                AllIcaoAndCountries | DistributorLiveryModel 
        };
        Q_DECLARE_FLAGS(Entity, EntityFlag)
 
        
        using EntitySet = QSet<CEntityFlags::Entity>;
 
        enum ReadState
        {
            ReadStarted, 
            ReadParsing, 
            ReadFinished, 
            ReadFinishedRestricted, 
            ReadFailed, 
            ReadSkipped 
        };
 
        static QString flagToString(CEntityFlags::EntityFlag flag);
 
        static QStringList entitiesToStringList(CEntityFlags::Entity entities);
 
        static QString entitiesToString(CEntityFlags::Entity entities, const QString &separator = ", ");
 
        static bool isSingleEntity(CEntityFlags::Entity flag);
 
        static bool isFinishedReadState(ReadState state);
 
        static bool isFinishedReadStateOrFailure(ReadState state);
 
        static int numberOfEntities(CEntityFlags::Entity entities);
 
        static const QString &stateToString(ReadState flag);
 
        static CStatusMessage::StatusSeverity flagToSeverity(ReadState state);
 
        static Entity entityFlagToEntity(EntityFlag entityFlag);
 
        static EntityFlag entityToEntityFlag(Entity entity);
 
        static Entity iterateDbEntities(Entity &entities);
 
        static bool isWarningOrAbove(ReadState state);
 
        static bool anySwiftDbEntity(Entity entities);
 
        static Entity singleEntityByName(const QString &name);
 
        static Entity multipleEntitiesByNames(const QStringList &names);
 
        static EntitySet asSingleEntities(Entity entities);
 
        static void registerMetadata();
    };
} // namespace swift::misc::network
 
Q_DECLARE_METATYPE(swift::misc::network::CEntityFlags::EntityFlag)
Q_DECLARE_METATYPE(swift::misc::network::CEntityFlags::Entity)
Q_DECLARE_METATYPE(swift::misc::network::CEntityFlags::ReadState)
Q_DECLARE_OPERATORS_FOR_FLAGS(swift::misc::network::CEntityFlags::Entity)
 
#endif // SWIFT_MISC_NETWORK_ENTITRFLAGS_H