Diff: HspGuiSourceV301/HSPGui/Algorithm/MaximAlgorithmClass.cs

Revision:

20:6d2af70c92ab

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/HspGuiSourceV301/HSPGui/Algorithm/MaximAlgorithmClass.cs	Tue Apr 06 06:41:40 2021 +0000
@@ -0,0 +1,186 @@
+/*******************************************************************************
+* Copyright (C) 2016 Maxim Integrated Products, Inc., All rights Reserved.
+* 
+* This software is protected by copyright laws of the United States and
+* of foreign countries. This material may also be protected by patent laws
+* and technology transfer regulations of the United States and of foreign
+* countries. This software is furnished under a license agreement and/or a
+* nondisclosure agreement and may only be used or reproduced in accordance
+* with the terms of those agreements. Dissemination of this information to
+* any party or parties not specified in the license agreement and/or
+* nondisclosure agreement is expressly prohibited.
+*
+* The above copyright notice and this permission notice shall be included
+* in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+* OTHER DEALINGS IN THE SOFTWARE.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+*******************************************************************************
+*/
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+//------------------------------------------------------------------------------------------
+// OS24EVK-59 split into HeartRateApp EXE and MAX30101 DLL.
+// Moved all MAX30101 DLL classes into namespace Maxim.MAX30101GUI
+// Moved all HeartRateApp GUI classes into namespace Maxim.MAX30101
+// OS24EVK-59 Create separate project that builds Maxim.MAX30101GUI DLL library
+
+namespace Maxim.MAX30101GUI
+{
+    /// <summary>
+    /// Base class common to any HeartRate / SpO2 algorithm.
+    /// Input is Red / IR / Green LED data, output is Heart Rate and SpO2.
+    /// </summary>
+    public class MaximAlgorithmClass : InterfaceRedIRGreenLEDdataConsumer
+    {
+        public MaximAlgorithmClass() 
+        {
+            Name = "Maxim Generic Algorithm Base Class";
+        }
+
+        public string Name;
+        public int _sampleNumber;
+        public int _sampleNumberLastValidHR;
+        public int _sampleNumberLastValidSpO2;
+
+        public double _heartRateBPM;
+        public bool   _heartRateBPMValid;
+        public double _heartRateBPMSignalStrength;
+        public double _spO2Percent;
+        public bool   _spO2PercentValid;
+        public double _spO2PercentSignalStrength;
+
+        /// <summary>
+        /// Clear any internal class members,
+        /// in response to startMonitorToolStripMenuItem
+        /// </summary>
+        public virtual void Clear()
+        {
+        }
+
+        /// <summary>
+        /// <para>InterfaceRedIRGreenLEDdataConsumer</para>
+        /// <para>Producer-Consumer data sink for
+        /// raw Red/IR/Green LED data.
+        /// Produced by MAX30101, consumed by algorithm.
+        /// </para>
+        /// </summary>
+        /// <param name="sampleNumber"></param>
+        /// <param name="rawIR"></param>
+        /// <param name="rawRed"></param>
+        /// <param name="rawGreen"></param>
+        /// <param name="rawIRvalid"></param>
+        /// <param name="rawRedvalid"></param>
+        /// <param name="rawGreenvalid"></param>
+        public virtual void ConsumeRedIRGreenLEDdata(
+                int sampleNumber,
+                int rawIR,
+                int rawRed,
+                int rawGreen,
+                bool rawIRvalid,
+                bool rawRedvalid,
+                bool rawGreenvalid
+            )
+        {
+            _sampleNumber = sampleNumber;
+        }
+
+        // prepare for OS24EVK-37 by adding SensorTemperatureDegreesC(double) to InterfaceRedIRGreenLEDdataConsumer
+        public double _temperatureDegreesC;
+
+        /// <summary>
+        /// <para>Temperature measured at MAX30101, optionally used by algorithm to estimate actual Red LED wavelength.</para>
+        /// </summary>
+        /// <param name="temperatureDegreesC"></param>
+        public void SensorTemperatureDegreesC(double temperatureDegreesC)
+        {
+            _temperatureDegreesC = temperatureDegreesC;
+        }
+
+        /// <summary>
+        /// <para>Delegate type for event <see cref="OnHeartRateSpO2dataAvailable"/></para>
+        /// </summary>
+        /// <param name="heartRateBPM"></param>
+        /// <param name="heartRateBPMValid"></param>
+        /// <param name="heartRateBPMSignalStrength"></param>
+        /// <param name="spO2Percent"></param>
+        /// <param name="spO2PercentValid"></param>
+        /// <param name="spO2PercentSignalStrength"></param>
+        public delegate void OnHeartRateSpO2dataAvailableHandler(
+                double heartRateBPM,
+                bool   heartRateBPMValid,
+                double heartRateBPMSignalStrength,
+                double spO2Percent,
+                bool   spO2PercentValid,
+                double spO2PercentSignalStrength
+            );
+
+        /// <summary>
+        /// <para>Occurs when HeartRate Data Available Event happens.
+        /// </para>
+        /// <para>An algorithm reports its results by invoking
+        /// <code>OnHeartRateSpO2dataAvailable(heartRateBPM, heartRateBPMValid, heartRateBPMSignalStrength, spO2Percent, spO2PercentValid, spO2PercentSignalStrength);</code>
+        /// </para>
+        /// </summary>
+        public event OnHeartRateSpO2dataAvailableHandler OnHeartRateSpO2dataAvailable;
+
+        /// <summary>
+        /// Report the results of running the algorithm,
+        /// by firing the OnHeartRateSpO2dataAvailable event.
+        /// </summary>
+        /// <param name="heartRateBPM"></param>
+        /// <param name="heartRateBPMValid"></param>
+        /// <param name="heartRateBPMSignalStrength"></param>
+        /// <param name="spO2Percent"></param>
+        /// <param name="spO2PercentValid"></param>
+        /// <param name="spO2PercentSignalStrength"></param>
+        public void ReportResultsHeartRateSpO2dataAvailable(
+                double heartRateBPM,
+                bool heartRateBPMValid,
+                double heartRateBPMSignalStrength,
+                double spO2Percent,
+                bool spO2PercentValid,
+                double spO2PercentSignalStrength
+            )
+        {
+            _heartRateBPM = heartRateBPM;
+            _heartRateBPMValid = heartRateBPMValid;
+            _heartRateBPMSignalStrength = heartRateBPMSignalStrength;
+            _spO2Percent = spO2Percent;
+            _spO2PercentValid = spO2PercentValid;
+            _spO2PercentSignalStrength = spO2PercentSignalStrength;
+            if (heartRateBPMValid)
+            {
+                _sampleNumberLastValidHR = _sampleNumber;
+            }
+            if (spO2PercentValid)
+            {
+                _sampleNumberLastValidSpO2 = _sampleNumber;
+            }
+            if (OnHeartRateSpO2dataAvailable != null)
+            {
+                OnHeartRateSpO2dataAvailable(heartRateBPM, heartRateBPMValid, heartRateBPMSignalStrength, spO2Percent, spO2PercentValid, spO2PercentSignalStrength);
+            }
+        }
+
+    }
+}