refs #552 Style & doxygen.

This commit is contained in:
Mathew Sutcliffe
2015-12-12 18:29:30 +00:00
parent c1d57b8971
commit e6011ec7cd
2 changed files with 23 additions and 22 deletions

View File

@@ -59,6 +59,7 @@ namespace BlackMisc
virtual const BlackMisc::PhysicalQuantities::CLength &geodeticHeight() const = 0; virtual const BlackMisc::PhysicalQuantities::CLength &geodeticHeight() const = 0;
//! Normal vector //! Normal vector
//! \note QVector3D uses floats, so don't use if double precision is needed
//! \sa https://en.wikipedia.org/wiki/N-vector //! \sa https://en.wikipedia.org/wiki/N-vector
//! \sa http://www.movable-type.co.uk/scripts/latlong-vectors.html //! \sa http://www.movable-type.co.uk/scripts/latlong-vectors.html
virtual QVector3D normalVector() const = 0; virtual QVector3D normalVector() const = 0;

View File

@@ -53,11 +53,11 @@ namespace BlackMisc
/*! /*!
* Convert from this unit to default unit. * Convert from this unit to default unit.
*/ */
virtual double toDefault(double factor) const = 0; virtual double toDefault(double value) const = 0;
/*! /*!
* Convert from default unit to this unit. * Convert from default unit to this unit.
*/ */
virtual double fromDefault(double factor) const = 0; virtual double fromDefault(double value) const = 0;
}; };
/*! /*!
@@ -74,8 +74,8 @@ namespace BlackMisc
*/ */
struct IdentityConverter : public Converter struct IdentityConverter : public Converter
{ {
virtual double toDefault(double factor) const override { return factor; } virtual double toDefault(double value) const override { return value; }
virtual double fromDefault(double factor) const override { return factor; } virtual double fromDefault(double value) const override { return value; }
}; };
/*! /*!
@@ -85,8 +85,8 @@ namespace BlackMisc
template <class Policy> template <class Policy>
struct LinearConverter : public Converter struct LinearConverter : public Converter
{ {
virtual double toDefault(double factor) const override { return factor * Policy::factor(); } virtual double toDefault(double value) const override { return value * Policy::factor(); }
virtual double fromDefault(double factor) const override { return factor / Policy::factor(); } virtual double fromDefault(double value) const override { return value / Policy::factor(); }
}; };
/*! /*!
@@ -96,8 +96,8 @@ namespace BlackMisc
template <class Policy> template <class Policy>
struct AffineConverter : public Converter struct AffineConverter : public Converter
{ {
virtual double toDefault(double factor) const override { return (factor - Policy::offset()) * Policy::factor(); } virtual double toDefault(double value) const override { return (value - Policy::offset()) * Policy::factor(); }
virtual double fromDefault(double factor) const override { return factor / Policy::factor() + Policy::offset(); } virtual double fromDefault(double value) const override { return value / Policy::factor() + Policy::offset(); }
}; };
/*! /*!
@@ -108,18 +108,18 @@ namespace BlackMisc
template <class FactorPolicy, class SubdivPolicy> template <class FactorPolicy, class SubdivPolicy>
struct SubdivisionConverter : public Converter struct SubdivisionConverter : public Converter
{ {
virtual double toDefault(double factor) const override virtual double toDefault(double value) const override
{ {
using BlackMisc::Math::CMathUtils; using BlackMisc::Math::CMathUtils;
double part2 = CMathUtils::fract(factor) * SubdivPolicy::fraction(); double part2 = CMathUtils::fract(value) * SubdivPolicy::fraction();
factor = CMathUtils::trunc(factor) + part2 / SubdivPolicy::subfactor(); value = CMathUtils::trunc(value) + part2 / SubdivPolicy::subfactor();
return factor * FactorPolicy::factor(); return value * FactorPolicy::factor();
} }
virtual double fromDefault(double factor) const override virtual double fromDefault(double value) const override
{ {
using BlackMisc::Math::CMathUtils; using BlackMisc::Math::CMathUtils;
double part1 = CMathUtils::trunc(factor / FactorPolicy::factor()); double part1 = CMathUtils::trunc(value / FactorPolicy::factor());
double remaining = std::fmod(factor / FactorPolicy::factor(), 1.0); double remaining = std::fmod(value / FactorPolicy::factor(), 1.0);
double part2 = remaining * SubdivPolicy::subfactor(); double part2 = remaining * SubdivPolicy::subfactor();
return part1 + part2 / SubdivPolicy::fraction(); return part1 + part2 / SubdivPolicy::fraction();
} }
@@ -133,19 +133,19 @@ namespace BlackMisc
template <class FactorPolicy, class SubdivPolicy> template <class FactorPolicy, class SubdivPolicy>
struct SubdivisionConverter2 : public Converter struct SubdivisionConverter2 : public Converter
{ {
virtual double toDefault(double factor) const override virtual double toDefault(double value) const override
{ {
using BlackMisc::Math::CMathUtils; using BlackMisc::Math::CMathUtils;
double part2 = CMathUtils::fract(factor) * SubdivPolicy::fraction(); double part2 = CMathUtils::fract(value) * SubdivPolicy::fraction();
double part3 = CMathUtils::fract(part2) * SubdivPolicy::fraction(); double part3 = CMathUtils::fract(part2) * SubdivPolicy::fraction();
factor = CMathUtils::trunc(factor) + (CMathUtils::trunc(part2) + part3 / SubdivPolicy::subfactor()) / SubdivPolicy::subfactor(); value = CMathUtils::trunc(value) + (CMathUtils::trunc(part2) + part3 / SubdivPolicy::subfactor()) / SubdivPolicy::subfactor();
return factor * FactorPolicy::factor(); return value * FactorPolicy::factor();
} }
virtual double fromDefault(double factor) const override virtual double fromDefault(double value) const override
{ {
using BlackMisc::Math::CMathUtils; using BlackMisc::Math::CMathUtils;
double part1 = CMathUtils::trunc(factor / FactorPolicy::factor()); double part1 = CMathUtils::trunc(value / FactorPolicy::factor());
double remaining = std::fmod(factor / FactorPolicy::factor(), 1.0); double remaining = std::fmod(value / FactorPolicy::factor(), 1.0);
double part2 = CMathUtils::trunc(remaining * SubdivPolicy::subfactor()); double part2 = CMathUtils::trunc(remaining * SubdivPolicy::subfactor());
remaining = std::fmod(remaining * SubdivPolicy::subfactor(), 1.0); remaining = std::fmod(remaining * SubdivPolicy::subfactor(), 1.0);
double part3 = remaining * SubdivPolicy::subfactor(); double part3 = remaining * SubdivPolicy::subfactor();