modm API documentation
Public Member Functions | Friends | List of all members
modm::Hmc58x3< I2cMaster >::Data Struct Reference

Public Member Functions

float getGain ()
 returns the current gain in Gauss
 
float operator[] (uint8_t index)
 
float getMagneticFieldX ()
 
float getMagneticFieldY ()
 
float getMagneticFieldZ ()
 
bool isOverflowX ()
 
bool isOverflowY ()
 
bool isOverflowZ ()
 

Friends

template<class I2cMaster >
class Hmc58x3
 
template<class I2cMaster >
class Hmc5843
 
template<class I2cMaster >
class Hmc5883
 

Member Function Documentation

template<typename I2cMaster >
float modm::Hmc58x3< I2cMaster >::Data::getMagneticFieldX ( )
inline

returns the magnetic field in Gauss

template<typename I2cMaster >
bool modm::Hmc58x3< I2cMaster >::Data::isOverflowX ( )
inline

returns true if the readings under- or overflowed

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