OceanDirect  1.31.0
OceanDirect C++/C API
oceandirect::api::IrradCalibrAPI Class Reference

Public Member Functions

bool hasCollectionArea (long deviceID, int *errorCode)
 
int read (long deviceID, int *errorCode, float *buffer, int bufferLength)
 
int readCalibrationDataSize (long deviceID, int *errorCode)
 
float readCollectionArea (long deviceID, int *errorCode)
 
int write (long deviceID, int *errorCode, float *buffer, int bufferLength)
 
void writeCollectionArea (long deviceID, int *errorCode, float area)
 

Static Public Member Functions

static IrradCalibrAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ hasCollectionArea()

bool oceandirect::api::IrradCalibrAPI::hasCollectionArea ( long  deviceID,
int *  errorCode 
)

Determine if there is a collection area.

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 there is a colleciton area, false otherwise.

◆ read()

int oceandirect::api::IrradCalibrAPI::read ( long  deviceID,
int *  errorCode,
float *  buffer,
int  bufferLength 
)

Read the irradiance calibration values.

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 irradiance calibration values.
bufferLengththe size of the buffer.
Returns
the number of irradiance calibration values read.

◆ readCalibrationDataSize()

int oceandirect::api::IrradCalibrAPI::readCalibrationDataSize ( long  deviceID,
int *  errorCode 
)

Get the number of irradiance calibration values.

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 number of irradiance calibration values.

◆ readCollectionArea()

float oceandirect::api::IrradCalibrAPI::readCollectionArea ( long  deviceID,
int *  errorCode 
)

Get the collection area.

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 collection area.

◆ write()

int oceandirect::api::IrradCalibrAPI::write ( long  deviceID,
int *  errorCode,
float *  buffer,
int  bufferLength 
)

Write the irradiance calibration values.

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 irradiance calibration values.
bufferLengththe size of the buffer.
Returns
the number of irradiance calibration values written.

◆ writeCollectionArea()

void oceandirect::api::IrradCalibrAPI::writeCollectionArea ( long  deviceID,
int *  errorCode,
float  area 
)

Set the collection area.

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.
areathe desired collection area.

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