mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-04-23 13:55:36 +08:00
Renaming, header, Doxygen, formatting (during refs #314)
This commit is contained in:
@@ -1,7 +1,13 @@
|
||||
/* 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/. */
|
||||
/* 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_AVIOTRANSPONDER_H
|
||||
#define BLACKMISC_AVIOTRANSPONDER_H
|
||||
@@ -13,12 +19,12 @@ namespace BlackMisc
|
||||
namespace Aviation
|
||||
{
|
||||
/*!
|
||||
* \brief Transponder
|
||||
* Transponder
|
||||
*/
|
||||
class CTransponder : public CAvionicsBase
|
||||
{
|
||||
public:
|
||||
//! \brief Transponder codes
|
||||
//! Transponder codes
|
||||
enum TransponderMode
|
||||
{
|
||||
StateStandby = 0, // not a real mode, more a state
|
||||
@@ -29,48 +35,26 @@ namespace BlackMisc
|
||||
ModeS = 20
|
||||
};
|
||||
|
||||
private:
|
||||
BLACK_ENABLE_TUPLE_CONVERSION(CTransponder)
|
||||
qint32 m_transponderCode; //<! Transponder code
|
||||
TransponderMode m_transponderMode; //<! Transponder mode
|
||||
|
||||
protected:
|
||||
//! \brief Default value?
|
||||
virtual bool isDefaultValue() const { return this->m_transponderCode == 0; }
|
||||
|
||||
//! \copydoc CValueObject::convertToQString
|
||||
virtual QString convertToQString(bool i18n = false) const override;
|
||||
|
||||
//! \copydoc CValueObject::marshallFromDbus()
|
||||
virtual void marshallToDbus(QDBusArgument &argument) const override;
|
||||
|
||||
//! \copydoc CValueObject::unmarshallFromDbus()
|
||||
virtual void unmarshallFromDbus(const QDBusArgument &argument) override;
|
||||
|
||||
//! \copydoc CValueObject::compareImpl
|
||||
virtual int compareImpl(const CValueObject &other) const override;
|
||||
|
||||
public:
|
||||
//! \brief Default constructor
|
||||
//! Default constructor
|
||||
CTransponder() : CAvionicsBase("transponder"), m_transponderCode(0), m_transponderMode(StateStandby) {}
|
||||
|
||||
//! \brief Copy constructor
|
||||
//! Copy constructor
|
||||
CTransponder(const CTransponder &other) : CAvionicsBase(other.getName()),
|
||||
m_transponderCode(other.m_transponderCode), m_transponderMode(other.m_transponderMode) {}
|
||||
|
||||
//! \brief Constructor
|
||||
//! Constructor
|
||||
CTransponder(const QString &name, qint32 transponderCode, TransponderMode transponderMode) :
|
||||
CAvionicsBase(name), m_transponderCode(transponderCode), m_transponderMode(transponderMode)
|
||||
{ }
|
||||
|
||||
//! \brief Constructor with transponder mode as string
|
||||
//! Constructor with transponder mode as string
|
||||
CTransponder(const QString &name, qint32 transponderCode, QString transponderMode) :
|
||||
CAvionicsBase(name), m_transponderCode(transponderCode), m_transponderMode(StateStandby)
|
||||
{
|
||||
this->setModeAsString(transponderMode);
|
||||
}
|
||||
|
||||
//! \brief Constructor, code as string
|
||||
//! Constructor, code as string
|
||||
CTransponder(const QString &name, QString transponderCode, TransponderMode transponderMode) :
|
||||
CAvionicsBase(name), m_transponderCode(0), m_transponderMode(transponderMode)
|
||||
{
|
||||
@@ -79,7 +63,7 @@ namespace BlackMisc
|
||||
if (!ok) this->m_transponderCode = -1; // will cause assert / exception
|
||||
}
|
||||
|
||||
//! \brief Constructor
|
||||
//! Constructor
|
||||
CTransponder(const QString &name, QString transponderCode, QString transponderMode) :
|
||||
CAvionicsBase(name), m_transponderCode(0), m_transponderMode(StateStandby)
|
||||
{
|
||||
@@ -98,76 +82,76 @@ namespace BlackMisc
|
||||
return QVariant::fromValue(*this);
|
||||
}
|
||||
|
||||
//! \brief Transponder mode as string
|
||||
//! Transponder mode as string
|
||||
QString getModeAsString() const
|
||||
{
|
||||
return CTransponder::modeAsString(this->getTransponderMode());
|
||||
}
|
||||
|
||||
//! \brief Transponder mode as string
|
||||
//! Transponder mode as string
|
||||
void setModeAsString(const QString &mode)
|
||||
{
|
||||
this->setTransponderMode(CTransponder::modeFromString(mode));
|
||||
}
|
||||
|
||||
//! \brief Transponder mode
|
||||
//! Transponder mode
|
||||
TransponderMode getTransponderMode() const
|
||||
{
|
||||
return this->m_transponderMode;
|
||||
}
|
||||
|
||||
//! \brief Transponder mode as string
|
||||
//! Transponder mode as string
|
||||
static const QString &modeAsString(TransponderMode mode);
|
||||
|
||||
//! \brief Transponder code
|
||||
//! Transponder code
|
||||
qint32 getTransponderCode() const
|
||||
{
|
||||
return this->m_transponderCode;
|
||||
}
|
||||
|
||||
//! \brief Transponder code
|
||||
//! Transponder code
|
||||
QString getTransponderCodeFormatted() const;
|
||||
|
||||
//! \brief Formatted with code / mode
|
||||
//! Formatted with code / mode
|
||||
QString getTransponderCodeAndModeFormatted() const;
|
||||
|
||||
//! \brief Set transponder code
|
||||
//! Set transponder code
|
||||
void setTransponderCode(qint32 transponderCode)
|
||||
{
|
||||
this->m_transponderCode = transponderCode;
|
||||
}
|
||||
|
||||
//! \brief Set transponder code
|
||||
//! Set transponder code
|
||||
void setTransponderCode(const QString &transponderCode);
|
||||
|
||||
//! \brief Mode from string
|
||||
//! Mode from string
|
||||
static TransponderMode modeFromString(const QString &modeString);
|
||||
|
||||
//! \brief Set transponder mode
|
||||
//! Set transponder mode
|
||||
void setTransponderMode(TransponderMode mode)
|
||||
{
|
||||
this->m_transponderMode = mode ;
|
||||
}
|
||||
|
||||
//! \brief Set emergency
|
||||
//! Set emergency
|
||||
void setEmergency()
|
||||
{
|
||||
this->m_transponderCode = 7700;
|
||||
}
|
||||
|
||||
//! \brief Set VFR
|
||||
//! Set VFR
|
||||
void setVFR()
|
||||
{
|
||||
this->m_transponderCode = 7000;
|
||||
}
|
||||
|
||||
//! \brief Set IFR
|
||||
//! Set IFR
|
||||
void setIFR()
|
||||
{
|
||||
this->m_transponderCode = 2000;
|
||||
}
|
||||
|
||||
//! \brief operator ==
|
||||
//! operator ==
|
||||
bool operator ==(const CTransponder &other) const
|
||||
{
|
||||
return
|
||||
@@ -176,13 +160,13 @@ namespace BlackMisc
|
||||
this->CAvionicsBase::operator ==(other);
|
||||
}
|
||||
|
||||
//! \brief operator =!
|
||||
//! operator =!
|
||||
bool operator !=(const CTransponder &other) const
|
||||
{
|
||||
return !((*this) == other);
|
||||
}
|
||||
|
||||
//! \brief Transponder unit
|
||||
//! Transponder unit
|
||||
static CTransponder getStandardTransponder(qint32 transponderCode, TransponderMode mode)
|
||||
{
|
||||
return CTransponder("Transponder", transponderCode, mode);
|
||||
@@ -191,15 +175,6 @@ namespace BlackMisc
|
||||
//! \copydoc CValueObject::getValueHash()
|
||||
virtual uint getValueHash() const override;
|
||||
|
||||
//! \brief Is valid transponder code?
|
||||
static bool isValidTransponderCode(const QString &transponderCode);
|
||||
|
||||
//! \brief Is valid transponder code?
|
||||
static bool isValidTransponderCode(qint32 transponderMode);
|
||||
|
||||
//! \brief Register metadata
|
||||
static void registerMetadata();
|
||||
|
||||
//! \copydoc CValueObject::toJson
|
||||
virtual QJsonObject toJson() const override;
|
||||
|
||||
@@ -208,6 +183,37 @@ namespace BlackMisc
|
||||
|
||||
//! \copydoc TupleConverter<>::jsonMembers()
|
||||
static const QStringList &jsonMembers();
|
||||
|
||||
//! Is valid transponder code?
|
||||
static bool isValidTransponderCode(const QString &transponderCode);
|
||||
|
||||
//! Is valid transponder code?
|
||||
static bool isValidTransponderCode(qint32 transponderMode);
|
||||
|
||||
//! Register metadata
|
||||
static void registerMetadata();
|
||||
|
||||
protected:
|
||||
//! Default value?
|
||||
virtual bool isDefaultValue() const { return this->m_transponderCode == 0; }
|
||||
|
||||
//! \copydoc CValueObject::convertToQString
|
||||
virtual QString convertToQString(bool i18n = false) const override;
|
||||
|
||||
//! \copydoc CValueObject::marshallFromDbus()
|
||||
virtual void marshallToDbus(QDBusArgument &argument) const override;
|
||||
|
||||
//! \copydoc CValueObject::unmarshallFromDbus()
|
||||
virtual void unmarshallFromDbus(const QDBusArgument &argument) override;
|
||||
|
||||
//! \copydoc CValueObject::compareImpl
|
||||
virtual int compareImpl(const CValueObject &other) const override;
|
||||
|
||||
private:
|
||||
BLACK_ENABLE_TUPLE_CONVERSION(CTransponder)
|
||||
qint32 m_transponderCode; //!< Transponder code
|
||||
TransponderMode m_transponderMode; //!< Transponder mode
|
||||
|
||||
};
|
||||
} // namespace
|
||||
} // namespace
|
||||
|
||||
Reference in New Issue
Block a user