OceanDirect  2.4.0
OceanDirect C++/C API
BinningAPI.h
1 /*****************************************************
2  * @file BinningAPI.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 BINNINGAPI_H
31 #define BINNINGAPI_H
32 
33 #include "api/DllDecl.h"
34 
41 namespace oceandirect {
42  namespace api {
43 
44  class DLL_DECL BinningAPI {
45  public:
46  BinningAPI();
47  virtual ~BinningAPI();
48  static BinningAPI *getInstance();
49 
50  static void shutdown();
51 
52  /* Pixel binning capabilities */
53  void setFactor(long deviceID, int *errorCode, const unsigned char binningFactor);
54  unsigned char getFactor(long deviceID, int *errorCode);
55  void setDefaultFactor(long deviceID, int *errorCode);
56  void setDefaultFactor2(long deviceID, int *errorCode, const unsigned char binningFactor);
57  unsigned char getDefaultFactor(long deviceID, int *errorCode);
58  unsigned char getMaxFactor(long deviceID, int *errorCode);
59 
60  private:
61 
62  static BinningAPI *instance;
63 
64  };
65  }
66 }
67 #endif /* BINNINGAPI_H */
Definition: BinningAPI.h:44
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition: OceanDirectAPI.h:144