OceanDirect  2.4.0
OceanDirect C++/C API
oceandirect::api::DataBufferAPI Class Reference

Public Member Functions

void clearBuffer (long deviceID, int *errorCode)
 
unsigned long getBufferCapacity (long deviceID, int *errorCode)
 
unsigned long getBufferCapacityMaximum (long deviceID, int *errorCode)
 
unsigned long getBufferCapacityMinimum (long deviceID, int *errorCode)
 
bool getBufferEnabled (long deviceID, int *errorCode)
 
unsigned long getNumberOfElements (long deviceID, int *errorCode)
 
void setBufferCapacity (long deviceID, int *errorCode, unsigned long capacity)
 
void setBufferEnabled (long deviceID, int *errorCode, bool enabled)
 

Static Public Member Functions

static DataBufferAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ clearBuffer()

void oceandirect::api::DataBufferAPI::clearBuffer ( long  deviceID,
int *  errorCode 
)

Clear the device buffer.

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.

◆ getBufferCapacity()

unsigned long oceandirect::api::DataBufferAPI::getBufferCapacity ( long  deviceID,
int *  errorCode 
)

Get the current buffer capacity.

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.
Returns
the current buffer capacity.

◆ getBufferCapacityMaximum()

unsigned long oceandirect::api::DataBufferAPI::getBufferCapacityMaximum ( long  deviceID,
int *  errorCode 
)

Get the maximum current buffer capacity.

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.
Returns
the maximum buffer capacity.

◆ getBufferCapacityMinimum()

unsigned long oceandirect::api::DataBufferAPI::getBufferCapacityMinimum ( long  deviceID,
int *  errorCode 
)

Get the minimum current buffer capacity.

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.
Returns
the minimum buffer capacity.

◆ getBufferEnabled()

bool oceandirect::api::DataBufferAPI::getBufferEnabled ( long  deviceID,
int *  errorCode 
)

Determine if buffering is enabled or disabled.

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.
Returns
true if buffering is enabled, false otherwise.

◆ getNumberOfElements()

unsigned long oceandirect::api::DataBufferAPI::getNumberOfElements ( long  deviceID,
int *  errorCode 
)
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.

◆ setBufferCapacity()

void oceandirect::api::DataBufferAPI::setBufferCapacity ( long  deviceID,
int *  errorCode,
unsigned long  capacity 
)

Set the current buffer capacity.

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.
capacitythe desired buffer capacity.

◆ setBufferEnabled()

void oceandirect::api::DataBufferAPI::setBufferEnabled ( long  deviceID,
int *  errorCode,
bool  enabled 
)

Enable or disable buffering.

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.
enabledtrue to enable buffering, false to disable buffering.

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