/*  Copyright (C) 2013 VATSIM Community / authors
 *  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_AVTRACK_H
#define BLACKMISC_AVTRACK_H
#include "blackmisc/pqangle.h"


namespace BlackMisc
{
namespace Aviation
{

/*!
 * \brief Track as used in aviation, can be true or magnetic Track
 * \remarks Intentionally allowing +/- BlackMisc::PhysicalQuantities::CAngle , and >= / <= CAngle.
 */
class CTrack : public BlackMisc::PhysicalQuantities::CAngle
{
private:
    bool m_magnetic; //!< magnetic or true Track?

protected:
    /*!
     * \brief Specific stream operation for Track
     * \return
     */
    virtual QString stringForStreamingOperator() const;

public:
    /*!
     * \brief Default constructor: 0 Track magnetic
     */
    CTrack() : BlackMisc::PhysicalQuantities::CAngle(0, BlackMisc::PhysicalQuantities::CAngleUnit::rad()), m_magnetic(true) {}
    /*!
     * \brief Constructor
     * \param value
     * \param magnetic
     * \param unit
     */
    CTrack(double value, bool magnetic, const BlackMisc::PhysicalQuantities::CAngleUnit &unit) : BlackMisc::PhysicalQuantities::CAngle(value, unit), m_magnetic(magnetic) {}
    /*!
     * \brief Constructor
     * \param value
     * \param magnetic
     * \param unit
     */
    CTrack(int value, bool magnetic, const BlackMisc::PhysicalQuantities::CAngleUnit &unit) : BlackMisc::PhysicalQuantities::CAngle(value, unit), m_magnetic(magnetic) {}
    /*!
     * \brief Constructor by CAngle
     * \param track
     * \param magnetic
     */
    CTrack(BlackMisc::PhysicalQuantities::CAngle track, bool magnetic) : BlackMisc::PhysicalQuantities::CAngle(), m_magnetic(magnetic) {
        BlackMisc::PhysicalQuantities::CAngle::operator =(track);
    }
    /*!
     * \brief Copy constructor
     * \param otherTrack
     */
    CTrack(const CTrack &otherTrack) : BlackMisc::PhysicalQuantities::CAngle(otherTrack), m_magnetic(otherTrack.m_magnetic) {}
    /*!
     * \brief Assignment operator =
     * \param otherTrack
     * @return
     */
    CTrack &operator =(const CTrack &otherTrack);
    /*!
     * \brief Equal operator ==
     * \param otherTrack
     * @return
     */
    bool operator ==(const CTrack &otherTrack);
    /*!
     * \brief Unequal operator ==
     * \param otherTrack
     * @return
     */
    bool operator !=(const CTrack &otherTrack);
    /*!
     * \brief Magnetic Track?
     * \return
     */
    bool isMagneticTrack() const {
        return this->m_magnetic;
    }
    /*!
     * \brief True Track?
     * \return
     */
    bool isTrueTrack() const {
        return !this->m_magnetic;
    }
};

} // namespace

} // namespace

#endif // BLACKMISC_AVTRACK_H