OceanDirect  1.31.0
OceanDirect C++/C API
OpticalBenchAPI.h
1 /*****************************************************
2  * @file OpticalBenchAPI.h
3  * @date January 2022
4  * @author Ocean Insight, 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 OPTICALBENCHAPI_H
31 #define OPTICALBENCHAPI_H
32 
33 #include "api/DllDecl.h"
34 
41 namespace oceandirect {
42  namespace api {
43 
44  class DLL_DECL OpticalBenchAPI {
45  public:
47  virtual ~OpticalBenchAPI() = default;
48  static OpticalBenchAPI *getInstance();
49 
50  static void shutdown();
51 
52  /* Optical Bench capabilities */
72  int getWavelength(long deviceID, int *errorCode, char *buffer, int bufferLength);
73 
90  unsigned short int getSlitWidthMicrons(long deviceID, int *errorCode);
91 
106  void setSlitWidthMicrons(long deviceID, int *errorCode, unsigned short int widthMicrons);
107 
130  int getSerialNumber(long deviceID, int *errorCode, char *buffer, int bufferLength);
131 
147  void setSerialNumber(long deviceID, int *errorCode, char *buffer, int bufferLength);
148 
169  int getId(long deviceID, int *errorCode, char *buffer, int bufferLength);
170 
186  void setId(long deviceID, int *errorCode, char *buffer, int bufferLength);
187 
204  unsigned short int getFiberDiameter(long deviceID, int *errorCode);
205 
220  void setFiberDiameter(long deviceID, int *errorCode, unsigned short int diameterMicrons);
221 
243  int getCoating(long deviceID, int *errorCode, char *buffer, int bufferLength);
244 
260  void setCoating(long deviceID, int *errorCode, char *buffer, int bufferLength);
261 
284  int getFilter(long deviceID, int *errorCode, char *buffer, int bufferLength);
285 
301  void setFilter(long deviceID, int *errorCode, char *buffer, int bufferLength);
302 
325  int getGrating(long deviceID, int *errorCode, char *buffer, int bufferLength);
326 
343  void setGrating(long deviceID, int *errorCode, char *buffer, int bufferLength);
344 
366  int isLensInstalled(long deviceID, int *errorCode, char *buffer, int bufferLength);
367 
368  private:
369  static OpticalBenchAPI *instance;
370  };
371  }
372 }
373 #endif /* OPTICALBENCHAPI_H */
Definition: OpticalBenchAPI.h:44
void setSerialNumber(long deviceID, int *errorCode, char *buffer, int bufferLength)
int isLensInstalled(long deviceID, int *errorCode, char *buffer, int bufferLength)
int getSerialNumber(long deviceID, int *errorCode, char *buffer, int bufferLength)
void setCoating(long deviceID, int *errorCode, char *buffer, int bufferLength)
void setSlitWidthMicrons(long deviceID, int *errorCode, unsigned short int widthMicrons)
int getWavelength(long deviceID, int *errorCode, char *buffer, int bufferLength)
void setId(long deviceID, int *errorCode, char *buffer, int bufferLength)
void setFilter(long deviceID, int *errorCode, char *buffer, int bufferLength)
int getGrating(long deviceID, int *errorCode, char *buffer, int bufferLength)
void setGrating(long deviceID, int *errorCode, char *buffer, int bufferLength)
unsigned short int getFiberDiameter(long deviceID, int *errorCode)
int getId(long deviceID, int *errorCode, char *buffer, int bufferLength)
void setFiberDiameter(long deviceID, int *errorCode, unsigned short int diameterMicrons)
int getCoating(long deviceID, int *errorCode, char *buffer, int bufferLength)
unsigned short int getSlitWidthMicrons(long deviceID, int *errorCode)
int getFilter(long deviceID, int *errorCode, char *buffer, int bufferLength)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition: DeviceFactory.h:38