APM:Copter
Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ModeFlowHold Class Reference

#include <mode.h>

Inheritance diagram for ModeFlowHold:
[legend]
Collaboration diagram for ModeFlowHold:
[legend]

Public Member Functions

 ModeFlowHold (void)
 
bool init (bool ignore_checks) override
 
void run (void) override
 
bool requires_GPS () const override
 
bool has_manual_throttle () const override
 
bool allows_arming (bool from_gcs) const override
 
bool is_autopilot () const override
 

Static Public Attributes

static const struct AP_Param::GroupInfo var_info []
 
- Static Public Attributes inherited from Mode
static AutoYaw auto_yaw
 

Protected Member Functions

const char * name () const override
 
const char * name4 () const override
 
- Protected Member Functions inherited from Mode
virtual bool landing_gear_should_be_deployed () const
 
void update_navigation ()
 
virtual void run_autopilot ()
 
virtual uint32_t wp_distance () const
 
virtual int32_t wp_bearing () const
 
virtual bool get_wp (Location_Class &loc)
 
virtual bool in_guided_mode () const
 
void get_pilot_desired_lean_angles (float &roll_out, float &pitch_out, float angle_max, float angle_limit) const
 
bool takeoff_triggered (float target_climb_rate) const
 
void zero_throttle_and_relax_ac ()
 
int32_t get_alt_above_ground (void)
 
void land_run_horizontal_control ()
 
void land_run_vertical_control (bool pause_descent=false)
 
float get_surface_tracking_climb_rate (int16_t target_rate, float current_alt_target, float dt)
 
float get_pilot_desired_yaw_rate (int16_t stick_angle)
 
float get_pilot_desired_climb_rate (float throttle_control)
 
float get_pilot_desired_throttle (int16_t throttle_control, float thr_mid=0.0f)
 
float get_non_takeoff_throttle (void)
 
void update_simple_mode (void)
 
bool set_mode (control_mode_t mode, mode_reason_t reason)
 
void set_land_complete (bool b)
 
GCS_Copter & gcs ()
 
void Log_Write_Event (uint8_t id)
 
void set_throttle_takeoff (void)
 
void takeoff_timer_start (float alt_cm)
 
void takeoff_stop (void)
 
void takeoff_get_climb_rates (float &pilot_climb_rate, float &takeoff_climb_rate)
 
float get_avoidance_adjusted_climbrate (float target_rate)
 
uint16_t get_pilot_speed_dn (void)
 

Private Types

enum  FlowHoldModeState { FlowHold_MotorStopped, FlowHold_Takeoff, FlowHold_Flying, FlowHold_Landed }
 

Private Member Functions

void flow_to_angle (Vector2f &bf_angle)
 
bool flowhold_init (bool ignore_checks)
 
void flowhold_run ()
 
void flowhold_flow_to_angle (Vector2f &angle, bool stick_input)
 
void update_height_estimate (void)
 

Private Attributes

LowPassFilterVector2f flow_filter
 
const float height_min = 0.1
 
const float height_max = 3.0
 
AP_Float flow_max
 
AC_PI_2D flow_pi_xy {0.2, 0.3, 3000, 5, 0.0025}
 
AP_Float flow_filter_hz
 
AP_Int8 flow_min_quality
 
AP_Int8 brake_rate_dps
 
float quality_filtered
 
uint8_t log_counter
 
bool limited
 
Vector2f xy_I
 
Vector2f delta_velocity_ne
 
Vector2f last_flow_rate_rps
 
uint32_t last_flow_ms
 
float last_ins_height
 
float height_offset
 
bool braking
 
uint32_t last_stick_input_ms
 

Additional Inherited Members

- Protected Attributes inherited from Mode
Parameters & g
 
ParametersG2 & g2
 
AC_WPNav *& wp_nav
 
AC_Loiter *& loiter_nav
 
AC_PosControl *& pos_control
 
AP_InertialNav & inertial_nav
 
AP_AHRS & ahrs
 
AC_AttitudeControl_t *& attitude_control
 
MOTOR_CLASS *& motors
 
RC_Channel *& channel_roll
 
RC_Channel *& channel_pitch
 
RC_Channel *& channel_throttle
 
RC_Channel *& channel_yaw
 
float & G_Dt
 
ap_t & ap
 
takeoff_state_t & takeoff_state
 
float & ekfGndSpdLimit
 
float & ekfNavVelGainScaler
 
heli_flags_t & heli_flags
 

Detailed Description

Definition at line 664 of file mode.h.

Member Enumeration Documentation

◆ FlowHoldModeState

enum ModeFlowHold::FlowHoldModeState
private
Enumerator
FlowHold_MotorStopped 
FlowHold_Takeoff 
FlowHold_Flying 
FlowHold_Landed 

Definition at line 686 of file mode.h.

Constructor & Destructor Documentation

◆ ModeFlowHold()

ModeFlowHold::ModeFlowHold ( void  )

Member Function Documentation

◆ allows_arming()

bool ModeFlowHold::allows_arming ( bool  from_gcs) const
inlineoverridevirtual

Implements Mode.

Definition at line 674 of file mode.h.

◆ flow_to_angle()

void ModeFlowHold::flow_to_angle ( Vector2f &  bf_angle)
private

◆ flowhold_flow_to_angle()

void ModeFlowHold::flowhold_flow_to_angle ( Vector2f &  angle,
bool  stick_input 
)
private

◆ flowhold_init()

bool ModeFlowHold::flowhold_init ( bool  ignore_checks)
private

◆ flowhold_run()

void ModeFlowHold::flowhold_run ( )
private

◆ has_manual_throttle()

bool ModeFlowHold::has_manual_throttle ( ) const
inlineoverridevirtual

Implements Mode.

Definition at line 673 of file mode.h.

◆ init()

bool ModeFlowHold::init ( bool  ignore_checks)
overridevirtual

Implements Mode.

◆ is_autopilot()

bool ModeFlowHold::is_autopilot ( ) const
inlineoverridevirtual

Reimplemented from Mode.

Definition at line 675 of file mode.h.

◆ name()

const char* ModeFlowHold::name ( ) const
inlineoverrideprotectedvirtual

Implements Mode.

Definition at line 680 of file mode.h.

◆ name4()

const char* ModeFlowHold::name4 ( ) const
inlineoverrideprotectedvirtual

Implements Mode.

Definition at line 681 of file mode.h.

◆ requires_GPS()

bool ModeFlowHold::requires_GPS ( ) const
inlineoverridevirtual

Implements Mode.

Definition at line 672 of file mode.h.

◆ run()

void ModeFlowHold::run ( void  )
overridevirtual

Implements Mode.

◆ update_height_estimate()

void ModeFlowHold::update_height_estimate ( void  )
private

Member Data Documentation

◆ brake_rate_dps

AP_Int8 ModeFlowHold::brake_rate_dps
private

Definition at line 713 of file mode.h.

◆ braking

bool ModeFlowHold::braking
private

Definition at line 734 of file mode.h.

◆ delta_velocity_ne

Vector2f ModeFlowHold::delta_velocity_ne
private

Definition at line 722 of file mode.h.

◆ flow_filter

LowPassFilterVector2f ModeFlowHold::flow_filter
private

Definition at line 696 of file mode.h.

◆ flow_filter_hz

AP_Float ModeFlowHold::flow_filter_hz
private

Definition at line 711 of file mode.h.

◆ flow_max

AP_Float ModeFlowHold::flow_max
private

Definition at line 709 of file mode.h.

◆ flow_min_quality

AP_Int8 ModeFlowHold::flow_min_quality
private

Definition at line 712 of file mode.h.

◆ flow_pi_xy

AC_PI_2D ModeFlowHold::flow_pi_xy {0.2, 0.3, 3000, 5, 0.0025}
private

Definition at line 710 of file mode.h.

◆ height_max

const float ModeFlowHold::height_max = 3.0
private

Definition at line 707 of file mode.h.

◆ height_min

const float ModeFlowHold::height_min = 0.1
private

Definition at line 704 of file mode.h.

◆ height_offset

float ModeFlowHold::height_offset
private

Definition at line 731 of file mode.h.

◆ last_flow_ms

uint32_t ModeFlowHold::last_flow_ms
private

Definition at line 728 of file mode.h.

◆ last_flow_rate_rps

Vector2f ModeFlowHold::last_flow_rate_rps
private

Definition at line 725 of file mode.h.

◆ last_ins_height

float ModeFlowHold::last_ins_height
private

Definition at line 730 of file mode.h.

◆ last_stick_input_ms

uint32_t ModeFlowHold::last_stick_input_ms
private

Definition at line 737 of file mode.h.

◆ limited

bool ModeFlowHold::limited
private

Definition at line 718 of file mode.h.

◆ log_counter

uint8_t ModeFlowHold::log_counter
private

Definition at line 717 of file mode.h.

◆ quality_filtered

float ModeFlowHold::quality_filtered
private

Definition at line 715 of file mode.h.

◆ var_info

const struct AP_Param::GroupInfo ModeFlowHold::var_info[]
static

Definition at line 677 of file mode.h.

◆ xy_I

Vector2f ModeFlowHold::xy_I
private

Definition at line 719 of file mode.h.

The documentation for this class was generated from the following file:
Generated on Sun Jun 17 2018 14:37:57 for APM:Copter by   doxygen 1.8.13