refactor: Add comment for interpolatePositionAndAltitude()

This commit is contained in:
Lars Toenning
2023-12-30 23:16:13 +01:00
parent edb57edf82
commit 6bafb74000
2 changed files with 6 additions and 0 deletions

View File

@@ -48,6 +48,9 @@ namespace BlackMisc
//! @}
//! Perform the interpolation
//! \param situation situation used as a base for interpolation. Contains for example the already interpolated PBH.
//! \param interpolateGndFactor whether to interpolate the GND factor.
//! \return \p situation with interpolated position and altitude, updated timestamp and possibly interpolated GND factor
Aviation::CAircraftSituation interpolatePositionAndAltitude(const Aviation::CAircraftSituation &situation, bool interpolateGndFactor) const;
//! Old situation

View File

@@ -66,6 +66,9 @@ namespace BlackMisc::Simulation
CInterpolant(const PosArray &pa, const PhysicalQuantities::CLengthUnit &altitudeUnit, const CInterpolatorPbh &pbh);
//! Perform the interpolation
//! \param situation situation used as a base for interpolation. Contains for example the already interpolated PBH.
//! \param interpolateGndFactor whether to interpolate the GND factor.
//! \return \p situation with interpolated position and altitude, updated timestamp and possibly interpolated GND factor
Aviation::CAircraftSituation interpolatePositionAndAltitude(const Aviation::CAircraftSituation &currentSituation, bool interpolateGndFactor) const;
//! Set the time values