OceanDirectLighthouseC++  3.1.1
OceanDirect Lighthouse C++/C API
oceandirect::api::DeviceRevisionAPI Class Reference

Public Member Functions

virtual int getRevisionFirmware (long deviceID, int *errorCode, char *buffer, int bufferLength)
 
virtual int getRevisionFPGA (long deviceID, int *errorCode, char *buffer, int bufferLength)
 
virtual int getRevisionSystem (long deviceID, int *errorCode, char *buffer, int bufferLength)
 

Static Public Member Functions

static DeviceRevisionAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static DeviceRevisionAPIinstance
 

Member Function Documentation

◆ getRevisionFirmware()

virtual int oceandirect::api::DeviceRevisionAPI::getRevisionFirmware ( long  deviceID,
int *  errorCode,
char *  buffer,
int  bufferLength 
)
virtual

Get the firmware revision number of the device.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
bufferthe buffer to receive the firmware revision.
bufferLengththe length of the buffer.
Returns
the number of bytes read.

◆ getRevisionFPGA()

virtual int oceandirect::api::DeviceRevisionAPI::getRevisionFPGA ( long  deviceID,
int *  errorCode,
char *  buffer,
int  bufferLength 
)
virtual

Get the FPGA revision number of the device.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
bufferthe buffer to receive the FPGA revision.
bufferLengththe length of the buffer.
Returns
the number of bytes read.

◆ getRevisionSystem()

virtual int oceandirect::api::DeviceRevisionAPI::getRevisionSystem ( long  deviceID,
int *  errorCode,
char *  buffer,
int  bufferLength 
)
virtual

Get the System revision number of the device.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
bufferthe buffer to receive the FPGA revision.
bufferLengththe length of the buffer.
Returns
the number of bytes read.

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