OceanDirect  1.31.1-rc1
OceanDirect C++/C API
AnalogInAPI.h
1 /*****************************************************
2  * @file AnalogInAPI.h
3  * @date Aug 2020
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 #ifndef ANALOGIN_API_H
30 #define ANALOGIN_API_H
31 
32 #include "api/DllDecl.h"
33 
40 namespace oceandirect {
41  namespace api {
42 
43  class DLL_DECL AnalogInAPI {
44  public:
45  AnalogInAPI();
46  virtual ~AnalogInAPI();
47  static AnalogInAPI *getInstance();
48 
49  static void shutdown();
50 
62  int getNumberOfVoltageDCInputs(long deviceID, int *errorCode);
63 
75  double getMaximumInputVoltageDC(long deviceID, int *errorCode);
76 
88  double getMinimumInputVoltageDC(long deviceID, int *errorCode);
89 
102  double getVoltageDCInputVolts(long deviceID, int *errorCode, int input);
103 
116  void configureAltPin(long deviceID, int *errorCode, int pinNumber,
117  int pinType);
118 
119  private:
120  static AnalogInAPI *instance;
121 
122  };
123  }
124 }
125 #endif /* ANALOGIN_API_H */
126 
Definition: AnalogInAPI.h:43
void configureAltPin(long deviceID, int *errorCode, int pinNumber, int pinType)
double getMaximumInputVoltageDC(long deviceID, int *errorCode)
double getVoltageDCInputVolts(long deviceID, int *errorCode, int input)
int getNumberOfVoltageDCInputs(long deviceID, int *errorCode)
double getMinimumInputVoltageDC(long deviceID, int *errorCode)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition: DeviceFactory.h:38