OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::LHDeviceInformationAPI Class Reference

#include <LHDeviceInformationAPI.h>

Public Member Functions

virtual ~LHDeviceInformationAPI ()=default
 
virtual size_t getDeviceAlias (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength)
 
virtual size_t getManufacturer (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength)
 
virtual size_t getModel (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength)
 
virtual size_t getOriginalManufacturer (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength)
 
virtual size_t getOriginalModel (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength)
 
virtual lh_usb_identifier_t getOriginalUsbPID (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_usb_identifier_t getOriginalUsbVID (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual size_t getRevisionFirmware (lh_device_id_t deviceID, lh_error_code_t *errorCode, uint8_t buffer[], size_t bufferLength)
 
virtual size_t getRevisionFPGA (lh_device_id_t deviceID, lh_error_code_t *errorCode, uint8_t buffer[], size_t bufferLength)
 
virtual size_t getRevisionSystem (lh_device_id_t deviceID, lh_error_code_t *errorCode, uint8_t buffer[], size_t bufferLength)
 
virtual size_t getSerialNumber (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength)
 
virtual size_t getSerialNumberMaximumLength (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_usb_identifier_t getUsbPID (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_usb_identifier_t getUsbVID (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual void resetDevice (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 

Constructor & Destructor Documentation

◆ ~LHDeviceInformationAPI()

virtual oceandirect::api::LHDeviceInformationAPI::~LHDeviceInformationAPI ( )
virtualdefault

Member Function Documentation

◆ getDeviceAlias()

virtual size_t oceandirect::api::LHDeviceInformationAPI::getDeviceAlias ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
char buffer[],
size_t bufferLength )
virtual

.getDeviceAlias Determine the device alias of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferan array to receive the characters of the device alias.
bufferLengththe size of the buffer array.
Returns
the actual number of characters copied into the buffer or 0 on error.

◆ getManufacturer()

virtual size_t oceandirect::api::LHDeviceInformationAPI::getManufacturer ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
char buffer[],
size_t bufferLength )
virtual

.getManufacturer Determine the current manufacturer stored string.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferan array to receive the characters of the current manufacturer string.
bufferLengththe size of the buffer array.
Returns
the actual number of characters copied into the buffer or 0 on error.

◆ getModel()

virtual size_t oceandirect::api::LHDeviceInformationAPI::getModel ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
char buffer[],
size_t bufferLength )
virtual

.getModel Determine the current model stored string.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferan array to receive the characters of the current model string.
bufferLengththe size of the buffer array.
Returns
the actual number of characters copied into the buffer or 0 on error.

◆ getOriginalManufacturer()

virtual size_t oceandirect::api::LHDeviceInformationAPI::getOriginalManufacturer ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
char buffer[],
size_t bufferLength )
virtual

.getOriginalManufacturer Determine the original manufacturer stored string.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferan array to receive the characters of the original manufacturer string.
bufferLengththe size of the buffer array.
Returns
the actual number of characters copied into the buffer or 0 on error.

◆ getOriginalModel()

virtual size_t oceandirect::api::LHDeviceInformationAPI::getOriginalModel ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
char buffer[],
size_t bufferLength )
virtual

.getOriginalModel Determine the original model stored string.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferan array to receive the characters of the original model string.
bufferLengththe size of the buffer array.
Returns
the actual number of characters copied into the buffer or 0 on error.

◆ getOriginalUsbPID()

virtual lh_usb_identifier_t oceandirect::api::LHDeviceInformationAPI::getOriginalUsbPID ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getOriginalUsbPID Determine the original device USB Product ID.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the original USB Product ID or 0 on error.

◆ getOriginalUsbVID()

virtual lh_usb_identifier_t oceandirect::api::LHDeviceInformationAPI::getOriginalUsbVID ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getOriginalUsbVID Determine the original device USB Vendor ID.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the original USB Vendor ID or 0 on error.

◆ getRevisionFirmware()

virtual size_t oceandirect::api::LHDeviceInformationAPI::getRevisionFirmware ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
uint8_t buffer[],
size_t bufferLength )
virtual

.getRevisionFirmware Determine the firmware version of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferan array to receive the firmware version numbers (major, minor, point).
bufferLengththe size of the buffer array.
Returns
the actual number of values copied into the buffer or 0 on error.

◆ getRevisionFPGA()

virtual size_t oceandirect::api::LHDeviceInformationAPI::getRevisionFPGA ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
uint8_t buffer[],
size_t bufferLength )
virtual

.getRevisionFPGA Determine the FPGA version of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferan array to receive the FPGA version numbers (major, minor, point).
bufferLengththe size of the buffer array.
Returns
the actual number of values copied into the buffer or 0 on error.

◆ getRevisionSystem()

virtual size_t oceandirect::api::LHDeviceInformationAPI::getRevisionSystem ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
uint8_t buffer[],
size_t bufferLength )
virtual

.getRevisionSystem Determine the System version of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferan array to receive the System version numbers (major, minor, point).
bufferLengththe size of the buffer array.
Returns
the actual number of values copied into the buffer or 0 on error.

◆ getSerialNumber()

virtual size_t oceandirect::api::LHDeviceInformationAPI::getSerialNumber ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
char buffer[],
size_t bufferLength )
virtual

.getSerialNumber Determine the serial number of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferan array to receive the characters of the serial number.
bufferLengththe size of the buffer array.
Returns
the actual number of characters copied into the buffer or 0 on error.

◆ getSerialNumberMaximumLength()

virtual size_t oceandirect::api::LHDeviceInformationAPI::getSerialNumberMaximumLength ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSerialNumberMaximumLength Determine the maximum length of the serial number of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the maximum size of the serial number or 0 on error.

◆ getUsbPID()

virtual lh_usb_identifier_t oceandirect::api::LHDeviceInformationAPI::getUsbPID ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getUsbPID Determine the current device USB Product ID.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the current USB Product ID or 0 on error.

◆ getUsbVID()

virtual lh_usb_identifier_t oceandirect::api::LHDeviceInformationAPI::getUsbVID ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getUsbVID Determine the current device USB Vendor ID.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the current USB Vendor ID or 0 on error.

◆ resetDevice()

virtual void oceandirect::api::LHDeviceInformationAPI::resetDevice ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.resetDevice Trigger a software reset of the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.

The documentation for this class was generated from the following file: