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

#include <OpticalFlow.h>

Collaboration diagram for OpticalFlow:
[legend]

Classes

struct  AP_OpticalFlow_Flags
 
struct  OpticalFlow_state
 

Public Member Functions

 OpticalFlow (AP_AHRS_NavEKF &ahrs)
 
 OpticalFlow (const OpticalFlow &other)=delete
 
OpticalFlowoperator= (const OpticalFlow &)=delete
 
void init (void)
 
bool enabled () const
 
bool healthy () const
 
void update (void)
 
uint8_t quality () const
 
const Vector2fflowRate () const
 
const Vector2fbodyRate () const
 
uint8_t device_id () const
 
uint32_t last_update () const
 
const Vector3fget_pos_offset (void) const
 

Static Public Attributes

static const struct AP_Param::GroupInfo var_info []
 

Private Attributes

AP_AHRS_NavEKF_ahrs
 
OpticalFlow_backendbackend
 
struct OpticalFlow::AP_OpticalFlow_Flags _flags
 
AP_Int8 _enabled
 
AP_Int16 _flowScalerX
 
AP_Int16 _flowScalerY
 
AP_Int16 _yawAngle_cd
 
AP_Vector3f _pos_offset
 
AP_Int8 _address
 
struct OpticalFlow_state _state
 
uint32_t _last_update_ms
 

Friends

class OpticalFlow_backend
 

Detailed Description

Definition at line 28 of file OpticalFlow.h.

Constructor & Destructor Documentation

◆ OpticalFlow() [1/2]

OpticalFlow::OpticalFlow ( AP_AHRS_NavEKF ahrs)

Definition at line 72 of file OpticalFlow.cpp.

Here is the call graph for this function:

◆ OpticalFlow() [2/2]

OpticalFlow::OpticalFlow ( const OpticalFlow other)
delete

Member Function Documentation

◆ bodyRate()

const Vector2f& OpticalFlow::bodyRate ( ) const
inline

Definition at line 58 of file OpticalFlow.h.

Referenced by GCS_MAVLINK::_set_mode_common().

Here is the caller graph for this function:

◆ device_id()

uint8_t OpticalFlow::device_id ( ) const
inline

Definition at line 61 of file OpticalFlow.h.

◆ enabled()

bool OpticalFlow::enabled ( void  ) const
inline

Definition at line 43 of file OpticalFlow.h.

◆ flowRate()

const Vector2f& OpticalFlow::flowRate ( ) const
inline

Definition at line 55 of file OpticalFlow.h.

Referenced by GCS_MAVLINK::_set_mode_common().

Here is the caller graph for this function:

◆ get_pos_offset()

const Vector3f& OpticalFlow::get_pos_offset ( void  ) const
inline

Definition at line 74 of file OpticalFlow.h.

◆ healthy()

bool OpticalFlow::healthy ( void  ) const
inline

Definition at line 46 of file OpticalFlow.h.

Referenced by GCS_MAVLINK::_set_mode_common(), and setup().

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

◆ init()

void OpticalFlow::init ( void  )

Definition at line 84 of file OpticalFlow.cpp.

Referenced by setup().

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

◆ last_update()

uint32_t OpticalFlow::last_update ( ) const
inline

Definition at line 64 of file OpticalFlow.h.

◆ operator=()

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

◆ quality()

uint8_t OpticalFlow::quality ( ) const
inline

Definition at line 52 of file OpticalFlow.h.

Referenced by GCS_MAVLINK::_set_mode_common().

Here is the caller graph for this function:

◆ update()

void OpticalFlow::update ( void  )

Definition at line 122 of file OpticalFlow.cpp.

Referenced by healthy().

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

Friends And Related Function Documentation

◆ OpticalFlow_backend

friend class OpticalFlow_backend
friend

Definition at line 30 of file OpticalFlow.h.

Member Data Documentation

◆ _address

AP_Int8 OpticalFlow::_address
private

Definition at line 95 of file OpticalFlow.h.

Referenced by OpticalFlow_backend::get_address().

◆ _ahrs

AP_AHRS_NavEKF& OpticalFlow::_ahrs
private

Definition at line 82 of file OpticalFlow.h.

Referenced by OpticalFlow_backend::get_ahrs().

◆ _enabled

AP_Int8 OpticalFlow::_enabled
private

Definition at line 90 of file OpticalFlow.h.

Referenced by enabled(), and init().

◆ _flags

struct OpticalFlow::AP_OpticalFlow_Flags OpticalFlow::_flags
private

Referenced by healthy(), OpticalFlow(), and update().

◆ _flowScalerX

AP_Int16 OpticalFlow::_flowScalerX
private

Definition at line 91 of file OpticalFlow.h.

Referenced by OpticalFlow_backend::_flowScaler().

◆ _flowScalerY

AP_Int16 OpticalFlow::_flowScalerY
private

Definition at line 92 of file OpticalFlow.h.

Referenced by OpticalFlow_backend::_flowScaler().

◆ _last_update_ms

uint32_t OpticalFlow::_last_update_ms
private

Definition at line 100 of file OpticalFlow.h.

Referenced by OpticalFlow_backend::_update_frontend(), last_update(), and update().

◆ _pos_offset

AP_Vector3f OpticalFlow::_pos_offset
private

Definition at line 94 of file OpticalFlow.h.

Referenced by get_pos_offset().

◆ _state

struct OpticalFlow_state OpticalFlow::_state
private

◆ _yawAngle_cd

AP_Int16 OpticalFlow::_yawAngle_cd
private

Definition at line 93 of file OpticalFlow.h.

Referenced by OpticalFlow_backend::_yawAngleRad().

◆ backend

OpticalFlow_backend* OpticalFlow::backend
private

Definition at line 83 of file OpticalFlow.h.

Referenced by healthy(), init(), and update().

◆ var_info

const AP_Param::GroupInfo OpticalFlow::var_info
static

Definition at line 79 of file OpticalFlow.h.

Referenced by OpticalFlow().


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