aepko/Ardupilot2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

AP_Common: correct comments on get_alt_cm and change_alt_frame

Browse Source
This commit is contained in:
Peter Barker 2022-02-04 13:45:50 +11:00 committed by Peter Barker
parent 592201d831
commit c085b713ac
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
libraries/AP_Common/Location.h
View File

@ -37,16 +37,20 @@ public:
void set_alt_cm(int32_t alt_cm, AltFrame frame);
// get altitude (in cm) in the desired frame
// returns false on failure to get altitude in the desired frame which
// can only happen if the original frame or desired frame is above-terrain
// returns false on failure to get altitude in the desired frame which can only happen if the original frame or desired frame is:
// - above-terrain and the terrain database can't supply terrain height amsl
// - above-home and home is not set
// - above-origin and origin is not set
bool get_alt_cm(AltFrame desired_frame, int32_t &ret_alt_cm) const WARN_IF_UNUSED;
// get altitude frame
AltFrame get_alt_frame() const;
// converts altitude to new frame
// returns false on failure to convert which can only happen if
// the original frame or desired frame is above-terrain
// returns false on failure to convert which can only happen if the original frame or desired frame is:
// - above-terrain and the terrain database can't supply terrain height amsl
// - above-home and home is not set
// - above-origin and origin is not set
bool change_alt_frame(AltFrame desired_frame);
// get position as a vector (in cm) from origin (x,y only or x,y,z)