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

#include <AP_Proximity_RangeFinder.h>

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

Public Member Functions

 AP_Proximity_RangeFinder (AP_Proximity &_frontend, AP_Proximity::Proximity_State &_state)
 
void update (void)
 
float distance_max () const
 
float distance_min () const
 
bool get_upward_distance (float &distance) const
 
- Public Member Functions inherited from AP_Proximity_Backend
 AP_Proximity_Backend (AP_Proximity &_frontend, AP_Proximity::Proximity_State &_state)
 
virtual ~AP_Proximity_Backend (void)
 
virtual void handle_msg (mavlink_message_t *msg)
 
bool get_horizontal_distance (float angle_deg, float &distance) const
 
const Vector2fget_boundary_points (uint16_t &num_points) const
 
bool get_closest_object (float &angle_deg, float &distance) const
 
uint8_t get_object_count () const
 
bool get_object_angle_and_distance (uint8_t object_number, float &angle_deg, float &distance) const
 
bool get_horizontal_distances (AP_Proximity::Proximity_Distance_Array &prx_dist_array) const
 

Private Attributes

uint32_t _last_update_ms
 
float _distance_max
 
float _distance_min
 
uint32_t _last_upward_update_ms
 
float _distance_upward
 

Additional Inherited Members

- Protected Member Functions inherited from AP_Proximity_Backend
void set_status (AP_Proximity::Proximity_Status status)
 
bool convert_angle_to_sector (float angle_degrees, uint8_t &sector) const
 
void init_boundary ()
 
void update_boundary_for_sector (uint8_t sector)
 
uint8_t get_ignore_area_count () const
 
bool get_ignore_area (uint8_t index, uint16_t &angle_deg, uint8_t &width_deg) const
 
bool get_next_ignore_start_or_end (uint8_t start_or_end, int16_t start_angle, int16_t &ignore_start) const
 
- Protected Attributes inherited from AP_Proximity_Backend
AP_Proximityfrontend
 
AP_Proximity::Proximity_Statestate
 
uint8_t _num_sectors = PROXIMITY_MAX_DIRECTION
 
uint16_t _sector_middle_deg [PROXIMITY_SECTORS_MAX] = {0, 45, 90, 135, 180, 225, 270, 315, 0, 0, 0, 0}
 
uint8_t _sector_width_deg [PROXIMITY_SECTORS_MAX] = {45, 45, 45, 45, 45, 45, 45, 45, 0, 0, 0, 0}
 
float _angle [PROXIMITY_SECTORS_MAX]
 
float _distance [PROXIMITY_SECTORS_MAX]
 
bool _distance_valid [PROXIMITY_SECTORS_MAX]
 
Vector2f _sector_edge_vector [PROXIMITY_SECTORS_MAX]
 
Vector2f _boundary_point [PROXIMITY_SECTORS_MAX]
 

Detailed Description

Definition at line 8 of file AP_Proximity_RangeFinder.h.

Constructor & Destructor Documentation

◆ AP_Proximity_RangeFinder()

AP_Proximity_RangeFinder::AP_Proximity_RangeFinder ( AP_Proximity _frontend,
AP_Proximity::Proximity_State _state 
)

Definition at line 25 of file AP_Proximity_RangeFinder.cpp.

Member Function Documentation

◆ distance_max()

float AP_Proximity_RangeFinder::distance_max ( ) const
inlinevirtual

Implements AP_Proximity_Backend.

Definition at line 19 of file AP_Proximity_RangeFinder.h.

◆ distance_min()

float AP_Proximity_RangeFinder::distance_min ( ) const
inlinevirtual

Implements AP_Proximity_Backend.

Definition at line 20 of file AP_Proximity_RangeFinder.h.

Here is the call graph for this function:

◆ get_upward_distance()

bool AP_Proximity_RangeFinder::get_upward_distance ( float &  distance) const
virtual

Reimplemented from AP_Proximity_Backend.

Definition at line 86 of file AP_Proximity_RangeFinder.cpp.

Referenced by distance_min().

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

◆ update()

void AP_Proximity_RangeFinder::update ( void  )
virtual

Implements AP_Proximity_Backend.

Definition at line 33 of file AP_Proximity_RangeFinder.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _distance_max

float AP_Proximity_RangeFinder::_distance_max
private

Definition at line 29 of file AP_Proximity_RangeFinder.h.

Referenced by distance_max(), and update().

◆ _distance_min

float AP_Proximity_RangeFinder::_distance_min
private

Definition at line 30 of file AP_Proximity_RangeFinder.h.

Referenced by distance_min(), and update().

◆ _distance_upward

float AP_Proximity_RangeFinder::_distance_upward
private

Definition at line 34 of file AP_Proximity_RangeFinder.h.

Referenced by get_upward_distance(), and update().

◆ _last_update_ms

uint32_t AP_Proximity_RangeFinder::_last_update_ms
private

Definition at line 28 of file AP_Proximity_RangeFinder.h.

Referenced by update().

◆ _last_upward_update_ms

uint32_t AP_Proximity_RangeFinder::_last_upward_update_ms
private

Definition at line 33 of file AP_Proximity_RangeFinder.h.

Referenced by get_upward_distance(), and update().


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