mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-04-07 02:35:33 +08:00
Avionics classes for Transponder, ADF, changed namespace to 2ndlevel
This commit is contained in:
Klaus Basan
247
src/blackmisc/avioadfsystem.h
Normal file
247
src/blackmisc/avioadfsystem.h
Normal file
@@ -0,0 +1,247 @@
|
||||
/* 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 AVIOADFSYSTEM_H
|
||||
#define AVIOADFSYSTEM_H
|
||||
|
||||
#include "blackmisc/aviomodulator.h"
|
||||
|
||||
namespace BlackMisc
|
||||
{
|
||||
namespace Aviation
|
||||
{
|
||||
|
||||
/*!
|
||||
* \brief ADF system ("for NDBs")
|
||||
*/
|
||||
class CAdfSystem : public CModulator<CAdfSystem>
|
||||
{
|
||||
private:
|
||||
/*!
|
||||
* \brief Valid civil aviation frequency?
|
||||
* \param f
|
||||
* \return
|
||||
*/
|
||||
bool isValidFrequency(CFrequency f) const {
|
||||
double fr = f.valueRounded(CFrequencyUnit::kHz(), this->m_digits);
|
||||
return fr >= 190.0 && fr <= 1750.0;
|
||||
}
|
||||
/*!
|
||||
* \brief Constructor
|
||||
* \param validate
|
||||
* \param name
|
||||
* \param activeFrequency
|
||||
* \param standbyFrequency
|
||||
* \param digits
|
||||
*
|
||||
*/
|
||||
CAdfSystem(bool validate, const QString &name, const CFrequency &activeFrequency, const CFrequency &standbyFrequency, int digits = 3):
|
||||
CModulator(name, activeFrequency, standbyFrequency, digits) {
|
||||
this->validate(validate);
|
||||
}
|
||||
|
||||
protected:
|
||||
/*!
|
||||
* \brief Are the set values valid / in range?
|
||||
* \return
|
||||
*/
|
||||
bool validValues() const {
|
||||
if (this->isDefaultValue()) return true; // special case
|
||||
return
|
||||
(this->isValidFrequency(this->getFrequencyActive()) &&
|
||||
(this->isValidFrequency(this->getFrequencyStandby());
|
||||
}
|
||||
/*!
|
||||
* \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 {
|
||||
if (this->isDefaultValue()) return true;
|
||||
bool valid = this->validValues();
|
||||
if (!strict) return valid;
|
||||
Q_ASSERT_X(valid, "CAdfSystem::validate", "illegal values");
|
||||
if (!valid) throw std::range_error("Illegal values in CAdfSystem::validate");
|
||||
return true;
|
||||
}
|
||||
public:
|
||||
/*!
|
||||
* Default constructor
|
||||
*/
|
||||
CAdfSystem() : CModulator() {}
|
||||
/*!
|
||||
* \brief Copy constructor
|
||||
* \param otherSystem
|
||||
*/
|
||||
CAdfSystem(const CAdfSystem &otherSystem) : CModulator(otherSystem) {}
|
||||
/*!
|
||||
* \brief Constructor
|
||||
* \param name
|
||||
* \param activeFrequency
|
||||
* \param standbyFrequency
|
||||
* \param digits
|
||||
*/
|
||||
CAdfSystem(const QString &name, const CFrequency &activeFrequency, const CFrequency &standbyFrequency = CModulator::FrequencyNotSet(), int digits = 3):
|
||||
CModulator(name, activeFrequency, standbyFrequency == CModulator::FrequencyNotSet() ? activeFrequency : standbyFrequency, digits) {
|
||||
this->validate(true);
|
||||
}
|
||||
/*!
|
||||
* \brief Set active frequency
|
||||
* \param frequencyKHz
|
||||
*/
|
||||
void setFrequencyActiveKHz(double frequencyKHz) {
|
||||
CModulator::setFrequencyActiveKHz(frequencyKHz);
|
||||
this->validate(true);
|
||||
}
|
||||
/*!
|
||||
* \brief Set standby frequency
|
||||
* \param frequencyKHz
|
||||
*/
|
||||
void setFrequencyActiveKHz(double frequencyKHz) {
|
||||
CModulator::setFrequencyStandbyKHz(frequencyKHz);
|
||||
this->validate(true);
|
||||
}
|
||||
/*!
|
||||
* \brief Assigment operator =
|
||||
* \param otherSystem
|
||||
* \return
|
||||
*/
|
||||
CAdfSystem& operator =(const CAdfSystem &otherSystem) {
|
||||
CModulator::operator =(otherSystem);
|
||||
return (*this);
|
||||
}
|
||||
/*!
|
||||
* \brief operator ==
|
||||
* \param otherSystem
|
||||
* \return
|
||||
*/
|
||||
bool operator ==(const CAdfSystem &otherSystem) const {
|
||||
return CModulator::operator ==(otherSystem);
|
||||
}
|
||||
/*!
|
||||
* \brief operator ==
|
||||
* \param otherSystem
|
||||
* \return
|
||||
*/
|
||||
bool operator !=(const CAdfSystem &otherSystem) const {
|
||||
return CModulator::operator !=(otherSystem);
|
||||
}
|
||||
|
||||
/*!
|
||||
* Try to get a ADF unit with given name and frequency. Returns true in case an object
|
||||
* has been sucessfully created, otherwise returns a default object.
|
||||
* \param adfSystem
|
||||
* \param name
|
||||
* \param activeFrequencyKHz
|
||||
* \param standbyFrequencyKHz
|
||||
* \return
|
||||
*/
|
||||
static bool tryGetAdfSystem(CAdfSystem &adfSystem, const QString &name, double activeFrequencyKHz, double standbyFrequencyKHz = -1) {
|
||||
adfSystem = CAdfSystem(false, name, CFrequency(activeFrequencyKHz, CFrequencyUnit::MHz()), CFrequency(standbyFrequencyKHz < 0 ? activeFrequencyKHz : standbyFrequencyKHz, CFrequencyUnit::MHz()));
|
||||
bool s;
|
||||
if (!(s = adfSystem.validate(false))) adfSystem = CAdfSystem(); // reset to default
|
||||
return s;
|
||||
}
|
||||
|
||||
/*!
|
||||
* Try to get a ADF unit with given name and frequency. Returns true in case an object
|
||||
* has been sucessfully created, otherwise returns a default object.
|
||||
* \param adfSystem
|
||||
* \param name
|
||||
* \param activeFrequency
|
||||
* \param standbyFrequency
|
||||
* \return
|
||||
*/
|
||||
static bool tryGetAdfSystem(CAdfSystem &adfSystem, const QString &name, CFrequency activeFrequency, CFrequency standbyFrequency = CModulator::FrequencyNotSet()) {
|
||||
adfSystem = CAdfSystem(false, name, activeFrequency, standbyFrequency);
|
||||
bool s;
|
||||
if (!(s = adfSystem.validate(false))) adfSystem = CAdfSystem(); // reset to default
|
||||
return s;
|
||||
}
|
||||
/*!
|
||||
* \brief ADF1 unit
|
||||
* \param activeFrequencyKHz
|
||||
* \param standbyFrequencyKHz
|
||||
* \return
|
||||
*/
|
||||
static CAdfSystem GetAdf1System(double activeFrequencyKHz, double standbyFrequencyKHz = -1) {
|
||||
return CAdfSystem(CModulator::NameCom1(), CFrequency(activeFrequencyKHz, CFrequencyUnit::MHz()), CFrequency(standbyFrequencyKHz < 0 ? activeFrequencyKHz : standbyFrequencyKHz, CFrequencyUnit::MHz()));
|
||||
}
|
||||
/*!
|
||||
* \brief ADF1 unit
|
||||
* \param activeFrequency
|
||||
* \param standbyFrequency
|
||||
* \return
|
||||
*/
|
||||
static CAdfSystem GetAdf1System(CFrequency activeFrequency, CFrequency standbyFrequency = CModulator::FrequencyNotSet()) {
|
||||
return CAdfSystem(CModulator::NameCom1(), activeFrequency, standbyFrequency == CModulator::FrequencyNotSet() ? activeFrequency : standbyFrequency);
|
||||
}
|
||||
/*!
|
||||
* \brief Try to get ADF unit
|
||||
* \param adfSystem
|
||||
* \param activeFrequencyKHz
|
||||
* \param standbyFrequencyKHz
|
||||
* \return
|
||||
*/
|
||||
static bool tryGetAdf1Unit(CAdfSystem &adfSystem, double activeFrequencyKHz, double standbyFrequencyKHz = -1) {
|
||||
return CAdfSystem::tryGetAdfSystem(adfSystem, CModulator::NameCom1(), activeFrequencyKHz, standbyFrequencyKHz);
|
||||
}
|
||||
/*!
|
||||
* \brief Try to get ADF unit
|
||||
* \param adfSystem
|
||||
* \param activeFrequency
|
||||
* \param standbyFrequency
|
||||
* \return
|
||||
*/
|
||||
static bool tryGetAdf1Unit(CAdfSystem &adfSystem, CFrequency activeFrequency, CFrequency standbyFrequency = CModulator::FrequencyNotSet()) {
|
||||
return CAdfSystem::tryGetAdfSystem(adfSystem, CModulator::NameCom1(), activeFrequency, standbyFrequency);
|
||||
}
|
||||
/*!
|
||||
* \brief ADF2 unit
|
||||
* \param activeFrequencyKHz
|
||||
* \param standbyFrequencyKHz
|
||||
* \return
|
||||
*/
|
||||
static CAdfSystem GetAdf2System(double activeFrequencyKHz, double standbyFrequencyKHz = -1) {
|
||||
return CAdfSystem(CModulator::NameCom2(), CFrequency(activeFrequencyKHz, CFrequencyUnit::MHz()), CFrequency(standbyFrequencyKHz < 0 ? activeFrequencyKHz : standbyFrequencyKHz, CFrequencyUnit::MHz()));
|
||||
}
|
||||
/*!
|
||||
* \brief ADF2 unit
|
||||
* \param activeFrequency
|
||||
* \param standbyFrequency
|
||||
* \return
|
||||
*/
|
||||
static CAdfSystem GetAdf2System(CFrequency activeFrequency, CFrequency standbyFrequency = CModulator::FrequencyNotSet()) {
|
||||
return CAdfSystem(CModulator::NameCom2(), activeFrequency, standbyFrequency == CModulator::FrequencyNotSet() ? activeFrequency : standbyFrequency);
|
||||
}
|
||||
/*!
|
||||
* \brief Try to get ADF unit
|
||||
* \param adfSystem
|
||||
* \param activeFrequencyKHz
|
||||
* \param standbyFrequencyKHz
|
||||
* \return
|
||||
*/
|
||||
static bool tryGetAdf2System(CAdfSystem &adfSystem, double activeFrequencyKHz, double standbyFrequencyKHz = -1) {
|
||||
return CAdfSystem::tryGetAdfSystem(adfSystem, CModulator::NameCom2(), activeFrequencyKHz, standbyFrequencyKHz);
|
||||
}
|
||||
/*!
|
||||
* \brief Try to get ADF unit
|
||||
* \param adfSystem
|
||||
* \param activeFrequency
|
||||
* \param standbyFrequency
|
||||
* \return
|
||||
*/
|
||||
static bool tryGetAdf2System(CAdfSystem &adfSystem, CFrequency activeFrequency, CFrequency standbyFrequency = CModulator::FrequencyNotSet()) {
|
||||
return CAdfSystem::tryGetAdfSystem(adfSystem, CModulator::NameCom2(), activeFrequency, standbyFrequency);
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace
|
||||
} // namespace
|
||||
|
||||
|
||||
#endif // AVIOADFSYSTEM_H
|
||||
Reference in New Issue
Block a user