pilotclient/src/blackmisc/aviation/aircraftcategory.h

/* Copyright (C) 2019
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 */

//! \file

#ifndef BLACKMISC_AVIATION_AIRCRAFTCATEGORY_H
#define BLACKMISC_AVIATION_AIRCRAFTCATEGORY_H

#include "blackmisc/db/datastore.h"
#include "blackmisc/statusmessagelist.h"
#include "blackmisc/metaclass.h"
#include "blackmisc/propertyindex.h"
#include "blackmisc/valueobject.h"
#include "blackmisc/variant.h"
#include "blackmisc/blackmiscexport.h"

#include <QJsonObject>
#include <QMap>
#include <QList>
#include <QStringList>
#include <QMetaType>

namespace BlackMisc
{
    namespace Aviation
    {
        //! Value object for aircraft categories
        class BLACKMISC_EXPORT CAircraftCategory :
            public CValueObject<CAircraftCategory>,
            public Db::IDatastoreObjectWithIntegerKey
        {
        public:
            //! Properties by index
            enum ColumnIndex
            {
                IndexName = CPropertyIndex::GlobalIndexCAircraftCategory,
                IndexDescription,
                IndexLevelString,
                IndexLevelStringAndName,
                IndexLevelStringAndPath,
                IndexPath,
                IndexAssignable
            };

            //! Default constructor.
            CAircraftCategory() {}

            //! Constructor.
            CAircraftCategory(const QString &name, const QString &description, const QString &path, bool assignable);

            //! Get name
            const QString &getName() const { return m_name; }

            //! Set name
            void setName(const QString &name) { m_name = name.trimmed(); }

            //! Designator and DB key
            QString getNameDbKey() const;

            //! Aircraft designator?
            bool hasName() const;

            //! Matching name?
            bool matchesName(const QString &name, Qt::CaseSensitivity cs) const;

            //! Description
            const QString &getDescription() const { return m_description; }

            //! Set description
            void setDescription(const QString &description) { m_description = description.trimmed(); }

            //! Path
            const QString &getPath() const { return m_path; }

            //! Level
            void setLevel(int l1, int l2, int l3);

            //! Is that given level?
            bool isLevel(int l1, int l2, int l3) const;

            //! Is that given level?
            bool isLevel(const QList<int> &level) const;

            //! Is that given level?
            bool isLevel(const CAircraftCategory &category) const;

            //! Levels depending on depth, 3.2 -> 3,2 / 1.0 -> 1 / 4.3.1 -> 4,3,1
            QList<int> getLevel() const;

            //! First level
            int getFirstLevel() const { return m_l1; }

            //! Second level
            int getSecondLevel() const { return m_l2; }

            //! First level
            bool isFirstLevel() const;

            //! Depth 1, 2, 3
            int getDepth() const;

            //! Level string
            QString getLevelString() const;

            //! Level and name
            QString getLevelAndName() const;

            //! Level and path
            QString getLevelAndPath() const;

            //! Matching path?
            bool matchesPath(const QString &path, Qt::CaseSensitivity cs);

            //! Is matching the level, 0 ignored
            bool matchesLevel(int l1, int l2 = 0, int l3 = 0) const;

            //! Is matching the level, 0 ignored
            bool matchesLevel(const QList<int> &level) const;

            //! Assignable?
            bool isAssignable() const { return m_assignable; }

            //! Mark/set assignable
            void setAssignable(bool assignable) { m_assignable = assignable; }

            //! \copydoc BlackMisc::Mixin::Index::propertyByIndex
            QVariant propertyByIndex(BlackMisc::CPropertyIndexRef index) const;

            //! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
            void setPropertyByIndex(BlackMisc::CPropertyIndexRef index, const QVariant &variant);

            //! \copydoc BlackMisc::Mixin::Index::comparePropertyByIndex
            int comparePropertyByIndex(CPropertyIndexRef index, const CAircraftCategory &compareValue) const;

            //! \copydoc BlackMisc::Mixin::String::toQString
            QString convertToQString(bool i18n = false) const;

            //! Validate data
            BlackMisc::CStatusMessageList validate() const;

            //! Null category?
            bool isNull() const;

            //! Level compare
            int compareByLevel(const CAircraftCategory &other) const;

            //! Higher level?
            bool isHigherLevel(const CAircraftCategory &other) const;

            //! NULL object
            static const CAircraftCategory &null();

            //! From our database JSON format
            static CAircraftCategory fromDatabaseJson(const QJsonObject &json, const QString &prefix = QString());

        private:
            QString m_name;           //!< name
            QString m_description;    //!< description
            QString m_path;           //!< path
            bool m_assignable = true; //!< can assign to category?
            int m_l1 = 0;
            int m_l2 = 0;
            int m_l3 = 0;
            BLACK_METACLASS(
                CAircraftCategory,
                BLACK_METAMEMBER(dbKey),
                BLACK_METAMEMBER(timestampMSecsSinceEpoch),
                BLACK_METAMEMBER(name),
                BLACK_METAMEMBER(l1),
                BLACK_METAMEMBER(l2),
                BLACK_METAMEMBER(l3),
                BLACK_METAMEMBER(description),
                BLACK_METAMEMBER(path),
                BLACK_METAMEMBER(assignable)
            );
        };

        //! Category/id map
        using AircraftCategoryIdMap = QMap<int, CAircraftCategory>;

    } // namespace
} // namespace

Q_DECLARE_METATYPE(BlackMisc::Aviation::CAircraftCategory)

#endif // guard