pilotclient/src/blackmisc/aviotransponder.h

/*  Copyright (C) 2013 VATSIM Community / contributors
 *  This Source Code Form is subject to the terms of the Mozilla Public
 *  License, v. 2.0. If a copy of the MPL was not distributed with this
 *  file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef BLACKMISC_AVIOTRANSPONDER_H
#define BLACKMISC_AVIOTRANSPONDER_H
#include "blackmisc/aviobase.h"
#include <stdexcept>

namespace BlackMisc
{
    namespace Aviation
    {
        /*!
         * \brief Transponder
         */
        class CTransponder : public CAvionicsBase
        {
        public:
            /*!
             * \brief Our transponder codes
             */
            enum TransponderMode
            {
                StateStandby = 0, // not a real mode, more a state
                ModeMil1 = 1, ModeMil2 = 2, ModeMil3 = 3, ModeMil4 = 4, ModeMil5 = 5,
                StateIdent = 10, // not a real mode, more a state
                ModeA = 11,
                ModeC = 12,
                ModeS = 20
            };

        private:
            qint32 m_transponderCode; //<! Transponder code
            TransponderMode m_transponderMode; //<! Transponder mode

            /*!
             * \brief Constructor for validation
             * \param validate
             * \param name
             * \param transponderCode
             * \param transponderMode
             */
            CTransponder(bool validate, const QString &name, qint32 transponderCode, TransponderMode transponderMode) :
                CAvionicsBase(name), m_transponderCode(transponderCode), m_transponderMode(transponderMode)
            {
                this->validate(validate);
            }

            /*!
             * \brief Constructor for validation
             * \param validate
             * \param name
             * \param transponderCode
             * \param transponderMode
             */
            CTransponder(bool validate, const QString &name, const QString transponderCode, TransponderMode transponderMode) :
                CAvionicsBase(name), m_transponderCode(0), m_transponderMode(transponderMode)
            {
                bool ok = false;
                this->m_transponderCode = transponderCode.toUInt(&ok);
                if (!ok) this->m_transponderCode = -1; // will cause assert / exception
                this->validate(validate);
            }

        protected:
            /*!
             * \brief Are the set values valid / in range?
             * \return
             */
            bool validValues() const;

            /*!
             * \brief Default value
             * \return
             */
            virtual bool isDefaultValue() const
            {
                return this->m_transponderCode == 0;
            }

            /*!
             * \brief Validate values by assert and exception
             * \param strict
             * \throws std::range_error
             * \remarks Cannot be virtualsince already used in constructor
             * \return
             */
            bool validate(bool strict = true) const;

            /*!
             * \brief Meaningful string representation
             * \param i18n
             * \return
             */
            virtual QString convertToQString(bool i18n = false) const;

            /*!
             * \brief Stream to DBus <<
             * \param argument
             */
            virtual void marshallToDbus(QDBusArgument &argument) const;

            /*!
             * \brief Stream from DBus >>
             * \param argument
             */
            virtual void unmarshallFromDbus(const QDBusArgument &argument);

        public:
            /*!
             * Default constructor
             */
            CTransponder() : CAvionicsBase("transponder"), m_transponderCode(0), m_transponderMode(ModeS) {}

            /*!
             * \brief Copy constructor
             * \param other
             */
            CTransponder(const CTransponder &other) : CAvionicsBase(other.getName()),
                m_transponderCode(other.m_transponderCode), m_transponderMode(other.m_transponderMode) {}

            /*!
             * \brief Constructor
             * \param name
             * \param transponderCode
             * \param transponderMode
             */
            CTransponder(const QString &name, qint32 transponderCode, TransponderMode transponderMode) :
                CAvionicsBase(name), m_transponderCode(transponderCode), m_transponderMode(transponderMode)
            {
                this->validate(true);
            }

            /*!
             * \brief Constructor
             * \param name
             * \param transponderCode
             * \param transponderMode
             */
            CTransponder(const QString &name, const QString &transponderCode, TransponderMode transponderMode) :
                CAvionicsBase(name), m_transponderCode(0), m_transponderMode(transponderMode)
            {
                bool ok = false;
                this->m_transponderCode = transponderCode.toUInt(&ok);
                if (!ok) this->m_transponderCode = -1; // will cause assert / exception
                this->validate(true);
            }

            /*!
             * \brief QVariant, required for DBus QVariant lists
             * \return
             */
            virtual QVariant toQVariant() const
            {
                return QVariant::fromValue(*this);
            }

            /*!
             * \brief Transponder mode as string
             * \return
             * \throws std::range_erros
             */
            QString getModeAsString() const;

            /*!
             * \brief Transponder mode
             * \return
             */
            TransponderMode getTransponderMode() const
            {
                return this->m_transponderMode;
            }

            /*!
             * \brief Transponder code
             * \return
             */
            qint32 getTransponderCode() const
            {
                return this->m_transponderCode;
            }

            /*!
             * \brief Transponder code
             * \return
             */
            QString getTransponderCodeFormatted() const;

            /*!
             * \brief Formatted with code / mode
             * \return
             */
            QString getTransponderCodeAndModeFormatted() const;


            /*!
             * \brief Set transponder code
             * \param transponderCode
             */
            void setTransponderCode(qint32 transponderCode)
            {
                this->m_transponderCode = transponderCode;
                this->validate(true);
            }

            /*!
             * \brief Set transponder mode
             * \param mode
             */
            void setTransponderMode(TransponderMode mode)
            {
                this->m_transponderMode = mode ;
                this->validate(true);
            }

            /*!
             * \brief Set emergency
             */
            void setEmergency()
            {
                this->m_transponderCode = 7700;
            }

            /*!
             * \brief Set VFR
             */
            void setVFR()
            {
                this->m_transponderCode = 7000;
            }

            /*!
             * \brief Set IFR
             */
            void setIFR()
            {
                this->m_transponderCode = 2000;
            }

            /*!
             * \brief operator ==
             * \param other
             * \return
             */
            bool operator ==(const CTransponder &other) const
            {
                return
                    this->m_transponderCode == other.m_transponderCode &&
                    this->m_transponderMode == other.m_transponderMode &&
                    this->CAvionicsBase::operator ==(other);
            }

            /*!
             * \brief operator =!
             * \param other
             * \return
             */
            bool operator !=(const CTransponder &other) const
            {
                return !((*this) == other);
            }

            /*!
             * Try to get a Transponder unit with given name and code. Returns true in case an object
             * has been sucessfully created, otherwise returns a default object.
             * \param[out] o_transponder
             * \param name
             * \param transponderCode
             * \param mode
             * \return
             */
            static bool tryGetTransponder(CTransponder &o_transponder, const QString &name, qint32 transponderCode, TransponderMode mode)
            {
                o_transponder = CTransponder(false, name, transponderCode, mode);
                bool s;
                if (!(s = o_transponder.validate(false))) o_transponder = CTransponder(); // reset to default
                return s;
            }

            /*!
             * Try to get a Transponder unit with given name and code. Returns true in case an object
             * has been sucessfully created, otherwise returns a default object.
             * \param[out] o_transponder
             * \param name
             * \param transponderCode
             * \param mode
             * \return
             */
            static bool tryGetTransponder(CTransponder &o_transponder, const QString &name, const QString &transponderCode, TransponderMode mode)
            {
                o_transponder = CTransponder(false, name, transponderCode, mode);
                bool s;
                if (!(s = o_transponder.validate(false))) o_transponder = CTransponder(); // reset to default
                return s;
            }

            /*!
             * \brief Transponder unit
             * \param transponderCode
             * \param mode
             * \return
             */
            static CTransponder getStandardTransponder(qint32 transponderCode, TransponderMode mode)
            {
                return CTransponder("Transponder", transponderCode, mode);
            }

            /*!
             * \brief Try to get Transponder unit
             * \param[out] o_transponder
             * \param transponderCode
             * \param mode
             * \return
             */
            static bool tryGetStandardTransponder(CTransponder &o_transponder, qint32 transponderCode, TransponderMode mode)
            {
                return CTransponder::tryGetTransponder(o_transponder, "Transponder", transponderCode, mode);
            }

            /*!
             * \brief Try to get Transponder unit
             * \param[out] o_transponder
             * \param transponderCode
             * \param mode
             * \return
             */
            static bool tryGetStandardTransponder(CTransponder &o_transponder, const QString &transponderCode, TransponderMode mode)
            {
                return CTransponder::tryGetTransponder(o_transponder, "Transponder", transponderCode, mode);
            }

            /*!
             * \brief Value hash
             * \return
             */
            virtual uint getValueHash() const;

            /*!
             * \brief Register metadata of unit and quantity
             */
            static void registerMetadata();

        };

    } // namespace
} // namespace

Q_DECLARE_METATYPE(BlackMisc::Aviation::CTransponder)

#endif // BLACKMISC_AVIOTRANSPONDER_H