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

Public Member Functions

bool getDeviceIdleState (long deviceID, int *errorCode)
 
void setAbortAcquisition (long deviceID, int *errorCode)
 
void setAcquireSpectraToBuffer (long deviceID, int *errorCode)
 

Static Public Member Functions

static SpectrumAcquisitionControlAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ getDeviceIdleState()

bool oceandirect::api::SpectrumAcquisitionControlAPI::getDeviceIdleState ( long  deviceID,
int *  errorCode 
)

Get the idle state of the spectrometer.

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 the device is idle, false otherwise.

◆ setAbortAcquisition()

void oceandirect::api::SpectrumAcquisitionControlAPI::setAbortAcquisition ( long  deviceID,
int *  errorCode 
)

Abort any current acquisition.

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.

◆ setAcquireSpectraToBuffer()

void oceandirect::api::SpectrumAcquisitionControlAPI::setAcquireSpectraToBuffer ( long  deviceID,
int *  errorCode 
)

Start acquisition into the 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.

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