#include <DeviceRevisionAPI.h>
◆ DeviceRevisionAPI()
oceandirect::api::DeviceRevisionAPI::DeviceRevisionAPI |
( |
| ) |
|
◆ ~DeviceRevisionAPI()
virtual oceandirect::api::DeviceRevisionAPI::~DeviceRevisionAPI |
( |
| ) |
|
|
virtual |
◆ getInstance()
◆ 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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. |
buffer | the buffer to receive the firmware revision. |
bufferLength | the 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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. |
buffer | the buffer to receive the FPGA revision. |
bufferLength | the 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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. |
buffer | the buffer to receive the FPGA revision. |
bufferLength | the length of the buffer. |
- Returns
- the number of bytes read.
◆ shutdown()
static void oceandirect::api::DeviceRevisionAPI::shutdown |
( |
| ) |
|
|
static |
◆ instance
The documentation for this class was generated from the following file: