AP_GPS: Update comment on get_rate_ms()

AP_GPS::get_rate_ms() is only meant to help the GPS backends
This commit is contained in:
Michael du Breuil 2017-06-11 00:38:11 -07:00 committed by Francisco Ferreira
parent b5029aad4f
commit 6c3db3939e
2 changed files with 8 additions and 2 deletions

View File

@ -1068,7 +1068,10 @@ const Vector3f &AP_GPS::get_antenna_offset(uint8_t instance) const
}
/*
return gps update rate in milliseconds
returns the desired gps update rate in milliseconds
this does not provide any gurantee that the GPS is updating at the requested
rate it is simply a helper for use in the backends for determining what rate
they should be configuring the GPS to run at
*/
uint16_t AP_GPS::get_rate_ms(uint8_t instance) const
{

View File

@ -392,7 +392,10 @@ protected:
AP_Float _blend_tc;
private:
// return gps update rate in milliseconds
// returns the desired gps update rate in milliseconds
// this does not provide any gurantee that the GPS is updating at the requested
// rate it is simply a helper for use in the backends for determining what rate
// they should be configuring the GPS to run at
uint16_t get_rate_ms(uint8_t instance) const;
struct GPS_timing {