OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
ThermoElectricAPI.h
Go to the documentation of this file.
1/*****************************************************
2 * @file ThermoElectricAPI.h
3 * @date October 2018
4 * @author Ocean Optics, Inc.
5 *
6 * This is an interface to OceanDirect that allows
7 * the user to connect to devices over USB and other buses.
8 * This is intended as a usable and extensible API.
9 */
10 /************************************************************************
11 *
12 * OCEAN INSIGHT CONFIDENTIAL
13 * __________________
14 *
15 * [2018] - [2020] Ocean Insight Incorporated
16 * All Rights Reserved.
17 *
18 * NOTICE: All information contained herein is, and remains
19 * the property of Ocean Insight Incorporated and its suppliers,
20 * if any. The intellectual and technical concepts contained
21 * herein are proprietary to Ocean Insight Incorporated
22 * and its suppliers and may be covered by U.S. and Foreign Patents,
23 * patents in process, and are protected by trade secret or copyright law.
24 * Dissemination of this information or reproduction of this material
25 * is strictly forbidden unless prior written permission is obtained
26 * from Ocean Insight Incorporated.
27 *
28 **************************************************************************/
29
30#ifndef THERMOELECTRICAPI_H
31#define THERMOELECTRICAPI_H
32
33#include "api/DllDecl.h"
34
41namespace oceandirect {
42 namespace api {
43
44 class DLL_DECL ThermoElectricAPI {
45 public:
49
50 static void shutdown();
61 virtual float getTemperatureDegreesC(long deviceID, int *errorCode); // all
62
74 virtual void setTemperatureSetpointDegreesC(long deviceID, int *errorCode, float temperatureDegreesCelsius); // all
75
87 virtual void setEnable(long deviceID, int *errorCode, unsigned char tecEnable); // all
88
100 virtual bool getEnable(long deviceID, int *errorCode); //qe pro
101
113 virtual float getTemperatureSetpointDegreesC(long deviceID, int *errorCode); // qe pro
114
126 virtual bool getStable(long deviceID, int *errorCode); // qe pro
127
139 virtual bool getFanEnable(long deviceID, int *errorCode); // neither
140
141 protected:
142
144
145 };
146 }
147}
148#endif /* THERMOELECTRICAPI_H */
Definition ThermoElectricAPI.h:44
virtual void setEnable(long deviceID, int *errorCode, unsigned char tecEnable)
static ThermoElectricAPI * getInstance()
virtual float getTemperatureDegreesC(long deviceID, int *errorCode)
static ThermoElectricAPI * instance
Definition ThermoElectricAPI.h:143
virtual bool getFanEnable(long deviceID, int *errorCode)
virtual bool getStable(long deviceID, int *errorCode)
virtual void setTemperatureSetpointDegreesC(long deviceID, int *errorCode, float temperatureDegreesCelsius)
virtual bool getEnable(long deviceID, int *errorCode)
virtual float getTemperatureSetpointDegreesC(long deviceID, int *errorCode)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition OceanDirectAPI.h:147