aboutsummaryrefslogtreecommitdiff
path: root/src/modules/fw_pos_control_l1/landingslope.h
diff options
context:
space:
mode:
authorThomas Gubler <thomasgubler@gmail.com>2013-12-29 17:15:38 +0100
committerThomas Gubler <thomasgubler@gmail.com>2013-12-29 17:15:38 +0100
commit52960e06c601cacab90a196803e479dce539cd2b (patch)
treecfa0c5afa1689b273791dadd9ac73d0f5069f0e4 /src/modules/fw_pos_control_l1/landingslope.h
parent95bdc1a9bd364ce95abe06b097579cc8a9162e33 (diff)
downloadpx4-firmware-52960e06c601cacab90a196803e479dce539cd2b.tar.gz
px4-firmware-52960e06c601cacab90a196803e479dce539cd2b.tar.bz2
px4-firmware-52960e06c601cacab90a196803e479dce539cd2b.zip
add fw autoland documentation
Diffstat (limited to 'src/modules/fw_pos_control_l1/landingslope.h')
-rw-r--r--src/modules/fw_pos_control_l1/landingslope.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/modules/fw_pos_control_l1/landingslope.h b/src/modules/fw_pos_control_l1/landingslope.h
index 8ff431509..1a149fc7c 100644
--- a/src/modules/fw_pos_control_l1/landingslope.h
+++ b/src/modules/fw_pos_control_l1/landingslope.h
@@ -46,16 +46,16 @@
class Landingslope
{
private:
- //xxx: documentation of landing pending
- float _landing_slope_angle_rad;
- float _flare_relative_alt;
+ /* see Documentation/fw_landing.png for a plot of the landing slope */
+ float _landing_slope_angle_rad; /**< phi in the plot */
+ float _flare_relative_alt; /**< h_flare,rel in the plot */
float _motor_lim_horizontal_distance;
- float _H1_virt;
- float _H0;
- float _d1;
+ float _H1_virt; /**< H1 in the plot */
+ float _H0; /**< h_flare,rel + H1 in the plot */
+ float _d1; /**< d1 in the plot */
float _flare_constant;
- float _flare_length;
- float _horizontal_slope_displacement;
+ float _flare_length; /**< d1 + delta d in the plot */
+ float _horizontal_slope_displacement; /**< delta d in the plot */
void calculateSlopeValues();