OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
LHErrorCode.h
Go to the documentation of this file.
1#ifndef LH_ERROR_CODE_H
2#define LH_ERROR_CODE_H
3/*******************************************************
4 * @file LHError.h
5 * @date March 2024
6 * @author Ocean Insight, Inc.
7 *
8 * The set of error codes for the Lighthouse API. They are declared in the global namespace
9 * because they have to be available to e.g. the C API.
10 */
11 /************************************************************************
12 *
13 * OCEAN INSIGHT CONFIDENTIAL
14 * __________________
15 *
16 * [2018] - [2024] 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#include "lighthouse/api/LighthouseDllDecl.h"
31#ifdef __cplusplus
32extern "C" {
33#endif
72
76 LIGHTHOUSE_DLL_DECL const char* LHCodeToErrorMessage(enum LHErrorCode code);
77#ifdef __cplusplus
78}
79#endif
80#endif // !LH_ERROR_CODE_H
81
LIGHTHOUSE_DLL_DECL const char * LHCodeToErrorMessage(enum LHErrorCode code)
LHErrorCode
Definition LHErrorCode.h:37
@ LH_WARN_FIELD_UNINITIALIZE
Definition LHErrorCode.h:68
@ LH_ERROR_BYTES_SENT_COUNT_MISMATCH
Definition LHErrorCode.h:52
@ LH_ERROR_BYTES_RECEIVED_UNEXPECTED_COUNT
Definition LHErrorCode.h:53
@ LH_WARN_INTEGRATION_TIME_HIGH
Definition LHErrorCode.h:70
@ LH_ERROR_INTEGRATION_TIME_BELOW_AVERAGING_MIN
Definition LHErrorCode.h:47
@ LH_WARN_INTEGRATION_TIME_LOW
Definition LHErrorCode.h:69
@ LH_ERROR_DEVICE_REJECTED_MESSAGE
Definition LHErrorCode.h:58
@ LH_WARN_DEVICE_INITIALIZE_INCOMPLETE
Definition LHErrorCode.h:66
@ LH_WARN_SPECTRUM_SATURATED
Definition LHErrorCode.h:67
@ LH_ERROR_BUS_READ
Definition LHErrorCode.h:55
@ LH_ERROR_BAD_USER_BUFFER
Definition LHErrorCode.h:42
@ LH_SUCCESS
Definition LHErrorCode.h:39
@ LH_ERROR_VALUE_NOT_FOUND
Definition LHErrorCode.h:43
@ LH_ERROR_MESSAGE_RESULT_TYPE_SIZE_MISMATCH
Definition LHErrorCode.h:60
@ LH_ERROR_BUS_WRITE
Definition LHErrorCode.h:56
@ LH_ERROR_UNKNOWN
Definition LHErrorCode.h:63
@ LH_ERROR_COMMAND_NOT_SUPPORTED
Definition LHErrorCode.h:46
@ LH_ERROR_BADLY_FORMED_MESSAGE
Definition LHErrorCode.h:57
@ LH_ERROR_ARRAY_LENGTH
Definition LHErrorCode.h:44
@ LH_ERROR_FAILED_TO_CLOSE
Definition LHErrorCode.h:41
@ LH_ERROR_DEVICE_EXCEPTION
Definition LHErrorCode.h:59
@ LH_ERROR_UNINITIALIZED_BUS
Definition LHErrorCode.h:54
@ LH_ERROR_NO_DEVICE
Definition LHErrorCode.h:40
@ LH_ERROR_INVALID_ARGUMENT
Definition LHErrorCode.h:45
@ LH_ERROR_DARK_NONLINEARITY_CORRECTION_CONFLICT
Definition LHErrorCode.h:48