Darien Figueroa / Mbed 2 deprecated repo3

Dependencies:   mbed MAX14720 MAX30205 USBDevice

Embed: (wiki syntax)

« Back to documentation index

MaximSKAlgorithmClass Class Reference

MaximSKAlgorithmClass Class Reference

Encapsulate the Maxim SKA Algorithm. More...

Inherits Maxim::MAX30101GUI::MaximAlgorithmClass.

Public Member Functions

override void Clear ()
 Clear any internal class members, in response to startMonitorToolStripMenuItem.
override 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

Encapsulate the Maxim SKA Algorithm.

Definition at line 53 of file MaximSKAlgorithmClass.cs.


Member Function Documentation

override void Clear (  ) [virtual]

Clear any internal class members, in response to startMonitorToolStripMenuItem.

Reimplemented from MaximAlgorithmClass.

Definition at line 99 of file MaximSKAlgorithmClass.cs.

override 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 from MaximAlgorithmClass.

Definition at line 139 of file MaximSKAlgorithmClass.cs.

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

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 
) [inherited]

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 ) [inherited]

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 [inherited]

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.