databasereaderconfig.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_DB_DATABASE_READERCONFIG_H
#define SWIFT_CORE_DB_DATABASE_READERCONFIG_H
 
#include <QDateTime>
#include <QJsonArray>
#include <QObject>
#include <QString>
#include <QtGlobal>
 
#include "core/swiftcoreexport.h"
#include "misc/db/dbflags.h"
#include "misc/network/entityflags.h"
#include "misc/pq/time.h"
#include "misc/sequence.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::core::db, CDatabaseReaderConfig)
 
namespace swift::core::db
{
    class SWIFT_CORE_EXPORT CDatabaseReaderConfig : public swift::misc::CValueObject<CDatabaseReaderConfig>
    {
    public:
        CDatabaseReaderConfig() = default;
 
        CDatabaseReaderConfig(
            swift::misc::network::CEntityFlags::Entity entities,
            swift::misc::db::CDbFlags::DataRetrievalMode retrievalFlags,
            const swift::misc::physical_quantities::CTime &cacheLifetime = swift::misc::physical_quantities::CTime());
 
        QString convertToQString(bool i18n = false) const;
 
        swift::misc::network::CEntityFlags::Entity getEntities() const;
 
        bool supportsEntities(swift::misc::network::CEntityFlags::Entity entities) const;
 
        swift::misc::db::CDbFlags::DataRetrievalMode getRetrievalMode() const;
 
        void markAsDbDown();
 
        void setCacheLifetime(const swift::misc::physical_quantities::CTime &time);
 
        bool possiblyReadsFromSwiftDb() const;
 
        bool needsSharedInfoFile() const;
 
        bool possiblyWritesToSwiftDb() const;
 
        bool possiblyReadsFromCache() const;
 
        bool isValid() const;
 
    private:
        int m_entities = swift::misc::network::CEntityFlags::NoEntity; 
        int m_retrievalMode = swift::misc::db::CDbFlags::DbReading; 
        swift::misc::physical_quantities::CTime m_cacheLifetime;
 
        SWIFT_METACLASS(
            CDatabaseReaderConfig,
            SWIFT_METAMEMBER(entities),
            SWIFT_METAMEMBER(retrievalMode),
            SWIFT_METAMEMBER(cacheLifetime));
    };
} // namespace swift::core::db
 
SWIFT_DECLARE_SEQUENCE_MIXINS(swift::core::db, CDatabaseReaderConfig, CDatabaseReaderConfigList)
 
namespace swift::core::db
{
    class SWIFT_CORE_EXPORT CDatabaseReaderConfigList :
        public swift::misc::CSequence<CDatabaseReaderConfig>,
        public swift::misc::mixin::MetaType<CDatabaseReaderConfigList>
    {
    public:
        SWIFT_MISC_DECLARE_USING_MIXIN_METATYPE(CDatabaseReaderConfigList)
        using CSequence::CSequence;
 
        CDatabaseReaderConfigList() = default;
 
        CDatabaseReaderConfigList(const CSequence<CDatabaseReaderConfig> &other);
 
        CDatabaseReaderConfig
        findFirstOrDefaultForEntity(const swift::misc::network::CEntityFlags::Entity entities) const;
 
        void markAsDbDown();
 
        void setCacheLifetimes(const swift::misc::physical_quantities::CTime &time);
 
        bool possiblyReadsFromSwiftDb() const;
 
        bool possiblyWritesToSwiftDb() const;
 
        bool needsSharedInfoObjects(swift::misc::network::CEntityFlags::Entity entities) const;
 
        bool needsSharedInfoObjectsIfCachesEmpty(swift::misc::network::CEntityFlags::Entity entities,
                                                 swift::misc::network::CEntityFlags::Entity cachedEntities) const;
 
        bool needsSharedInfoFile(swift::misc::network::CEntityFlags::Entity entities) const;
 
        swift::misc::network::CEntityFlags::Entity getEntitesCachedOrReadFromDB() const;
 
        static CDatabaseReaderConfigList forMappingTool();
 
        static CDatabaseReaderConfigList forPilotClient();
 
        static CDatabaseReaderConfigList forLauncher();
 
        static CDatabaseReaderConfigList allDirectDbAccess();
    };
} // namespace swift::core::db
 
Q_DECLARE_METATYPE(swift::core::db::CDatabaseReaderConfig)
Q_DECLARE_METATYPE(swift::core::db::CDatabaseReaderConfigList)
Q_DECLARE_METATYPE(swift::misc::CCollection<swift::core::db::CDatabaseReaderConfig>)
 
#endif // SWIFT_CORE_DB_DATABASE_READERCONFIG_H