pilotclient/src/blackmisc/simulation/matchingstatisticsentry.h

/* Copyright (C) 2017
 * 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_SIMULATION_MATCHINGSTATISTICSENTRY_H
#define BLACKMISC_SIMULATION_MATCHINGSTATISTICSENTRY_H

#include "blackmisc/blackmiscexport.h"
#include "blackmisc/valueobject.h"
#include "blackmisc/timestampbased.h"
#include "blackmisc/variant.h"

namespace BlackMisc
{
    namespace Simulation
    {
        //! Value object for a matching statistics entry.
        class BLACKMISC_EXPORT CMatchingStatisticsEntry :
            public BlackMisc::CValueObject<CMatchingStatisticsEntry>,
            public BlackMisc::ITimestampBased
        {
        public:
            //! Property indexes
            enum ColumnIndex
            {
                IndexSessionId = CPropertyIndex::GlobalIndexCMatchingStatisticsEntry,
                IndexModelSetId,
                IndexEntryType,
                IndexEntryTypeAsString,
                IndexEntryTypeAsIcon,
                IndexCount,
                IndexDescription,
                IndexAircraftDesignator,
                IndexAirlineDesignator,
                IndexHasAircraftAirlineCombination
            };

            //! Represents type of entry
            enum EntryType
            {
                Found,
                Missing
            };

            //! Default constructor.
            CMatchingStatisticsEntry();

            //! Constructor
            CMatchingStatisticsEntry(EntryType type, const QString &sessionId, const QString &modelSetId, const QString &description, const QString &aircraftDesignator, const QString &airlineDesignator = {});

            //! Session id
            const QString &getSessionId() const { return m_sessionId; }

            //! Set session id
            void setSessionId(const QString &sessionId) { m_sessionId = sessionId.trimmed(); }

            //! Get model set id
            const QString &getModelSetId() const { return m_modelSetId; }

            //! Set model set id
            void setModelSetId(const QString &modelSetId) { m_modelSetId = modelSetId.trimmed(); }

            //! Get missing aircraft designator
            const QString &getAircraftDesignator() const { return m_aircraftDesignator;}

            //! Set missing aircraft designator
            void setAircraftDesignator(const QString &designator) { m_aircraftDesignator = designator.trimmed().toUpper(); }

            //! Get missing airline designator
            const QString &getAirlineDesignator() const { return m_airlineDesignator;}

            //! Set missing airline designator
            void setAirlineDesignator(const QString &designator) { m_airlineDesignator = designator.trimmed().toUpper(); }

            //! Type of entry
            EntryType getEntryType() const;

            //! Missing entry?
            bool isMissing() const;

            //! Set the entry type
            void setEntryType(EntryType type);

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

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

            //! Current count
            int getCount() const;

            //! Count increased by one
            void increaseCount();

            //! Matches given value?
            bool matches(EntryType type, const QString &sessionId, const QString &aircraftDesignator, const QString &airlineDesignator) const;

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

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

            //! Compare by index
            int comparePropertyByIndex(const CPropertyIndex &index, const CMatchingStatisticsEntry &compareValue) const;

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

            //! Missing aircraft/airline combination?
            bool hasAircraftAirlineCombination() const;

            //! Convert entry type
            static const QString &entryTypeToString(EntryType type);

            //! Convert entry type
            static const BlackMisc::CIcon &entryTypeToIcon(EntryType type);

        private:
            QString m_sessionId;           //!< Created in session
            QString m_modelSetId;          //!< represents model set
            QString m_description;         //!< Arbitrary description
            QString m_aircraftDesignator;  //!< missing aircraft designator
            QString m_airlineDesignator;   //!< missing airline designator
            int     m_entryType = Missing; //!< type
            int     m_count = 1;           //!< quantity

            BLACK_METACLASS(
                CMatchingStatisticsEntry,
                BLACK_METAMEMBER(sessionId),
                BLACK_METAMEMBER(modelSetId),
                BLACK_METAMEMBER(aircraftDesignator),
                BLACK_METAMEMBER(airlineDesignator),
                BLACK_METAMEMBER(description),
                BLACK_METAMEMBER(entryType),
                BLACK_METAMEMBER(count)
            );
        };
    } // namespace
} // namespace

Q_DECLARE_METATYPE(BlackMisc::Simulation::CMatchingStatisticsEntry)
Q_DECLARE_METATYPE(BlackMisc::Simulation::CMatchingStatisticsEntry::EntryType)

#endif // guard