heading.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_AVIATION_HEADING_H
#define SWIFT_MISC_AVIATION_HEADING_H
 
#include <QMetaType>
#include <QString>
 
#include "misc/metaclass.h"
#include "misc/mixin/mixincompare.h"
#include "misc/mixin/mixindbus.h"
#include "misc/mixin/mixinhash.h"
#include "misc/mixin/mixinindex.h"
#include "misc/mixin/mixinjson.h"
#include "misc/mixin/mixinmetatype.h"
#include "misc/mixin/mixinstring.h"
#include "misc/pq/angle.h"
#include "misc/pq/units.h"
#include "misc/swiftmiscexport.h"
 
namespace swift::misc::aviation
{
    class SWIFT_MISC_EXPORT CHeading :
        public physical_quantities::CAngle,
        public mixin::MetaType<CHeading>,
        public mixin::EqualsByMetaClass<CHeading>,
        public mixin::CompareByMetaClass<CHeading>,
        public mixin::HashByMetaClass<CHeading>,
        public mixin::DBusByMetaClass<CHeading>,
        public mixin::DataStreamByMetaClass<CHeading>,
        public mixin::JsonByMetaClass<CHeading>,
        public mixin::String<CHeading>,
        public mixin::Index<CHeading>
    {
    public:
        using base_type = physical_quantities::CAngle;
 
        SWIFT_MISC_DECLARE_USING_MIXIN_METATYPE(CHeading)
        SWIFT_MISC_DECLARE_USING_MIXIN_STRING(CHeading)
        SWIFT_MISC_DECLARE_USING_MIXIN_DBUS(CHeading)
        SWIFT_MISC_DECLARE_USING_MIXIN_DATASTREAM(CHeading)
        SWIFT_MISC_DECLARE_USING_MIXIN_JSON(CHeading)
        SWIFT_MISC_DECLARE_USING_MIXIN_INDEX(CHeading)
 
        
        enum ReferenceNorth
        {
            Magnetic = 0, 
            True = 1 
        };
 
        QString convertToQString(bool i18n = false) const;
 
        CHeading() : CAngle(0, physical_quantities::CAngleUnit::rad()), m_north(True) {}
 
        CHeading(double value, const physical_quantities::CAngleUnit &unit) : CAngle(value, unit), m_north(True) {}
 
        CHeading(double value, ReferenceNorth north, const physical_quantities::CAngleUnit &unit)
            : CAngle(value, unit), m_north(north)
        {}
 
        CHeading(const CAngle &heading, ReferenceNorth north) : CAngle(heading), m_north(north) {}
 
        bool isMagneticHeading() const { return Magnetic == this->m_north; }
 
        bool isTrueHeading() const { return True == this->m_north; }
 
        ReferenceNorth getReferenceNorth() const { return m_north; }
 
        void normalizeTo360Degrees();
 
        void normalizeToPlusMinus180Degrees();
 
        CHeading normalizedToPlusMinus180Degrees() const;
 
        CHeading normalizedTo360Degrees() const;
 
        static void registerMetadata();
 
    private:
        ReferenceNorth m_north; 
 
        SWIFT_METACLASS(
            CHeading,
            SWIFT_METAMEMBER(north));
    };
} // namespace swift::misc::aviation
 
Q_DECLARE_METATYPE(swift::misc::aviation::CHeading)
Q_DECLARE_METATYPE(swift::misc::aviation::CHeading::ReferenceNorth)
 
#endif // SWIFT_MISC_AVIATION_HEADING_H