OceanDirectLighthouse  3.1.1
OceanDirect Lighthouse C++/C API
LHSensorAPI.h
1 #ifndef LH_SENSOR_API_H
2 #define LH_SENSOR_API_H
3 /*****************************************************
4  * @file LHSensorAPI.h
5  * @date December 2023
6  * @author Ocean Insight, Inc.
7  *
8  * This is an interface to OceanDirect that allows
9  * the user to connect to devices over USB and other buses.
10  * This is intended as a usable and extensible API.
11  */
12  /************************************************************************
13  *
14  * OCEAN INSIGHT CONFIDENTIAL
15  * __________________
16  *
17  * [2018] - [2023] Ocean Insight Incorporated
18  * All Rights Reserved.
19  *
20  * NOTICE: All information contained herein is, and remains
21  * the property of Ocean Insight Incorporated and its suppliers,
22  * if any. The intellectual and technical concepts contained
23  * herein are proprietary to Ocean Insight Incorporated
24  * and its suppliers and may be covered by U.S. and Foreign Patents,
25  * patents in process, and are protected by trade secret or copyright law.
26  * Dissemination of this information or reproduction of this material
27  * is strictly forbidden unless prior written permission is obtained
28  * from Ocean Insight Incorporated.
29  *
30  **************************************************************************/
31 
32 #include "lighthouse/api/LighthouseDllDecl.h"
33 #include "lighthouse/api/lhdefs.h"
38 namespace oceandirect {
39  namespace api {
40  class LIGHTHOUSE_DLL_DECL LHSensorAPI {
41  public:
42  virtual ~LHSensorAPI() = default;
43 
51  virtual size_t getTotalPixelCount(lh_device_id_t deviceID, lh_error_code_t* errorCode);
52 
60  virtual size_t getActivePixelCount(lh_device_id_t deviceID, lh_error_code_t* errorCode);
61 
70  virtual size_t getActivePixelIndices(lh_device_id_t deviceID, lh_error_code_t* errorCode, lh_pixel_index_t indices[],
71  size_t indicesSize);
72 
80  virtual size_t getOpticalDarkPixelCount(lh_device_id_t deviceID, lh_error_code_t* errorCode);
81 
90  virtual size_t getOpticalDarkPixelIndices(lh_device_id_t deviceID, lh_error_code_t* errorCode, lh_pixel_index_t indices[],
91  size_t indicesSize);
92 
101  virtual size_t getTransitionPixelCount(lh_device_id_t deviceID, lh_error_code_t* errorCode);
102 
113  virtual size_t getTransitionPixelIndices(lh_device_id_t deviceID, lh_error_code_t* errorCode, lh_pixel_index_t indices[],
114  size_t indicesSize);
115 
125  virtual size_t getBadPixelIndices(lh_device_id_t deviceID, lh_error_code_t* errorCode, lh_pixel_index_t indices[], size_t indicesSize);
126  };
127  }
128 }
129 #endif /* LH_SENSOR_API_H */
Definition: LHSensorAPI.h:40
virtual size_t getActivePixelCount(lh_device_id_t deviceID, lh_error_code_t *errorCode)
virtual size_t getTransitionPixelIndices(lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_pixel_index_t indices[], size_t indicesSize)
virtual size_t getOpticalDarkPixelIndices(lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_pixel_index_t indices[], size_t indicesSize)
virtual size_t getOpticalDarkPixelCount(lh_device_id_t deviceID, lh_error_code_t *errorCode)
virtual size_t getActivePixelIndices(lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_pixel_index_t indices[], size_t indicesSize)
virtual size_t getTransitionPixelCount(lh_device_id_t deviceID, lh_error_code_t *errorCode)
virtual size_t getTotalPixelCount(lh_device_id_t deviceID, lh_error_code_t *errorCode)
virtual size_t getBadPixelIndices(lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_pixel_index_t indices[], size_t indicesSize)
This is the API for controlling the autonulling functionality of a device.
Definition: LighthouseAPI.h:54