use enums instead of bools to distinguish true/magnetic headings and tracks and MSL/AGL altitudes

This commit is contained in:
Mathew Sutcliffe
2013-08-19 18:11:54 +01:00
parent 5f267e8245
commit cec9de5cc5
12 changed files with 104 additions and 74 deletions

View File

@@ -19,7 +19,7 @@ namespace Aviation
QString CAltitude::convertToQString(bool /* i18n */) const
{
QString s = this->CLength::convertToQString();
return s.append(this->m_msl ? " MSL" : " AGL");
return s.append(this->isMeanSeaLevel() ? " MSL" : " AGL");
}
/*
@@ -27,7 +27,7 @@ QString CAltitude::convertToQString(bool /* i18n */) const
*/
bool CAltitude::operator ==(const CAltitude &other)
{
return other.m_msl == this->m_msl && this->CLength::operator ==(other);
return other.m_datum == this->m_datum && this->CLength::operator ==(other);
}
/*

View File

@@ -18,8 +18,18 @@ namespace Aviation
*/
class CAltitude : public BlackMisc::PhysicalQuantities::CLength
{
public:
/*!
* Enum type to distinguish between MSL and AGL
*/
enum ReferenceDatum
{
MeanSeaLevel = 0, //!< MSL
AboveGround = 1, //!< AGL
};
private:
bool m_msl; //!< MSL or AGL?
ReferenceDatum m_datum; //!< MSL or AGL?
protected:
/*!
@@ -36,7 +46,7 @@ protected:
virtual void marshallToDbus(QDBusArgument &argument) const
{
this->CLength::marshallToDbus(argument);
argument << this->m_msl;
argument << qint32(this->m_datum);
}
/*!
@@ -46,37 +56,31 @@ protected:
virtual void unmarshallFromDbus(const QDBusArgument &argument)
{
this->CLength::unmarshallFromDbus(argument);
argument >> this->m_msl;
qint32 datum;
argument >> datum;
this->m_datum = static_cast<ReferenceDatum>(datum);
}
public:
/*!
* \brief Default constructor: 0 Altitude true
*/
CAltitude() : BlackMisc::PhysicalQuantities::CLength(0, BlackMisc::PhysicalQuantities::CLengthUnit::m()), m_msl(true) {}
CAltitude() : BlackMisc::PhysicalQuantities::CLength(0, BlackMisc::PhysicalQuantities::CLengthUnit::m()), m_datum(MeanSeaLevel) {}
/*!
* \brief Constructor
* \param value
* \param msl MSL or AGL?
* \param datum MSL or AGL?
* \param unit
*/
CAltitude(double value, bool msl, const BlackMisc::PhysicalQuantities::CLengthUnit &unit) : BlackMisc::PhysicalQuantities::CLength(value, unit), m_msl(msl) {}
/*!
* \brief Constructor
* \param value
* \param msl MSL or AGL?
* \param unit
*/
CAltitude(int value, bool msl, const BlackMisc::PhysicalQuantities::CLengthUnit &unit) : CLength(value, unit), m_msl(msl) {}
CAltitude(double value, ReferenceDatum datum, const BlackMisc::PhysicalQuantities::CLengthUnit &unit) : BlackMisc::PhysicalQuantities::CLength(value, unit), m_datum(datum) {}
/*!
* \brief Constructor by CLength
* \param altitude
* \param msl
* \param datum
*/
CAltitude(BlackMisc::PhysicalQuantities::CLength altitude, bool msl) : BlackMisc::PhysicalQuantities::CLength(altitude), m_msl(msl) {}
CAltitude(BlackMisc::PhysicalQuantities::CLength altitude, ReferenceDatum datum) : BlackMisc::PhysicalQuantities::CLength(altitude), m_datum(datum) {}
/*!
* \brief Equal operator ==
@@ -98,7 +102,7 @@ public:
*/
bool isAboveGroundLevel() const
{
return !this->m_msl;
return AboveGround == this->m_datum;
}
/*!
@@ -107,9 +111,15 @@ public:
*/
bool isMeanSeaLevel() const
{
return this->m_msl;
return MeanSeaLevel == this->m_datum;
}
/*!
* \brief Get reference datum (MSL or AGL)
* \return
*/
ReferenceDatum getReferenceDatum() const { return m_datum; }
/*!
* \brief Register metadata
*/

View File

@@ -19,7 +19,7 @@ namespace Aviation
QString CHeading::convertToQString(bool i18n) const
{
QString s = CAngle::convertToQString(i18n);
return s.append(this->m_magnetic ? " magnetic" : " true");
return s.append(this->isMagneticHeading() ? " magnetic" : " true");
}
/*
@@ -27,7 +27,7 @@ QString CHeading::convertToQString(bool i18n) const
*/
bool CHeading::operator ==(const CHeading &other)
{
return other.m_magnetic == this->m_magnetic && this->CAngle::operator ==(other);
return other.m_north == this->m_north && this->CAngle::operator ==(other);
}
/*

View File

@@ -18,8 +18,18 @@ namespace Aviation
*/
class CHeading : public BlackMisc::PhysicalQuantities::CAngle
{
public:
/*!
* Enum type to distinguish between true north and magnetic north
*/
enum ReferenceNorth
{
Magnetic = 0, //!< magnetic north
True = 1, //!< true north
};
private:
bool m_magnetic; //!< magnetic or true heading?
ReferenceNorth m_north; //!< magnetic or true?
protected:
/*!
@@ -36,7 +46,7 @@ protected:
virtual void marshallToDbus(QDBusArgument &argument) const
{
this->CAngle::marshallToDbus(argument);
argument << this->m_magnetic;
argument << qint32(this->m_north);
}
/*!
@@ -46,37 +56,31 @@ protected:
virtual void unmarshallFromDbus(const QDBusArgument &argument)
{
this->CAngle::unmarshallFromDbus(argument);
argument >> this->m_magnetic;
qint32 north;
argument >> north;
this->m_north = static_cast<ReferenceNorth>(north);
}
public:
/*!
* \brief Default constructor: 0 heading true
*/
CHeading() : CAngle(0, BlackMisc::PhysicalQuantities::CAngleUnit::rad()), m_magnetic(true) {}
CHeading() : CAngle(0, BlackMisc::PhysicalQuantities::CAngleUnit::rad()), m_north(Magnetic) {}
/*!
* \brief Constructor
* \param value
* \param magnetic
* \param north
* \param unit
*/
CHeading(double value, bool magnetic, const BlackMisc::PhysicalQuantities::CAngleUnit &unit) : CAngle(value, unit), m_magnetic(magnetic) {}
/*!
* \brief Constructor
* \param value
* \param magnetic
* \param unit
*/
CHeading(int value, bool magnetic, const BlackMisc::PhysicalQuantities::CAngleUnit &unit) : CAngle(value, unit), m_magnetic(magnetic) {}
CHeading(double value, ReferenceNorth north, const BlackMisc::PhysicalQuantities::CAngleUnit &unit) : CAngle(value, unit), m_north(north) {}
/*!
* \brief Constructor by CAngle
* \param heading
* \param north
* \param magnetic
*/
CHeading(CAngle heading, bool magnetic) : CAngle(heading), m_magnetic(magnetic) {}
CHeading(CAngle heading, ReferenceNorth north) : CAngle(heading), m_north(north) {}
/*!
* \brief Equal operator ==
@@ -96,13 +100,19 @@ public:
* \brief Magnetic heading?
* \return
*/
bool isMagneticHeading() const { return this->m_magnetic; }
bool isMagneticHeading() const { return Magnetic == this->m_north; }
/*!
* \brief True heading?
* \return
*/
bool isTrueHeading() const { return !this->m_magnetic; }
bool isTrueHeading() const { return True == this->m_north; }
/*!
* \brief Get reference north (magnetic or true)
* \return
*/
ReferenceNorth getReferenceNorth() const { return m_north; }
/*!
* \brief Register metadata

View File

@@ -19,7 +19,7 @@ namespace Aviation
QString CTrack::convertToQString(bool i18n) const
{
QString s = CAngle::convertToQString(i18n);
return s.append(this->m_magnetic ? " magnetic" : " true");
return s.append(this->isMagneticTrack() ? " magnetic" : " true");
}
/*
@@ -27,7 +27,7 @@ QString CTrack::convertToQString(bool i18n) const
*/
bool CTrack::operator ==(const CTrack &other)
{
return other.m_magnetic == this->m_magnetic && this->CAngle::operator ==(other);
return other.m_north == this->m_north && this->CAngle::operator ==(other);
}
/*

View File

@@ -18,8 +18,18 @@ namespace Aviation
*/
class CTrack : public BlackMisc::PhysicalQuantities::CAngle
{
public:
/*!
* Enum type to distinguish between true north and magnetic north
*/
enum ReferenceNorth
{
Magnetic = 0, //!< magnetic north
True = 1, //!< true north
};
private:
bool m_magnetic; //!< magnetic or true Track?
ReferenceNorth m_north; //!< magnetic or true?
protected:
/*!
@@ -35,7 +45,7 @@ protected:
virtual void marshallToDbus(QDBusArgument &argument) const
{
this->CAngle::marshallToDbus(argument);
argument << this->m_magnetic;
argument << qint32(this->m_north);
}
/*!
@@ -45,37 +55,31 @@ protected:
virtual void unmarshallFromDbus(const QDBusArgument &argument)
{
this->CAngle::unmarshallFromDbus(argument);
argument >> this->m_magnetic;
qint32 north;
argument >> north;
this->m_north = static_cast<ReferenceNorth>(north);
}
public:
/*!
* \brief Default constructor: 0 Track magnetic
*/
CTrack() : BlackMisc::PhysicalQuantities::CAngle(0, BlackMisc::PhysicalQuantities::CAngleUnit::rad()), m_magnetic(true) {}
CTrack() : BlackMisc::PhysicalQuantities::CAngle(0, BlackMisc::PhysicalQuantities::CAngleUnit::rad()), m_north(Magnetic) {}
/*!
* \brief Constructor
* \param value
* \param magnetic
* \param north
* \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) {}
CTrack(double value, ReferenceNorth north, const BlackMisc::PhysicalQuantities::CAngleUnit &unit) : BlackMisc::PhysicalQuantities::CAngle(value, unit), m_north(north) {}
/*!
* \brief Constructor by CAngle
* \param track
* \param magnetic
* \param north
*/
CTrack(BlackMisc::PhysicalQuantities::CAngle track, bool magnetic) : BlackMisc::PhysicalQuantities::CAngle(track), m_magnetic(magnetic) {}
CTrack(BlackMisc::PhysicalQuantities::CAngle track, ReferenceNorth north) : BlackMisc::PhysicalQuantities::CAngle(track), m_north(north) {}
/*!
* \brief Equal operator ==
@@ -97,9 +101,8 @@ public:
*/
bool isMagneticTrack() const
{
return this->m_magnetic;
return Magnetic == this->m_north;
(void)QT_TRANSLATE_NOOP("Aviation", "magnetic");
(void)QT_TRANSLATE_NOOP("Aviation", "true");
}
/*!
@@ -108,9 +111,16 @@ public:
*/
bool isTrueTrack() const
{
return !this->m_magnetic;
return True == this->m_north;
(void)QT_TRANSLATE_NOOP("Aviation", "true");
}
/*!
* \brief Get reference north (magnetic or true)
* \return
*/
ReferenceNorth getReferenceNorth() const { return m_north; }
/*!
* \brief Register metadata
*/