From 1e610894b9c390526861ca07528c9f83be7c58fb Mon Sep 17 00:00:00 2001 From: Paul Riseborough Date: Wed, 25 Jul 2018 08:36:11 +1000 Subject: [PATCH] EKF: Correct documentation and function name for declination accessor The function name and documentation are misleading given the function is only a getter. This change makes the usage clearer. --- EKF/estimator_interface.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/EKF/estimator_interface.h b/EKF/estimator_interface.h index fa45e4fc28..8464e36c02 100644 --- a/EKF/estimator_interface.h +++ b/EKF/estimator_interface.h @@ -315,8 +315,9 @@ public: *time_us = _time_last_imu; } - // Copy the magnetic declination that we wish to save to the EKF2_MAG_DECL parameter for the next startup - void copy_mag_decl_deg(float *val) + // Get the value of magnetic declination in degrees to be saved for use at the next startup + // At the next startup, set param.mag_declination_deg to the value saved + void get_mag_decl_deg(float *val) { *val = _mag_declination_to_save_deg; }