APM:Libraries
Public Member Functions | Static Public Attributes | Private Attributes | List of all members
AP_Parachute Class Reference

Class managing the release of a parachute. More...

#include <AP_Parachute.h>

Collaboration diagram for AP_Parachute:
[legend]

Public Member Functions

 AP_Parachute (AP_Relay &relay)
 Constructor. More...
 
 AP_Parachute (const AP_Parachute &other)=delete
 
AP_Parachuteoperator= (const AP_Parachute &)=delete
 
void enabled (bool on_off)
 enabled - enable or disable parachute release More...
 
bool enabled () const
 enabled - returns true if parachute release is enabled More...
 
void release ()
 release - release parachute More...
 
bool released () const
 released - true if the parachute has been released (or release is in progress) More...
 
bool release_initiated () const
 release_initiated - true if the parachute release sequence has been initiated (may wait before actual release) More...
 
bool release_in_progress () const
 release_in_progress - true if the parachute release sequence is in progress More...
 
void update ()
 update - shuts off the trigger should be called at about 10hz More...
 
int16_t alt_min () const
 

Static Public Attributes

static const struct AP_Param::GroupInfo var_info []
 

Private Attributes

AP_Int8 _enabled
 
AP_Int8 _release_type
 
AP_Int16 _servo_on_pwm
 
AP_Int16 _servo_off_pwm
 
AP_Int16 _alt_min
 
AP_Int16 _delay_ms
 
AP_Relay_relay
 
uint32_t _release_time
 
bool _release_initiated:1
 
bool _release_in_progress:1
 
bool _released:1
 

Detailed Description

Class managing the release of a parachute.

Definition at line 25 of file AP_Parachute.h.

Constructor & Destructor Documentation

◆ AP_Parachute() [1/2]

AP_Parachute::AP_Parachute ( AP_Relay relay)
inline

Constructor.

Definition at line 29 of file AP_Parachute.h.

Here is the call graph for this function:

◆ AP_Parachute() [2/2]

AP_Parachute::AP_Parachute ( const AP_Parachute other)
delete

Member Function Documentation

◆ alt_min()

int16_t AP_Parachute::alt_min ( ) const
inline

alt_min - returns the min altitude above home the vehicle should have before parachute is released 0 = altitude check disabled

Definition at line 67 of file AP_Parachute.h.

◆ enabled() [1/2]

void AP_Parachute::enabled ( bool  on_off)

enabled - enable or disable parachute release

Definition at line 67 of file AP_Parachute.cpp.

◆ enabled() [2/2]

bool AP_Parachute::enabled ( void  ) const
inline

enabled - returns true if parachute release is enabled

Definition at line 48 of file AP_Parachute.h.

Referenced by AP_Parachute().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

AP_Parachute& AP_Parachute::operator= ( const AP_Parachute )
delete

Referenced by AP_Parachute().

Here is the caller graph for this function:

◆ release()

void AP_Parachute::release ( )

release - release parachute

Definition at line 76 of file AP_Parachute.cpp.

Referenced by enabled().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ release_in_progress()

bool AP_Parachute::release_in_progress ( ) const
inline

release_in_progress - true if the parachute release sequence is in progress

Definition at line 60 of file AP_Parachute.h.

Here is the call graph for this function:

◆ release_initiated()

bool AP_Parachute::release_initiated ( ) const
inline

release_initiated - true if the parachute release sequence has been initiated (may wait before actual release)

Definition at line 57 of file AP_Parachute.h.

◆ released()

bool AP_Parachute::released ( ) const
inline

released - true if the parachute has been released (or release is in progress)

Definition at line 54 of file AP_Parachute.h.

◆ update()

void AP_Parachute::update ( void  )

update - shuts off the trigger should be called at about 10hz

Definition at line 95 of file AP_Parachute.cpp.

Referenced by release_in_progress().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ _alt_min

AP_Int16 AP_Parachute::_alt_min
private

Definition at line 77 of file AP_Parachute.h.

Referenced by alt_min().

◆ _delay_ms

AP_Int16 AP_Parachute::_delay_ms
private

Definition at line 78 of file AP_Parachute.h.

Referenced by update().

◆ _enabled

AP_Int8 AP_Parachute::_enabled
private

Definition at line 73 of file AP_Parachute.h.

Referenced by enabled(), release(), and update().

◆ _relay

AP_Relay& AP_Parachute::_relay
private

Definition at line 81 of file AP_Parachute.h.

Referenced by update().

◆ _release_in_progress

bool AP_Parachute::_release_in_progress
private

Definition at line 84 of file AP_Parachute.h.

Referenced by release_in_progress(), and update().

◆ _release_initiated

bool AP_Parachute::_release_initiated
private

Definition at line 83 of file AP_Parachute.h.

Referenced by release(), and release_initiated().

◆ _release_time

uint32_t AP_Parachute::_release_time
private

Definition at line 82 of file AP_Parachute.h.

Referenced by enabled(), release(), and update().

◆ _release_type

AP_Int8 AP_Parachute::_release_type
private

Definition at line 74 of file AP_Parachute.h.

Referenced by update().

◆ _released

bool AP_Parachute::_released
private

Definition at line 85 of file AP_Parachute.h.

Referenced by released(), and update().

◆ _servo_off_pwm

AP_Int16 AP_Parachute::_servo_off_pwm
private

Definition at line 76 of file AP_Parachute.h.

Referenced by update().

◆ _servo_on_pwm

AP_Int16 AP_Parachute::_servo_on_pwm
private

Definition at line 75 of file AP_Parachute.h.

Referenced by update().

◆ var_info

const AP_Param::GroupInfo AP_Parachute::var_info
static

Definition at line 69 of file AP_Parachute.h.

Referenced by AP_Parachute().


The documentation for this class was generated from the following files: