Public Member Functions | Static Private Member Functions | Private Attributes | List of all members
phidgets::Magnetometer Class Referencefinal

#include <magnetometer.h>

Public Member Functions

void dataHandler (const double magnetic_field[3], double timestamp) const
 
void getMagneticField (double &x, double &y, double &z, double &timestamp) const
 
 Magnetometer (int32_t serial_number, int hub_port, bool is_hub_port_device, std::function< void(const double[3], double)> data_handler)
 
void setCompassCorrectionParameters (double cc_mag_field, double cc_offset0, double cc_offset1, double cc_offset2, double cc_gain0, double cc_gain1, double cc_gain2, double cc_T0, double cc_T1, double cc_T2, double cc_T3, double cc_T4, double cc_T5)
 
void setDataInterval (uint32_t interval_ms) const
 
 ~Magnetometer ()
 

Static Private Member Functions

static void DataHandler (PhidgetMagnetometerHandle input_handle, void *ctx, const double magnetic_field[3], double timestamp)
 

Private Attributes

std::function< void(const double[3], double)> data_handler_
 
PhidgetMagnetometerHandle mag_handle_
 

Detailed Description

Definition at line 41 of file magnetometer.h.

Constructor & Destructor Documentation

◆ Magnetometer()

phidgets::Magnetometer::Magnetometer ( int32_t  serial_number,
int  hub_port,
bool  is_hub_port_device,
std::function< void(const double[3], double)>  data_handler 
)
explicit

Definition at line 42 of file magnetometer.cpp.

◆ ~Magnetometer()

phidgets::Magnetometer::~Magnetometer ( )

Definition at line 66 of file magnetometer.cpp.

Member Function Documentation

◆ dataHandler()

void phidgets::Magnetometer::dataHandler ( const double  magnetic_field[3],
double  timestamp 
) const

Definition at line 123 of file magnetometer.cpp.

◆ DataHandler()

void phidgets::Magnetometer::DataHandler ( PhidgetMagnetometerHandle  input_handle,
void *  ctx,
const double  magnetic_field[3],
double  timestamp 
)
staticprivate

Definition at line 129 of file magnetometer.cpp.

◆ getMagneticField()

void phidgets::Magnetometer::getMagneticField ( double &  x,
double &  y,
double &  z,
double &  timestamp 
) const

Definition at line 88 of file magnetometer.cpp.

◆ setCompassCorrectionParameters()

void phidgets::Magnetometer::setCompassCorrectionParameters ( double  cc_mag_field,
double  cc_offset0,
double  cc_offset1,
double  cc_offset2,
double  cc_gain0,
double  cc_gain1,
double  cc_gain2,
double  cc_T0,
double  cc_T1,
double  cc_T2,
double  cc_T3,
double  cc_T4,
double  cc_T5 
)

Definition at line 72 of file magnetometer.cpp.

◆ setDataInterval()

void phidgets::Magnetometer::setDataInterval ( uint32_t  interval_ms) const

Definition at line 113 of file magnetometer.cpp.

Member Data Documentation

◆ data_handler_

std::function<void(const double[3], double)> phidgets::Magnetometer::data_handler_
private

Definition at line 68 of file magnetometer.h.

◆ mag_handle_

PhidgetMagnetometerHandle phidgets::Magnetometer::mag_handle_
private

Definition at line 69 of file magnetometer.h.


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


phidgets_api
Author(s): Tully Foote, Ivan Dryanovski
autogenerated on Sun May 11 2025 02:20:27