APM:Libraries: AP_HMC5843_BusDriver Class Reference

APM:Libraries

#include <AP_Compass_HMC5843.h>

Inheritance diagram for AP_HMC5843_BusDriver:

Public Member Functions
virtual	~AP_HMC5843_BusDriver ()

virtual bool	block_read (uint8_t reg, uint8_t *buf, uint32_t size)=0

virtual bool	register_read (uint8_t reg, uint8_t *val)=0

virtual bool	register_write (uint8_t reg, uint8_t val)=0

virtual AP_HAL::Semaphore *	get_semaphore ()=0

virtual bool	configure ()

virtual bool	start_measurements ()

virtual AP_HAL::Device::PeriodicHandle	register_periodic_callback (uint32_t, AP_HAL::Device::PeriodicCb)=0

virtual void	set_device_type (uint8_t devtype)=0

virtual uint32_t	get_bus_id (void) const =0

virtual void	set_retries (uint8_t retries)

Detailed Description

Definition at line 71 of file AP_Compass_HMC5843.h.

Constructor & Destructor Documentation

◆ ~AP_HMC5843_BusDriver()

virtual AP_HMC5843_BusDriver::~AP_HMC5843_BusDriver ( )

inlinevirtual

Definition at line 74 of file AP_Compass_HMC5843.h.

Member Function Documentation

◆ block_read()

virtual bool AP_HMC5843_BusDriver::block_read	(	uint8_t	reg,
		uint8_t *	buf,
		uint32_t	size
	)

pure virtual

Implemented in AP_HMC5843_BusDriver_Auxiliary, and AP_HMC5843_BusDriver_HALDevice.

◆ configure()

virtual bool AP_HMC5843_BusDriver::configure ( )

inlinevirtual

Reimplemented in AP_HMC5843_BusDriver_Auxiliary.

Definition at line 82 of file AP_Compass_HMC5843.h.

◆ get_bus_id()

virtual uint32_t AP_HMC5843_BusDriver::get_bus_id ( void ) const

pure virtual

Implemented in AP_HMC5843_BusDriver_Auxiliary, and AP_HMC5843_BusDriver_HALDevice.

◆ get_semaphore()

virtual AP_HAL::Semaphore* AP_HMC5843_BusDriver::get_semaphore ( )

pure virtual

Implemented in AP_HMC5843_BusDriver_Auxiliary, and AP_HMC5843_BusDriver_HALDevice.

◆ register_periodic_callback()

virtual AP_HAL::Device::PeriodicHandle AP_HMC5843_BusDriver::register_periodic_callback	(	uint32_t	,
		AP_HAL::Device::PeriodicCb
	)

pure virtual

Implemented in AP_HMC5843_BusDriver_Auxiliary, and AP_HMC5843_BusDriver_HALDevice.

◆ register_read()

virtual bool AP_HMC5843_BusDriver::register_read	(	uint8_t	reg,
		uint8_t *	val
	)

pure virtual

Implemented in AP_HMC5843_BusDriver_Auxiliary, and AP_HMC5843_BusDriver_HALDevice.

◆ register_write()

virtual bool AP_HMC5843_BusDriver::register_write	(	uint8_t	reg,
		uint8_t	val
	)

pure virtual

Implemented in AP_HMC5843_BusDriver_Auxiliary, and AP_HMC5843_BusDriver_HALDevice.

◆ set_device_type()

virtual void AP_HMC5843_BusDriver::set_device_type ( uint8_t devtype )

pure virtual

Implemented in AP_HMC5843_BusDriver_Auxiliary, and AP_HMC5843_BusDriver_HALDevice.

◆ set_retries()

virtual void AP_HMC5843_BusDriver::set_retries ( uint8_t retries )

inlinevirtual

Reimplemented in AP_HMC5843_BusDriver_HALDevice.

Definition at line 93 of file AP_Compass_HMC5843.h.

◆ start_measurements()

virtual bool AP_HMC5843_BusDriver::start_measurements ( )

inlinevirtual

Reimplemented in AP_HMC5843_BusDriver_Auxiliary.

Definition at line 83 of file AP_Compass_HMC5843.h.

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

libraries/AP_Compass/AP_Compass_HMC5843.h