mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-03-31 04:25:35 +08:00
794bf0cd74
The following issues were fixed * Fixed wrong/missing namespaces * Fixed obvious typos in documentation * Documentation not in sync with source code refs #544
87 lines
3.2 KiB
C++
87 lines
3.2 KiB
C++
/* Copyright (C) 2013
|
|
* 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.
|
|
*/
|
|
|
|
//! \file
|
|
|
|
#ifndef BLACKMISC_AVIATION_HEADING_H
|
|
#define BLACKMISC_AVIATION_HEADING_H
|
|
|
|
#include "blackmisc/blackmiscexport.h"
|
|
#include "blackmisc/pq/angle.h"
|
|
|
|
namespace BlackMisc
|
|
{
|
|
namespace Aviation
|
|
{
|
|
|
|
/*!
|
|
* \brief Heading as used in aviation, can be true or magnetic heading
|
|
* \remarks Intentionally allowing +/- CAngle , and >= / <= CAngle.
|
|
*/
|
|
class BLACKMISC_EXPORT CHeading :
|
|
public PhysicalQuantities::CAngle,
|
|
public Mixin::MetaType<CHeading>,
|
|
public Mixin::EqualsByTuple<CHeading>,
|
|
public Mixin::CompareByTuple<CHeading>,
|
|
public Mixin::HashByTuple<CHeading>,
|
|
public Mixin::DBusByTuple<CHeading>,
|
|
public Mixin::JsonByTuple<CHeading>,
|
|
public Mixin::String<CHeading>,
|
|
public Mixin::Index<CHeading>
|
|
{
|
|
public:
|
|
//! Base type
|
|
using base_type = PhysicalQuantities::CAngle;
|
|
|
|
BLACKMISC_DECLARE_USING_MIXIN_METATYPE(CHeading)
|
|
BLACKMISC_DECLARE_USING_MIXIN_STRING(CHeading)
|
|
BLACKMISC_DECLARE_USING_MIXIN_DBUS(CHeading)
|
|
BLACKMISC_DECLARE_USING_MIXIN_JSON(CHeading)
|
|
BLACKMISC_DECLARE_USING_MIXIN_INDEX(CHeading)
|
|
|
|
//! Enum type to distinguish between true north and magnetic north
|
|
enum ReferenceNorth
|
|
{
|
|
Magnetic = 0, //!< magnetic north
|
|
True = 1 //!< true north
|
|
};
|
|
|
|
//! \copydoc BlackMisc::Mixin::String::toQString
|
|
QString convertToQString(bool i18n = false) const;
|
|
|
|
//! \brief Default constructor: 0 heading true
|
|
CHeading() : CAngle(0, BlackMisc::PhysicalQuantities::CAngleUnit::rad()), m_north(Magnetic) {}
|
|
|
|
//! \brief Constructor
|
|
CHeading(double value, ReferenceNorth north, const BlackMisc::PhysicalQuantities::CAngleUnit &unit) : CAngle(value, unit), m_north(north) {}
|
|
|
|
//! \brief Constructor by CAngle
|
|
CHeading(CAngle heading, ReferenceNorth north) : CAngle(heading), m_north(north) {}
|
|
|
|
//! \brief Magnetic heading?
|
|
bool isMagneticHeading() const { return Magnetic == this->m_north; }
|
|
|
|
//! \brief True heading?
|
|
bool isTrueHeading() const { return True == this->m_north; }
|
|
|
|
//! \brief Get reference north (magnetic or true)
|
|
ReferenceNorth getReferenceNorth() const { return m_north; }
|
|
|
|
private:
|
|
BLACK_ENABLE_TUPLE_CONVERSION(CHeading)
|
|
ReferenceNorth m_north; //!< magnetic or true?
|
|
};
|
|
}
|
|
}
|
|
|
|
BLACK_DECLARE_TUPLE_CONVERSION(BlackMisc::Aviation::CHeading, (o.m_north))
|
|
Q_DECLARE_METATYPE(BlackMisc::Aviation::CHeading)
|
|
|
|
#endif // guard
|