OceanDirectLighthouseC++  3.1.1
OceanDirect Lighthouse C++/C API
SpectrumAcquisitionControlAPI.h
1 /*****************************************************
2  * @file SpectrumAcquisitionControlAPI.h
3  * @date December 2021
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] - [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 SPECTRUM_ACQUISITION_CONTROL_API_H
31 #define SPECTRUM_ACQUISITION_CONTROL_API_H
32 
33 #include "api/DllDecl.h"
34 
39 namespace oceandirect {
40  namespace api {
41 
43  public:
46  static SpectrumAcquisitionControlAPI *getInstance();
47 
48  static void shutdown();
49 
62  virtual bool getDeviceIdleState(long deviceID, int *errorCode);
63 
74  virtual void setAbortAcquisition(long deviceID, int *errorCode);
75 
86  virtual void setAcquireSpectraToBuffer(long deviceID, int *errorCode);
87 
88  protected:
89  static SpectrumAcquisitionControlAPI *instance;
90  };
91  }
92 }
93 #endif /* SPECTRUM_ACQUISITION_CONTROL_API_H */
Definition: SpectrumAcquisitionControlAPI.h:42
virtual void setAbortAcquisition(long deviceID, int *errorCode)
virtual void setAcquireSpectraToBuffer(long deviceID, int *errorCode)
virtual bool getDeviceIdleState(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