InterfaceRedIRGreenLEDdataConsumer.cs

00001 /*******************************************************************************
00002 * Copyright (C) 2016 Maxim Integrated Products, Inc., All rights Reserved.
00003 * 
00004 * This software is protected by copyright laws of the United States and
00005 * of foreign countries. This material may also be protected by patent laws
00006 * and technology transfer regulations of the United States and of foreign
00007 * countries. This software is furnished under a license agreement and/or a
00008 * nondisclosure agreement and may only be used or reproduced in accordance
00009 * with the terms of those agreements. Dissemination of this information to
00010 * any party or parties not specified in the license agreement and/or
00011 * nondisclosure agreement is expressly prohibited.
00012 *
00013 * The above copyright notice and this permission notice shall be included
00014 * in all copies or substantial portions of the Software.
00015 *
00016 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00017 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00018 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00019 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00020 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00021 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00022 * OTHER DEALINGS IN THE SOFTWARE.
00023 *
00024 * Except as contained in this notice, the name of Maxim Integrated
00025 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00026 * Products, Inc. Branding Policy.
00027 *
00028 * The mere transfer of this software does not imply any licenses
00029 * of trade secrets, proprietary technology, copyrights, patents,
00030 * trademarks, maskwork rights, or any other form of intellectual
00031 * property whatsoever. Maxim Integrated Products, Inc. retains all
00032 * ownership rights.
00033 *******************************************************************************
00034 */
00035 
00036 using System;
00037 using System.Collections.Generic;
00038 using System.Linq;
00039 using System.Text;
00040 
00041 //------------------------------------------------------------------------------------------
00042 // OS24EVK-59 split into HeartRateApp EXE and MAX30101 DLL.
00043 // Moved all MAX30101 DLL classes into namespace Maxim.MAX30101GUI
00044 // Moved all HeartRateApp GUI classes into namespace Maxim.MAX30101
00045 // OS24EVK-59 Create separate project that builds Maxim.MAX30101GUI DLL library
00046 
00047 namespace Maxim.MAX30101GUI
00048 {
00049     interface InterfaceRedIRGreenLEDdataConsumer
00050     {
00051         /// <summary>
00052         /// <para>Producer-Consumer data sink for
00053         /// raw Red/IR/Green LED data.
00054         /// Produced by MAX30101, consumed by algorithm.
00055         /// </para>
00056         /// </summary>
00057         /// <param name="sampleNumber"></param>
00058         /// <param name="rawIR"></param>
00059         /// <param name="rawRed"></param>
00060         /// <param name="rawGreen"></param>
00061         /// <param name="rawIRvalid"></param>
00062         /// <param name="rawRedvalid"></param>
00063         /// <param name="rawGreenvalid"></param>
00064         void ConsumeRedIRGreenLEDdata(
00065                 int sampleNumber,
00066                 int rawIR,
00067                 int rawRed,
00068                 int rawGreen,
00069                 bool rawIRvalid,
00070                 bool rawRedvalid,
00071                 bool rawGreenvalid
00072             );
00073 
00074         // prepare for OS24EVK-37 by adding SensorTemperatureDegreesC(double) to InterfaceRedIRGreenLEDdataConsumer
00075         /// <summary>
00076         /// <para>Temperature measured at MAX30101, optionally used by algorithm to estimate actual Red LED wavelength.</para>
00077         /// </summary>
00078         /// <param name="temperatureDegreesC"></param>
00079         void SensorTemperatureDegreesC(double temperatureDegreesC);
00080 
00081     }
00082 }