OceanDirectLighthouse  3.1.1
OceanDirect Lighthouse C++/C API
LHNonlinearityAPI.h
1 #ifndef LH_NONLINEARITY_API_H
2 #define LH_NONLINEARITY_API_H
3 /*****************************************************
4  * @file LHNonlinearityAPI.h
5  * @date December 2023
6  * @author Ocean Insight, Inc.
7  *
8  * This is an interface to the API that allows the nonlinearity correction coefficients
9  * of a device to be stored or retrieved.
10  */
11  /************************************************************************
12  *
13  * OCEAN INSIGHT CONFIDENTIAL
14  * __________________
15  *
16  * [2018] - [2023] Ocean Insight Incorporated
17  * All Rights Reserved.
18  *
19  * NOTICE: All information contained herein is, and remains
20  * the property of Ocean Insight Incorporated and its suppliers,
21  * if any. The intellectual and technical concepts contained
22  * herein are proprietary to Ocean Insight Incorporated
23  * and its suppliers and may be covered by U.S. and Foreign Patents,
24  * patents in process, and are protected by trade secret or copyright law.
25  * Dissemination of this information or reproduction of this material
26  * is strictly forbidden unless prior written permission is obtained
27  * from Ocean Insight Incorporated.
28  *
29  **************************************************************************/
30 
31 #include "lighthouse/api/LighthouseDllDecl.h"
32 #include "lighthouse/api/lhdefs.h"
36 namespace oceandirect {
37  namespace api {
38  class LIGHTHOUSE_DLL_DECL LHNonlinearityAPI {
39  public:
40  virtual ~LHNonlinearityAPI() = default;
41 
55  virtual size_t getNonlinearityCoefficients(lh_device_id_t deviceID, lh_error_code_t* errorCode, float buffer[], size_t bufferLength);
56  };
57  }
58 }
59 #endif /* LH_NONLINEARITY_API_H */
Definition: LHNonlinearityAPI.h:38
virtual size_t getNonlinearityCoefficients(lh_device_id_t deviceID, lh_error_code_t *errorCode, float buffer[], size_t bufferLength)
This is the API for controlling the autonulling functionality of a device.
Definition: LighthouseAPI.h:54