OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
DeviceRevisionAPI.h
Go to the documentation of this file.
1/*****************************************************
2 * @file DeviceRevisionAPI.h
3 * @date April 2021
4 * @author Ocean Optics, Inc.
5 *
6 * This is an interface to OceanDirect that allows
7 * the user to read device fw and hw revisions.
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 DEVICE_REVISION_API_H
31#define DEVICE_REVISION_API_H
32
33#include "api/DllDecl.h"
34
41namespace oceandirect {
42 namespace api {
43
44 class DLL_DECL DeviceRevisionAPI {
45 public:
49
50 static void shutdown();
51
65 virtual int getRevisionFirmware(long deviceID, int *errorCode, char *buffer, int bufferLength);
66
80 virtual int getRevisionFPGA(long deviceID, int *errorCode, char *buffer, int bufferLength);
81
95 virtual int getRevisionSystem(long deviceID, int* errorCode, char* buffer, int bufferLength);
96
97 protected:
99 };
100 }
101}
102#endif /* DEVICE_REVISION_API_H */
Definition DeviceRevisionAPI.h:44
static DeviceRevisionAPI * getInstance()
static DeviceRevisionAPI * instance
Definition DeviceRevisionAPI.h:98
virtual int getRevisionFirmware(long deviceID, int *errorCode, char *buffer, int bufferLength)
virtual int getRevisionFPGA(long deviceID, int *errorCode, char *buffer, int bufferLength)
virtual int getRevisionSystem(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 OceanDirectAPI.h:147