Darien Figueroa / Mbed 2 deprecated repo3

Dependencies:   mbed MAX14720 MAX30205 USBDevice

Embed: (wiki syntax)

« Back to documentation index

MaximAlgorithmClass Class Reference

MaximAlgorithmClass Class Reference

Base class common to any HeartRate / SpO2 algorithm. More...

Inherits Maxim::MAX30101GUI::InterfaceRedIRGreenLEDdataConsumer.

Inherited by MaximSKAlgorithmClass.

Public Member Functions

virtual void Clear ()
 Clear any internal class members, in response to startMonitorToolStripMenuItem.
virtual void ConsumeRedIRGreenLEDdata (int sampleNumber, int rawIR, int rawRed, int rawGreen, bool rawIRvalid, bool rawRedvalid, bool rawGreenvalid)
 InterfaceRedIRGreenLEDdataConsumerProducer-Consumer data sink for raw Red/IR/Green LED data.
void SensorTemperatureDegreesC (double temperatureDegreesC)
 Temperature measured at MAX30101, optionally used by algorithm to estimate actual Red LED wavelength.
delegate void OnHeartRateSpO2dataAvailableHandler (double heartRateBPM, bool heartRateBPMValid, double heartRateBPMSignalStrength, double spO2Percent, bool spO2PercentValid, double spO2PercentSignalStrength)
 Delegate type for event OnHeartRateSpO2dataAvailable
void ReportResultsHeartRateSpO2dataAvailable (double heartRateBPM, bool heartRateBPMValid, double heartRateBPMSignalStrength, double spO2Percent, bool spO2PercentValid, double spO2PercentSignalStrength)
 Report the results of running the algorithm, by firing the OnHeartRateSpO2dataAvailable event.

Events

OnHeartRateSpO2dataAvailableHandler OnHeartRateSpO2dataAvailable
 Occurs when HeartRate Data Available Event happens.

Detailed Description

Base class common to any HeartRate / SpO2 algorithm.

Input is Red / IR / Green LED data, output is Heart Rate and SpO2.

Definition at line 53 of file MaximAlgorithmClass.cs.


Member Function Documentation

virtual void Clear (  ) [virtual]

Clear any internal class members, in response to startMonitorToolStripMenuItem.

Reimplemented in MaximSKAlgorithmClass.

Definition at line 76 of file MaximAlgorithmClass.cs.

virtual void ConsumeRedIRGreenLEDdata ( int  sampleNumber,
int  rawIR,
int  rawRed,
int  rawGreen,
bool  rawIRvalid,
bool  rawRedvalid,
bool  rawGreenvalid 
) [virtual]

InterfaceRedIRGreenLEDdataConsumerProducer-Consumer data sink for raw Red/IR/Green LED data.

Produced by MAX30101, consumed by algorithm.

Parameters:
sampleNumber
rawIR
rawRed
rawGreen
rawIRvalid
rawRedvalid
rawGreenvalid

Reimplemented in MaximSKAlgorithmClass.

Definition at line 94 of file MaximAlgorithmClass.cs.

delegate void OnHeartRateSpO2dataAvailableHandler ( double  heartRateBPM,
bool  heartRateBPMValid,
double  heartRateBPMSignalStrength,
double  spO2Percent,
bool  spO2PercentValid,
double  spO2PercentSignalStrength 
)

Delegate type for event OnHeartRateSpO2dataAvailable

Parameters:
heartRateBPM
heartRateBPMValid
heartRateBPMSignalStrength
spO2Percent
spO2PercentValid
spO2PercentSignalStrength
void ReportResultsHeartRateSpO2dataAvailable ( double  heartRateBPM,
bool  heartRateBPMValid,
double  heartRateBPMSignalStrength,
double  spO2Percent,
bool  spO2PercentValid,
double  spO2PercentSignalStrength 
)

Report the results of running the algorithm, by firing the OnHeartRateSpO2dataAvailable event.

Parameters:
heartRateBPM
heartRateBPMValid
heartRateBPMSignalStrength
spO2Percent
spO2PercentValid
spO2PercentSignalStrength

Definition at line 156 of file MaximAlgorithmClass.cs.

void SensorTemperatureDegreesC ( double  temperatureDegreesC )

Temperature measured at MAX30101, optionally used by algorithm to estimate actual Red LED wavelength.

Parameters:
temperatureDegreesC

Definition at line 114 of file MaximAlgorithmClass.cs.


Event Documentation

OnHeartRateSpO2dataAvailableHandler OnHeartRateSpO2dataAvailable

Occurs when HeartRate Data Available Event happens.

An algorithm reports its results by invoking

OnHeartRateSpO2dataAvailable(heartRateBPM, heartRateBPMValid, heartRateBPMSignalStrength, spO2Percent, spO2PercentValid, spO2PercentSignalStrength);

Definition at line 144 of file MaximAlgorithmClass.cs.