OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
LHErrorCode.h File Reference
#include "lighthouse/api/LighthouseDllDecl.h"

Go to the source code of this file.

Enumerations

enum  LHErrorCode {
  LH_SUCCESS = 0 , LH_ERROR_NO_DEVICE = 2 , LH_ERROR_FAILED_TO_CLOSE = 3 , LH_ERROR_BAD_USER_BUFFER = 7 ,
  LH_ERROR_VALUE_NOT_FOUND = 10 , LH_ERROR_ARRAY_LENGTH = 13 , LH_ERROR_INVALID_ARGUMENT = 15 , LH_ERROR_COMMAND_NOT_SUPPORTED = 24 ,
  LH_ERROR_INTEGRATION_TIME_BELOW_AVERAGING_MIN = 25 , LH_ERROR_DARK_NONLINEARITY_CORRECTION_CONFLICT = 26 , LH_ERROR_BYTES_SENT_COUNT_MISMATCH , LH_ERROR_BYTES_RECEIVED_UNEXPECTED_COUNT ,
  LH_ERROR_UNINITIALIZED_BUS , LH_ERROR_BUS_READ , LH_ERROR_BUS_WRITE , LH_ERROR_BADLY_FORMED_MESSAGE ,
  LH_ERROR_DEVICE_REJECTED_MESSAGE , LH_ERROR_DEVICE_EXCEPTION , LH_ERROR_MESSAGE_RESULT_TYPE_SIZE_MISMATCH , LH_ERROR_UNKNOWN = -1 ,
  LH_WARN_DEVICE_INITIALIZE_INCOMPLETE = 10001 , LH_WARN_SPECTRUM_SATURATED , LH_WARN_FIELD_UNINITIALIZE , LH_WARN_INTEGRATION_TIME_LOW ,
  LH_WARN_INTEGRATION_TIME_HIGH
}
 

Functions

LIGHTHOUSE_DLL_DECL const char * LHCodeToErrorMessage (enum LHErrorCode code)
 

Enumeration Type Documentation

◆ LHErrorCode

Return codes indicating the status of an operation on completion.

Enumerator
LH_SUCCESS 

Returned on successful completion

LH_ERROR_NO_DEVICE 

A device with the specified identifer could not be found

LH_ERROR_FAILED_TO_CLOSE 

Failed to close the specified device

LH_ERROR_BAD_USER_BUFFER 

One or more user-supplied buffers may be null or otherwise invalid

LH_ERROR_VALUE_NOT_FOUND 

A value required for the operation could not be found

LH_ERROR_ARRAY_LENGTH 

A user supplied array is of incorrect size, possibly zero or otherwise too small.

LH_ERROR_INVALID_ARGUMENT 

One or more arguments supplied is invalid. See the function documentation for valid ranges.

LH_ERROR_COMMAND_NOT_SUPPORTED 

This command is not supported by the device.

LH_ERROR_INTEGRATION_TIME_BELOW_AVERAGING_MIN 

The integration time is below the value required when spectrum averaging is enabled.

LH_ERROR_DARK_NONLINEARITY_CORRECTION_CONFLICT 

It is not permitted to enable "automatic" dark or nonlinearity correction and use the manual corrections simultaneously.

LH_ERROR_BYTES_SENT_COUNT_MISMATCH 

An unexpected number of bytes was sent on the bus.

LH_ERROR_BYTES_RECEIVED_UNEXPECTED_COUNT 

An unexpected number of bytes was received on the bus.

LH_ERROR_UNINITIALIZED_BUS 

The connect bus was not initialized successfully.

LH_ERROR_BUS_READ 

Unexpected bus read error

LH_ERROR_BUS_WRITE 

Unexpected bus write error.

LH_ERROR_BADLY_FORMED_MESSAGE 

A badly formed message has been found

LH_ERROR_DEVICE_REJECTED_MESSAGE 

The device has rejected the message that was sent.

LH_ERROR_DEVICE_EXCEPTION 

The device has thrown an exception as a result of the command.

LH_ERROR_MESSAGE_RESULT_TYPE_SIZE_MISMATCH 

An unexpected number of bytes has been received for the expected result.

LH_ERROR_UNKNOWN 

An error has been detected that has no expected cause.

LH_WARN_DEVICE_INITIALIZE_INCOMPLETE 

The device was not fully initialized but it may be possible to continue operating.

LH_WARN_SPECTRUM_SATURATED 

One or more pixels in the spectrum has saturated.

LH_WARN_FIELD_UNINITIALIZE 

The read command failed due to the field being uninitialized.

LH_WARN_INTEGRATION_TIME_LOW 

The integration time has been set to a value below the recommended minimum (only allowed on some devices)

LH_WARN_INTEGRATION_TIME_HIGH 

The integration time has been set to a value above the recommended maximum (only allowed on some devices)

Function Documentation

◆ LHCodeToErrorMessage()

LIGHTHOUSE_DLL_DECL const char * LHCodeToErrorMessage ( enum LHErrorCode code)

Convert an error code into a human readable string.