OceanDirectLighthouseC++  3.1.1
OceanDirect Lighthouse C++/C API
AutoNullingAPI.h
1 /*****************************************************
2  * @file AutoNullingAPI.h
3  * @date April 2021
4  * @author Ocean Optics, Inc.
5  *
6  * This is an interface to OceanDirect that allows the user to read and write autonulling
7  * information (basleine, saturation level, maximum ADC count) from/to the device.
8  * This is intended as a usable and extensible API.
9  */
10  /************************************************************************
11  *
12  * OCEAN INSIGHT CONFIDENTIAL
13  * __________________
14  *
15  * [2018] - [2021] 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 AUTONULLING_API_H
31 #define AUTONULLING_API_H
32 
33 #include "api/DllDecl.h"
34 
41 namespace oceandirect {
42  namespace api {
43 
44  class DLL_DECL AutoNullingAPI {
45  public:
47  virtual ~AutoNullingAPI();
48  static AutoNullingAPI *getInstance();
49 
50  static void shutdown();
51 
63  virtual int getMaximumADCCount(long deviceID, int * errorCode);
64 
76  virtual int getSaturationLevel(long deviceID, int * errorCode);
77 
89  virtual int getBaselineLevel(long deviceID, int * errorCode);
90 
102  virtual int getFPGADigitalGain(long deviceID, int* errorCode);
103 
115  virtual int getFPGADigitalOffset(long deviceID, int* errorCode);
116 
117  protected:
118  static AutoNullingAPI *instance;
119 
120  };
121  }
122 }
123 #endif /* AUTONULLING_API_H */
Definition: AutoNullingAPI.h:44
virtual int getBaselineLevel(long deviceID, int *errorCode)
virtual int getFPGADigitalOffset(long deviceID, int *errorCode)
virtual int getFPGADigitalGain(long deviceID, int *errorCode)
virtual int getMaximumADCCount(long deviceID, int *errorCode)
virtual int getSaturationLevel(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