#include <SpectrumAcquisitionControlAPI.h>
◆ SpectrumAcquisitionControlAPI()
oceandirect::api::SpectrumAcquisitionControlAPI::SpectrumAcquisitionControlAPI |
( |
| ) |
|
◆ ~SpectrumAcquisitionControlAPI()
virtual oceandirect::api::SpectrumAcquisitionControlAPI::~SpectrumAcquisitionControlAPI |
( |
| ) |
|
|
virtual |
◆ getDeviceIdleState()
virtual bool oceandirect::api::SpectrumAcquisitionControlAPI::getDeviceIdleState |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Get the idle state of the spectrometer.
- See also
- setAbortAcquisition()
-
setAcquireSpectraToBuffer()
- 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. |
- Returns
- true if the device is idle, false otherwise.
◆ getInstance()
◆ setAbortAcquisition()
virtual void oceandirect::api::SpectrumAcquisitionControlAPI::setAbortAcquisition |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Abort any current acquisition.
- See also
- getDeviceIdleState()
- 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. |
◆ setAcquireSpectraToBuffer()
virtual void oceandirect::api::SpectrumAcquisitionControlAPI::setAcquireSpectraToBuffer |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Start acquisition into the buffer.
- See also
- getDeviceIdleState()
- 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. |
◆ shutdown()
static void oceandirect::api::SpectrumAcquisitionControlAPI::shutdown |
( |
| ) |
|
|
static |
◆ instance
The documentation for this class was generated from the following file: