Public Member Functions

HMC5843 Class Reference

HMC5843 based compass. More...

#include <hmc5843.h>

Inheritance diagram for HMC5843:
Compass3Axis Compass Module

List of all members.

Public Member Functions

 HMC5843 ()
virtual void Init ()
 perform your initialization here
virtual void ParamChanged (Socket *param)
 A parameter has changed.
virtual void Loop (const unsigned long &interval)
 The module's main loop.

Detailed Description

HMC5843 based compass.

See the base class definition for socket documentation
Sockets exposed:

external sockets expected:


Constructor & Destructor Documentation

HMC5843::HMC5843 (  )  [inline]

Member Function Documentation

virtual void HMC5843::Init (  )  [inline, virtual]

perform your initialization here

This includes connecting plugs and general initialization

Reimplemented from Compass3Axis.

virtual void HMC5843::Loop ( const unsigned long &  interval  )  [inline, virtual]

The module's main loop.

This function is called at the rate specified by SetInterval()

Do most of your work here. Try to keep this code fast

Reimplemented from Module.

virtual void HMC5843::ParamChanged ( Socket param  )  [inline, virtual]

A parameter has changed.

Called when a parameter has been changed (read from EEPROM or via the comms link)

param points to the parameter that has changed.

Reimplemented from Compass3Axis.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Defines