pilotclient/src/blackmisc/aviation/livery.h

/* Copyright (C) 2015
 * 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 and at http://www.swift-project.org/license.html. 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_LIVERY_H
#define BLACKMISC_AVIATION_LIVERY_H

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

#include <QJsonObject>
#include <QMetaType>
#include <QString>

namespace BlackMisc
{
    namespace Aviation
    {
        //! Value object encapsulating information about an airpot.
        class BLACKMISC_EXPORT CLivery :
            public CValueObject<CLivery>,
            public Db::IDatastoreObjectWithIntegerKey
        {
        public:
            //! Properties by index
            enum ColumnIndex
            {
                IndexDescription = CPropertyIndex::GlobalIndexCLivery,
                IndexAirlineIcaoCode,
                IndexCombinedCode,
                IndexColorFuselage,
                IndexColorTail,
                IndexIsMilitary
            };

            //! Default constructor.
            CLivery();

            //! Constructor
            CLivery(const QString &combinedCode, const CAirlineIcaoCode &airline, const QString &description);

            //! Constructor
            CLivery(const QString &combinedCode, const CAirlineIcaoCode &airline, const QString &description, const QString &colorFuselage, const QString &colorTail, bool isMilitary);

            //! Constructor
            CLivery(const QString &combinedCode, const CAirlineIcaoCode &airline, const QString &description, const CRgbColor &colorFuselage, const CRgbColor &colorTail, bool isMilitary);

            //! Constructor
            CLivery(int dbKey, const QString &combinedCode, const CAirlineIcaoCode &airline, const QString &description, const QString &colorFuselage, const QString &colorTail, bool isMilitary);

            //! Constructor
            CLivery(int dbKey, const QString &combinedCode, const CAirlineIcaoCode &airline, const QString &description, const CRgbColor &colorFuselage, const CRgbColor &colorTail, bool isMilitary);

            //! Corresponding airline, if any
            const CAirlineIcaoCode &getAirlineIcaoCode() const { return m_airline; }

            //! Corresponding airline designator, if any
            const QString &getAirlineIcaoCodeDesignator() const { return m_airline.getDesignator(); }

            //! Combined code
            const QString &getCombinedCode() const { return m_combinedCode; }

            //! Combined code plus info
            QString getCombinedCodePlusInfo() const;

            //! Combined code, info, plus id
            QString getCombinedCodePlusInfoAndId() const;

            //! Get description.
            const QString &getDescription() const { return m_description; }

            //! Get corresponding airline name
            const QString &getAirlineName() const { return this->getAirlineIcaoCode().getName(); }

            //! Does simplified airline name contain the candidate
            bool isContainedInSimplifiedAirlineName(const QString &candidate) const;

            //! Get fuselage color.
            const CRgbColor &getColorFuselage() const { return m_colorFuselage; }

            //! Get tail color.
            const CRgbColor &getColorTail() const { return m_colorTail; }

            //! Military livery
            bool isMilitary() const { return m_military; }

            //! Airline ICAO code
            bool setAirlineIcaoCode(const CAirlineIcaoCode &airlineIcao);

            //! Combined code
            void setCombinedCode(const QString &code) { m_combinedCode = code.trimmed().toUpper(); }

            //! Set fuselage color
            void setColorFuselage(const CRgbColor &color) { m_colorFuselage = color; }

            //! Set tail color
            void setColorTail(const CRgbColor &color) { m_colorTail = color; }

            //! Fuselage color set?
            bool hasColorFuselage() const;

            //! Tail color set?
            bool hasColorTail() const;

            //! Has valid (fuselage/tail) colors?
            bool hasValidColors() const;

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

            //! Military aircraft?
            void setMilitary(bool isMilitary) { m_military = isMilitary; }

            //! Matches combined code
            bool matchesCombinedCode(const QString &candidate) const;

            //! Matches colors
            bool matchesColors(const CRgbColor &fuselage, const CRgbColor &tail) const;

            //! \copydoc Mixin::Index::propertyByIndex
            CVariant propertyByIndex(const CPropertyIndex &index) const;

            //! \copydoc Mixin::Index::setPropertyByIndex
            void setPropertyByIndex(const CPropertyIndex &index, const CVariant &variant);

            //! Compare for index
            int comparePropertyByIndex(const CPropertyIndex &index, const CLivery &compareValue) const;

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

            //! Complete data?
            bool hasCompleteData() const;

            //! Validate data
            CStatusMessageList validate() const;

            //! Airline available?
            bool hasValidAirlineDesignator() const;

            //! Livery combined code available?
            bool hasCombinedCode() const;

            //! Livery representing airline
            bool isAirlineLivery() const;

            //! Livery representing airline standard livery
            bool isAirlineStandardLivery() const;

            //! Color livery
            bool isColorLivery() const;

            //! Color distance 0..1 (0 is best)
            double getColorDistance(const CLivery &otherLivery) const;

            //! Combined color distance (fuselage/tail): 0..1 (0 is best)
            double getColorDistance(const CRgbColor &fuselage, const CRgbColor &tail) const;

            //! Update missing parts
            void updateMissingParts(const CLivery &otherLivery);

            //! As a brief HTML summary (e.g. used in tooltips)
            QString asHtmlSummary(const QString &separator) const;

            //! Score by comparison to another livery 0..100
            //! \remark normally used with liveries preselect by airline ICAO code
            int calculateScore(const CLivery &otherLivery, bool preferColorLiveries = false, CStatusMessageList *log = nullptr) const;

            //! Object from JSON
            static CLivery fromDatabaseJson(const QJsonObject &json, const QString &prefix = QString("liv_"));

            //! Valid combined code string?
            static bool isValidCombinedCode(const QString &candidate);

            //! Standard livery marker string
            static const QString &standardLiveryMarker();

            //! Standard code for
            static QString getStandardCode(const Aviation::CAirlineIcaoCode &airline);

            //! Color livery marker
            static const QString &colorLiveryMarker();

            //! The code for a temporary livery
            static const QString &tempLiveryCode();

        private:
            CAirlineIcaoCode m_airline; //!< corresponding airline, if any
            QString m_combinedCode;     //!< livery code and pseudo airline ICAO code
            QString m_description;      //!< describes the livery
            CRgbColor m_colorFuselage;  //!< color of fuselage
            CRgbColor m_colorTail;      //!< color of tail
            bool m_military = false;    //!< military livery?

            BLACK_METACLASS(
                CLivery,
                BLACK_METAMEMBER(dbKey),
                BLACK_METAMEMBER(timestampMSecsSinceEpoch),
                BLACK_METAMEMBER(airline),
                BLACK_METAMEMBER(combinedCode, 0, CaseInsensitiveComparison),
                BLACK_METAMEMBER(description),
                BLACK_METAMEMBER(colorFuselage),
                BLACK_METAMEMBER(colorTail),
                BLACK_METAMEMBER(military)
            );
        };
    } // namespace
} // namespace

Q_DECLARE_METATYPE(BlackMisc::Aviation::CLivery)

#endif // guard