OceanDirectLighthouseC++  3.1.1
OceanDirect Lighthouse C++/C API
BackToBackAPI.h
1 /*****************************************************
2  * @file BackToBackAPI.h
3  * @date December 2019
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 BACKTOBACKAPI_H
31 #define BACKTOBACKAPI_H
32 
33 #include "api/DllDecl.h"
34 
41 namespace oceandirect {
42  namespace api {
43 
44  class DLL_DECL BackToBackAPI {
45  public:
46  BackToBackAPI();
47  virtual ~BackToBackAPI();
48  static BackToBackAPI *getInstance();
49 
50  static void shutdown();
51 
63  virtual unsigned long getNumberOfBackToBackScans(long deviceID, int *errorCode);
64 
76  virtual void setNumberOfBackToBackScans(long deviceID, int *errorCode, unsigned long numScans);
77 
78  protected:
79  static BackToBackAPI *instance;
80 
81  };
82  }
83 }
84 #endif /* BACKTOBACKAPI_H */
Definition: BackToBackAPI.h:44
virtual unsigned long getNumberOfBackToBackScans(long deviceID, int *errorCode)
virtual void setNumberOfBackToBackScans(long deviceID, int *errorCode, unsigned long numScans)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition: OceanDirectAPI.h:147