OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
OceanDirectAPIConstants.h File Reference
#include "api/DllDecl.h"

Go to the source code of this file.

Variables

DLL_DECL const int ERROR_BAD_USER_BUFFER
 
DLL_DECL const int ERROR_CODE_ARRAY_INDEX_OUT_OF_BOUNDS
 
DLL_DECL const int ERROR_CODE_ARRAY_LENGTH
 
DLL_DECL const int ERROR_CODE_COLOR_CONVERSION_ERROR
 
DLL_DECL const int ERROR_CODE_DIVIDE_BY_ZERO
 
DLL_DECL const int ERROR_CODE_EMPTY_VECTOR
 
DLL_DECL const int ERROR_CODE_ILLEGAL_STATE_ERROR
 
DLL_DECL const int ERROR_CODE_INVALID_ARGUMENT
 
DLL_DECL const int ERROR_CODE_MAX_INT_TIME_REACHED
 
DLL_DECL const int ERROR_CODE_MIN_INT_TIME_REACHED
 
DLL_DECL const int ERROR_CODE_NO_PEAK_FOUND_ERROR
 
DLL_DECL const int ERROR_CODE_NONINVERTIBLE_MATRIX
 
DLL_DECL const int ERROR_COMMAND_NOT_SUPPORTED
 
DLL_DECL const int ERROR_DARK_NONLINEARITY_CORRECTION_CONFLICT
 
DLL_DECL const int ERROR_ENSURE_LAMP_IS_ON
 
DLL_DECL const int ERROR_FAILED_TO_CLOSE
 
DLL_DECL const int ERROR_FEATURE_NOT_FOUND
 
DLL_DECL const int ERROR_INPUT_OUT_OF_BOUNDS
 
DLL_DECL const int ERROR_INTEGRATION_TIME_BELOW_AVERAGING_MIN
 
DLL_DECL const int ERROR_INVALID_ERROR
 
DLL_DECL const int ERROR_NO_DEVICE
 
DLL_DECL const int ERROR_NOT_ENOUGH_BUFFER_SPACE
 
DLL_DECL const int ERROR_NOT_IMPLEMENTED
 
DLL_DECL const int ERROR_SPECTROMETER_SATURATED
 
DLL_DECL const int ERROR_SUCCESS
 
DLL_DECL const int ERROR_TRANSFER_ERROR
 
DLL_DECL const int ERROR_VALUE_NOT_FOUND
 

Variable Documentation

◆ ERROR_BAD_USER_BUFFER

DLL_DECL const int ERROR_BAD_USER_BUFFER
extern

Error code(7) representing an invalid user buffer provided.

◆ ERROR_CODE_ARRAY_INDEX_OUT_OF_BOUNDS

DLL_DECL const int ERROR_CODE_ARRAY_INDEX_OUT_OF_BOUNDS
extern

Error code(14) representing an Array-Index-Out-Of-Bounds error.

◆ ERROR_CODE_ARRAY_LENGTH

DLL_DECL const int ERROR_CODE_ARRAY_LENGTH
extern

Error code(13) representing an Array Length error.

◆ ERROR_CODE_COLOR_CONVERSION_ERROR

DLL_DECL const int ERROR_CODE_COLOR_CONVERSION_ERROR
extern

Error code(17) representing a Color Conversion error.

◆ ERROR_CODE_DIVIDE_BY_ZERO

DLL_DECL const int ERROR_CODE_DIVIDE_BY_ZERO
extern

Error code(11) representing a Divide-By-Zero error.

◆ ERROR_CODE_EMPTY_VECTOR

DLL_DECL const int ERROR_CODE_EMPTY_VECTOR
extern

Error code(16) representing an empty vector error.

◆ ERROR_CODE_ILLEGAL_STATE_ERROR

DLL_DECL const int ERROR_CODE_ILLEGAL_STATE_ERROR
extern

Error code(19) resulting in an Illegal State error.

◆ ERROR_CODE_INVALID_ARGUMENT

DLL_DECL const int ERROR_CODE_INVALID_ARGUMENT
extern

Error code(15) representing an invalid argument error.

◆ ERROR_CODE_MAX_INT_TIME_REACHED

DLL_DECL const int ERROR_CODE_MAX_INT_TIME_REACHED
extern

Error code(21) resulting in inability to find best integration time because we have reached the maxnimum.

◆ ERROR_CODE_MIN_INT_TIME_REACHED

DLL_DECL const int ERROR_CODE_MIN_INT_TIME_REACHED
extern

Error code(20) resulting in inability to find best integration time because we have reached the minimum.

◆ ERROR_CODE_NO_PEAK_FOUND_ERROR

DLL_DECL const int ERROR_CODE_NO_PEAK_FOUND_ERROR
extern

Error code(18) representing a No-Peak-Found error.

◆ ERROR_CODE_NONINVERTIBLE_MATRIX

DLL_DECL const int ERROR_CODE_NONINVERTIBLE_MATRIX
extern

Error code(12) representing a Non-Invertible Matrix error.

◆ ERROR_COMMAND_NOT_SUPPORTED

DLL_DECL const int ERROR_COMMAND_NOT_SUPPORTED
extern

Error code(24) representing when the command invoked is not supprted by device.

◆ ERROR_DARK_NONLINEARITY_CORRECTION_CONFLICT

DLL_DECL const int ERROR_DARK_NONLINEARITY_CORRECTION_CONFLICT
extern

Error code(26) returned when the legacy electric dark or nonlinearity correction is enabled but the user attempts to use one of the newer correction functions that use getSpectrum. This would lead to "double-correction".

◆ ERROR_ENSURE_LAMP_IS_ON

DLL_DECL const int ERROR_ENSURE_LAMP_IS_ON
extern

Error code(22) resulting in inability to find best integration time because lamp is likely off

◆ ERROR_FAILED_TO_CLOSE

DLL_DECL const int ERROR_FAILED_TO_CLOSE
extern

Error code(3) representing could not close device.

◆ ERROR_FEATURE_NOT_FOUND

DLL_DECL const int ERROR_FEATURE_NOT_FOUND
extern

Error code(5) representing no such feature on device.

◆ ERROR_INPUT_OUT_OF_BOUNDS

DLL_DECL const int ERROR_INPUT_OUT_OF_BOUNDS
extern

Error code(8) representing an Input was out of bounds.

◆ ERROR_INTEGRATION_TIME_BELOW_AVERAGING_MIN

DLL_DECL const int ERROR_INTEGRATION_TIME_BELOW_AVERAGING_MIN
extern

Error code(25) for those devices that have a different minimum integration time for averaging returned when averaging is enabled and an attempt to set the integration time below this value or when the integration time is already below this value and an attempt to enable averaging averaging is made.

◆ ERROR_INVALID_ERROR

DLL_DECL const int ERROR_INVALID_ERROR
extern

Error code(1) representing an undefined error.

◆ ERROR_NO_DEVICE

DLL_DECL const int ERROR_NO_DEVICE
extern

Error code(2) representing No device found.

◆ ERROR_NOT_ENOUGH_BUFFER_SPACE

DLL_DECL const int ERROR_NOT_ENOUGH_BUFFER_SPACE
extern

Error code(23) representing when the given output buffer is less than the expected output.

◆ ERROR_NOT_IMPLEMENTED

DLL_DECL const int ERROR_NOT_IMPLEMENTED
extern

Error code(4) representing feature not implemented.

◆ ERROR_SPECTROMETER_SATURATED

DLL_DECL const int ERROR_SPECTROMETER_SATURATED
extern

Error code(9) representing a spectrometer was saturated.

◆ ERROR_SUCCESS

DLL_DECL const int ERROR_SUCCESS
extern

Error code(0) representing no error, or success.

◆ ERROR_TRANSFER_ERROR

DLL_DECL const int ERROR_TRANSFER_ERROR
extern

Error code(6) representing a data transfer error.

◆ ERROR_VALUE_NOT_FOUND

DLL_DECL const int ERROR_VALUE_NOT_FOUND
extern

Error code(10) representing a value not found.