pilotclient/src/blackmisc/aviation/aircrafticaocodelist.cpp

/* 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.
 */

#include "aircrafticaocodelist.h"

namespace BlackMisc
{
    namespace Aviation
    {

        CAircraftIcaoCodeList::CAircraftIcaoCodeList(const CSequence<CAircraftIcaoCode> &other) :
            CSequence<CAircraftIcaoCode>(other)
        { }

        CAircraftIcaoCodeList CAircraftIcaoCodeList::findByDesignator(const QString &designator) const
        {
            if (!CAircraftIcaoCode::isValidDesignator(designator)) { return CAircraftIcaoCodeList(); }
            return this->findBy([&](const CAircraftIcaoCode & code)
            {
                return code.matchesDesignator(designator);
            });
        }

        CAircraftIcaoCodeList CAircraftIcaoCodeList::findByDesignatorOrIataCode(const QString &icaoOrIata) const
        {
            if (icaoOrIata.isEmpty()) { return CAircraftIcaoCodeList(); }
            return this->findBy([&](const CAircraftIcaoCode & code)
            {
                return code.matchesDesignatorOrIata(icaoOrIata);
            });
        }

        CAircraftIcaoCodeList CAircraftIcaoCodeList::findByDesignatorIataOrFamily(const QString &icaoIataOrFamily) const
        {
            if (icaoIataOrFamily.isEmpty()) { return CAircraftIcaoCodeList(); }
            return this->findBy([&](const CAircraftIcaoCode & code)
            {
                return code.matchesDesignatorIataOrFamily(icaoIataOrFamily);
            });
        }

        CAircraftIcaoCodeList CAircraftIcaoCodeList::findByIataCode(const QString &iata) const
        {
            if (iata.isEmpty()) { return CAircraftIcaoCodeList(); }
            return this->findBy([&](const CAircraftIcaoCode & code)
            {
                return code.matchesIataCode(iata);
            });
        }

        CAircraftIcaoCodeList CAircraftIcaoCodeList::findByFamily(const QString &family) const
        {
            if (family.isEmpty()) { return CAircraftIcaoCodeList(); }
            return this->findBy([&](const CAircraftIcaoCode & code)
            {
                return code.matchesFamily(family);
            });
        }

        CAircraftIcaoCodeList CAircraftIcaoCodeList::findByManufacturer(const QString &manufacturer) const
        {
            if (manufacturer.isEmpty()) { return CAircraftIcaoCodeList(); }
            return this->findBy([&](const CAircraftIcaoCode & code)
            {
                return code.getManufacturer().startsWith(manufacturer, Qt::CaseInsensitive);
            });
        }

        CAircraftIcaoCodeList CAircraftIcaoCodeList::findByDescription(const QString &description) const
        {
            if (description.isEmpty()) { return CAircraftIcaoCodeList(); }
            return this->findBy([&](const CAircraftIcaoCode & code)
            {
                return code.getModelDescription().startsWith(description, Qt::CaseInsensitive);
            });
        }

        CAircraftIcaoCode CAircraftIcaoCodeList::findFirstByDesignatorAndRank(const QString &designator) const
        {
            if (!CAircraftIcaoCode::isValidDesignator(designator)) { return CAircraftIcaoCode(); }
            CAircraftIcaoCodeList codes(findByDesignator(designator));
            if (codes.isEmpty()) { return CAircraftIcaoCode(); }
            if (codes.size() < 2) { return codes.front(); }
            codes.sortBy(&CAircraftIcaoCode::getRank, &CAircraftIcaoCode::getDbKey);
            return codes.front();
        }

        void CAircraftIcaoCodeList::sortByRank()
        {
            this->sortBy(&CAircraftIcaoCode::getRank);
        }

        QStringList CAircraftIcaoCodeList::toCompleterStrings(bool withIataCodes, bool withFamily) const
        {
            QStringList c;
            for (const CAircraftIcaoCode &icao : *this)
            {
                c.append(icao.getCombinedIcaoStringWithKey());
                if (withIataCodes && icao.hasIataCode() && !icao.isIataSameAsDesignator())
                {
                    c.append(icao.getCombinedIataStringWithKey());
                }
                if (withFamily && icao.hasFamily() && !icao.isFamilySameAsDesignator())
                {
                    c.append(icao.getCombinedFamilyStringWithKey());
                }
            }
            return c;
        }

        CAircraftIcaoCodeList CAircraftIcaoCodeList::fromDatabaseJson(const QJsonArray &array, bool ignoreIncomplete)
        {
            CAircraftIcaoCodeList codes;
            for (const QJsonValue &value : array)
            {
                CAircraftIcaoCode icao(CAircraftIcaoCode::fromDatabaseJson(value.toObject()));
                if (ignoreIncomplete && !icao.hasSpecialDesignator() && !icao.hasCompleteData()) { continue; }
                codes.push_back(icao);
            }
            return codes;
        }

        CAircraftIcaoCode CAircraftIcaoCodeList::smartAircraftIcaoSelector(const CAircraftIcaoCode &icaoPattern) const
        {
            if (icaoPattern.hasValidDbKey())
            {
                int k = icaoPattern.getDbKey();
                CAircraftIcaoCode c(this->findByKey(k));
                if (c.hasCompleteData()) { return c; }
            }

            // get an initial set of data we can choose from
            CAircraftIcaoCodeList codes;
            if (icaoPattern.hasKnownDesignator())
            {
                const QString d(icaoPattern.getDesignator());
                codes = this->findByDesignator(d);

                // we have one exact match
                if (codes.size() == 1) { return codes.front(); }

                if (codes.isEmpty())
                {
                    // now we search if the ICAO designator is
                    // actually an IATA code
                    codes = this->findByIataCode(d);

                    // we have one exact match
                    if (codes.size() == 1) { return codes.front(); }

                    if (codes.isEmpty())
                    {
                        // still empty, try to find by family
                        codes = this->findByFamily(d);

                        // we have one exact match
                        if (codes.size() == 1) { return codes.front(); }

                        // still empty, hopeless
                        if (codes.isEmpty()) { return icaoPattern; }

                        // continue here, we have more than one code and
                        // will try to further reduce
                    }
                }
                codes.sortByRank();
            }

            // further reduce by manufacturer
            if (icaoPattern.hasManufacturer() && codes.contains(&CAircraftIcaoCode::getManufacturer, icaoPattern.getManufacturer()))
            {
                const QString m(icaoPattern.getManufacturer());
                codes = codes.findByManufacturer(m);
                if (codes.size() == 1) { return codes.front(); }

                // intentionally continue here
            }

            // further reduce by IATA
            if (icaoPattern.hasIataCode() && codes.contains(&CAircraftIcaoCode::getIataCode, icaoPattern.getIataCode()))
            {
                const QString i(icaoPattern.getIataCode());
                codes = codes.findByIataCode(i);
                if (codes.size() == 1) { return codes.front(); }

                // intentionally continue here
            }

            // lucky punch on description?
            if (icaoPattern.hasModelDescription() && codes.contains(&CAircraftIcaoCode::getModelDescription, icaoPattern.getModelDescription()))
            {
                // do not affect codes here, it might return no results
                const QString d(icaoPattern.getModelDescription());
                CAircraftIcaoCodeList cm(codes.findByDescription(d));
                if (cm.size() == 1) { return cm.front(); }
            }
            return codes.frontOrDefault(); // sorted by rank
        }
    } // namespace
} // namespace