AP_RangeFinder_Backend Class Reference

#include <RangeFinder_Backend.h>

Inheritance diagram for AP_RangeFinder_Backend:

Collaboration diagram for AP_RangeFinder_Backend:

Public Member Functions
	AP_RangeFinder_Backend (RangeFinder::RangeFinder_State &_state)
virtual	~AP_RangeFinder_Backend (void)
virtual void	update ()=0
virtual void	handle_msg (mavlink_message_t *msg)
void	update_pre_arm_check ()
enum Rotation	orientation () const
uint16_t	distance_cm () const
uint16_t	voltage_mv () const
int16_t	max_distance_cm () const
int16_t	min_distance_cm () const
int16_t	ground_clearance_cm () const
MAV_DISTANCE_SENSOR	get_mav_distance_sensor_type () const
RangeFinder::RangeFinder_Status	status () const
RangeFinder::RangeFinder_Type	type () const
bool	has_data () const
uint8_t	range_valid_count () const
const Vector3f &	get_pos_offset () const

Protected Member Functions
void	update_status ()
void	set_status (RangeFinder::RangeFinder_Status status)
virtual MAV_DISTANCE_SENSOR	_get_mav_distance_sensor_type () const =0

Protected Attributes
RangeFinder::RangeFinder_State &	state
AP_HAL::Semaphore *	_sem

Detailed Description

Definition at line 21 of file RangeFinder_Backend.h.

Constructor & Destructor Documentation

AP_RangeFinder_Backend()

AP_RangeFinder_Backend::AP_RangeFinder_Backend

(

RangeFinder::RangeFinder_State &

_state

)

Definition at line 27 of file RangeFinder_Backend.cpp.

Here is the call graph for this function:

~AP_RangeFinder_Backend()

virtual AP_RangeFinder_Backend::~AP_RangeFinder_Backend ( void  )

inlinevirtual

Definition at line 29 of file RangeFinder_Backend.h.

Here is the call graph for this function:

Member Function Documentation

_get_mav_distance_sensor_type()

virtual MAV_DISTANCE_SENSOR AP_RangeFinder_Backend::_get_mav_distance_sensor_type ( ) const

protectedpure virtual

Implemented in AP_RangeFinder_Bebop, AP_RangeFinder_LeddarOne, AP_RangeFinder_NMEA, AP_RangeFinder_PX4_PWM, AP_RangeFinder_BBB_PRU, AP_RangeFinder_PulsedLightLRF, AP_RangeFinder_Benewake, AP_RangeFinder_MaxsonarI2CXL, AP_RangeFinder_MAVLink, AP_RangeFinder_Wasp, AP_RangeFinder_LightWareSerial, AP_RangeFinder_MaxsonarSerialLV, AP_RangeFinder_uLanding, AP_RangeFinder_analog, AP_RangeFinder_LightWareI2C, AP_RangeFinder_TeraRangerI2C, and AP_RangeFinder_VL53L0X.

Referenced by get_mav_distance_sensor_type().

Here is the caller graph for this function:

distance_cm()

uint16_t AP_RangeFinder_Backend::distance_cm ( ) const

inline

Definition at line 39 of file RangeFinder_Backend.h.

Referenced by AP_RangeFinder_TeraRangerI2C::_get_mav_distance_sensor_type(), AP_RangeFinder_MAVLink::AP_RangeFinder_MAVLink(), RangeFinder::distance_cm_orient(), AP_RangeFinder_MAVLink::handle_msg(), DataFlash_Class::Log_Write_RFND(), loop(), NavEKF2_core::readRangeFinder(), NavEKF3_core::readRangeFinder(), GCS_MAVLINK::send_distance_sensor(), GCS_MAVLINK::send_rangefinder_downward(), AP_Proximity_RangeFinder::update(), and AP_RangeFinder_MAVLink::update().

Here is the caller graph for this function:

get_mav_distance_sensor_type()

MAV_DISTANCE_SENSOR AP_RangeFinder_Backend::get_mav_distance_sensor_type ( ) const

inline

Definition at line 44 of file RangeFinder_Backend.h.

Referenced by RangeFinder::get_mav_distance_sensor_type_orient(), and GCS_MAVLINK::send_distance_sensor().

Here is the call graph for this function:

Here is the caller graph for this function:

get_pos_offset()

const Vector3f& AP_RangeFinder_Backend::get_pos_offset ( ) const

inline

Definition at line 70 of file RangeFinder_Backend.h.

Referenced by RangeFinder::get_pos_offset_orient(), NavEKF2_core::selectHeightForFusion(), and NavEKF3_core::selectHeightForFusion().

Here is the call graph for this function:

Here is the caller graph for this function:

ground_clearance_cm()

int16_t AP_RangeFinder_Backend::ground_clearance_cm ( ) const

inline

Definition at line 43 of file RangeFinder_Backend.h.

Referenced by RangeFinder::ground_clearance_cm_orient().

Here is the caller graph for this function:

handle_msg()

virtual void AP_RangeFinder_Backend::handle_msg ( mavlink_message_t *  msg )

inlinevirtual

Reimplemented in AP_RangeFinder_MAVLink.

Definition at line 34 of file RangeFinder_Backend.h.

Referenced by RangeFinder::handle_msg().

Here is the call graph for this function:

Here is the caller graph for this function:

has_data()

bool AP_RangeFinder_Backend::has_data ( ) const

inline

Definition at line 60 of file RangeFinder_Backend.h.

Referenced by RangeFinder::has_data_orient(), loop(), GCS_MAVLINK::send_distance_sensor(), and AP_Proximity_RangeFinder::update().

Here is the caller graph for this function:

max_distance_cm()

int16_t AP_RangeFinder_Backend::max_distance_cm ( ) const

inline

Definition at line 41 of file RangeFinder_Backend.h.

Referenced by RangeFinder::max_distance_cm_orient(), GCS_MAVLINK::send_distance_sensor(), and AP_Proximity_RangeFinder::update().

Here is the caller graph for this function:

min_distance_cm()

int16_t AP_RangeFinder_Backend::min_distance_cm ( ) const

inline

Definition at line 42 of file RangeFinder_Backend.h.

Referenced by RangeFinder::min_distance_cm_orient(), GCS_MAVLINK::send_distance_sensor(), and AP_Proximity_RangeFinder::update().

Here is the caller graph for this function:

orientation()

enum Rotation AP_RangeFinder_Backend::orientation ( ) const

inline

Definition at line 38 of file RangeFinder_Backend.h.

Referenced by RangeFinder::find_instance(), DataFlash_Class::Log_Write_RFND(), NavEKF2_core::readRangeFinder(), NavEKF3_core::readRangeFinder(), GCS_MAVLINK::send_distance_sensor(), and AP_Proximity_RangeFinder::update().

Here is the caller graph for this function:

range_valid_count()

uint8_t AP_RangeFinder_Backend::range_valid_count ( ) const

inline

Definition at line 66 of file RangeFinder_Backend.h.

Referenced by RangeFinder::range_valid_count_orient().

Here is the caller graph for this function:

set_status()

void AP_RangeFinder_Backend::set_status ( RangeFinder::RangeFinder_Status  status )

protected

Definition at line 47 of file RangeFinder_Backend.cpp.

Referenced by AP_RangeFinder_analog::AP_RangeFinder_analog(), AP_RangeFinder_PX4_PWM::AP_RangeFinder_PX4_PWM(), get_pos_offset(), AP_RangeFinder_Wasp::get_reading(), AP_RangeFinder_LightWareI2C::timer(), AP_RangeFinder_PulsedLightLRF::timer(), AP_RangeFinder_VL53L0X::update(), AP_RangeFinder_TeraRangerI2C::update(), AP_RangeFinder_Wasp::update(), AP_RangeFinder_MaxsonarSerialLV::update(), AP_RangeFinder_LightWareSerial::update(), AP_RangeFinder_uLanding::update(), AP_RangeFinder_MAVLink::update(), AP_RangeFinder_MaxsonarI2CXL::update(), AP_RangeFinder_Benewake::update(), AP_RangeFinder_PX4_PWM::update(), AP_RangeFinder_NMEA::update(), AP_RangeFinder_LeddarOne::update(), update_status(), and AP_RangeFinder_PX4_PWM::~AP_RangeFinder_PX4_PWM().

Here is the caller graph for this function:

status()

RangeFinder::RangeFinder_Status AP_RangeFinder_Backend::status ( void  ) const

inline

Definition at line 50 of file RangeFinder_Backend.h.

Referenced by get_pos_offset(), loop(), NavEKF2_core::readRangeFinder(), NavEKF3_core::readRangeFinder(), and RangeFinder::status_orient().

Here is the caller graph for this function:

type()

RangeFinder::RangeFinder_Type AP_RangeFinder_Backend::type ( void  ) const

inline

Definition at line 57 of file RangeFinder_Backend.h.

Referenced by loop().

Here is the caller graph for this function:

update()

virtual void AP_RangeFinder_Backend::update ( )

pure virtual

Implemented in AP_RangeFinder_Bebop, AP_RangeFinder_LeddarOne, AP_RangeFinder_NMEA, AP_RangeFinder_PX4_PWM, AP_RangeFinder_BBB_PRU, AP_RangeFinder_PulsedLightLRF, AP_RangeFinder_Benewake, AP_RangeFinder_MaxsonarI2CXL, AP_RangeFinder_MAVLink, AP_RangeFinder_LightWareSerial, AP_RangeFinder_MaxsonarSerialLV, AP_RangeFinder_uLanding, AP_RangeFinder_Wasp, AP_RangeFinder_analog, AP_RangeFinder_LightWareI2C, AP_RangeFinder_TeraRangerI2C, and AP_RangeFinder_VL53L0X.

Referenced by RangeFinder::update(), and ~AP_RangeFinder_Backend().

Here is the caller graph for this function:

update_pre_arm_check()

void AP_RangeFinder_Backend::update_pre_arm_check

(

)

Definition at line 67 of file RangeFinder_Backend.cpp.

Referenced by handle_msg(), and RangeFinder::update().

Here is the call graph for this function:

Here is the caller graph for this function:

update_status()

void AP_RangeFinder_Backend::update_status ( )

protected

Definition at line 34 of file RangeFinder_Backend.cpp.

Referenced by get_pos_offset(), AP_RangeFinder_LightWareI2C::timer(), AP_RangeFinder_PulsedLightLRF::timer(), AP_RangeFinder_VL53L0X::update(), AP_RangeFinder_TeraRangerI2C::update(), AP_RangeFinder_analog::update(), AP_RangeFinder_MaxsonarSerialLV::update(), AP_RangeFinder_LightWareSerial::update(), AP_RangeFinder_uLanding::update(), AP_RangeFinder_MAVLink::update(), AP_RangeFinder_MaxsonarI2CXL::update(), AP_RangeFinder_Benewake::update(), AP_RangeFinder_PX4_PWM::update(), AP_RangeFinder_NMEA::update(), and AP_RangeFinder_LeddarOne::update().

Here is the call graph for this function:

Here is the caller graph for this function:

voltage_mv()

uint16_t AP_RangeFinder_Backend::voltage_mv ( ) const

inline

Definition at line 40 of file RangeFinder_Backend.h.

Referenced by GCS_MAVLINK::send_rangefinder_downward(), and RangeFinder::voltage_mv_orient().

Here is the caller graph for this function:

Member Data Documentation

_sem

AP_HAL::Semaphore* AP_RangeFinder_Backend::_sem

protected

Definition at line 83 of file RangeFinder_Backend.h.

Referenced by AP_RangeFinder_MaxsonarI2CXL::_timer(), AP_RangeFinder_Backend(), AP_RangeFinder_TeraRangerI2C::timer(), AP_RangeFinder_TeraRangerI2C::update(), and AP_RangeFinder_MaxsonarI2CXL::update().

state

RangeFinder::RangeFinder_State& AP_RangeFinder_Backend::state

protected

Definition at line 80 of file RangeFinder_Backend.h.

Referenced by AP_RangeFinder_Wasp::AP_RangeFinder_Wasp(), distance_cm(), get_mav_distance_sensor_type(), get_pos_offset(), AP_RangeFinder_LightWareI2C::get_reading(), ground_clearance_cm(), has_data(), max_distance_cm(), min_distance_cm(), orientation(), range_valid_count(), set_status(), status(), AP_RangeFinder_LightWareI2C::timer(), AP_RangeFinder_PulsedLightLRF::timer(), type(), AP_RangeFinder_VL53L0X::update(), AP_RangeFinder_TeraRangerI2C::update(), AP_RangeFinder_analog::update(), AP_RangeFinder_Wasp::update(), AP_RangeFinder_uLanding::update(), AP_RangeFinder_LightWareSerial::update(), AP_RangeFinder_MaxsonarSerialLV::update(), AP_RangeFinder_MAVLink::update(), AP_RangeFinder_MaxsonarI2CXL::update(), AP_RangeFinder_Benewake::update(), AP_RangeFinder_BBB_PRU::update(), AP_RangeFinder_PX4_PWM::update(), AP_RangeFinder_NMEA::update(), AP_RangeFinder_LeddarOne::update(), update_pre_arm_check(), update_status(), AP_RangeFinder_analog::update_voltage(), and voltage_mv().

---

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

• libraries/AP_RangeFinder/RangeFinder_Backend.h
• libraries/AP_RangeFinder/RangeFinder_Backend.cpp