OceanDirect  1.31.0
OceanDirect C++/C API
IrradCalibrAPI.h
1 /*****************************************************
2  * @file IrradCalibrAPI.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 IRRADCALIBRAPI_H
31 #define IRRADCALIBRAPI_H
32 
33 #include "api/DllDecl.h"
34 
41 namespace oceandirect {
42  namespace api {
43 
44  class DLL_DECL IrradCalibrAPI {
45  public:
47  virtual ~IrradCalibrAPI();
48  static IrradCalibrAPI *getInstance();
49 
50  static void shutdown();
51 
65  int read(long deviceID, int *errorCode, float *buffer, int bufferLength);
66 
78  int readCalibrationDataSize(long deviceID, int *errorCode);
79 
93  int write(long deviceID, int *errorCode, float *buffer, int bufferLength);
94 
106  bool hasCollectionArea(long deviceID, int *errorCode);
107 
119  float readCollectionArea(long deviceID, int *errorCode);
120 
132  void writeCollectionArea(long deviceID, int *errorCode, float area);
133 
134  private:
135 
136  static IrradCalibrAPI *instance;
137 
138  };
139  }
140 }
141 #endif /* IRRADCALIBRAPI_H */
Definition: IrradCalibrAPI.h:44
int write(long deviceID, int *errorCode, float *buffer, int bufferLength)
int readCalibrationDataSize(long deviceID, int *errorCode)
int read(long deviceID, int *errorCode, float *buffer, int bufferLength)
bool hasCollectionArea(long deviceID, int *errorCode)
float readCollectionArea(long deviceID, int *errorCode)
void writeCollectionArea(long deviceID, int *errorCode, float area)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition: DeviceFactory.h:38