#include <SpectrumAcquisitionControl.h>
Inherits NetOceanDirect::ManagedObject< SpectrumAcquisitionControlAPI >.
◆ SpectrumAcquisitionControl() [1/2]
SpectrumAcquisitionControl::SpectrumAcquisitionControl |
( |
| ) |
|
|
protected |
◆ SpectrumAcquisitionControl() [2/2]
SpectrumAcquisitionControl::SpectrumAcquisitionControl |
( |
SpectrumAcquisitionControlAPI * | instance | ) |
|
◆ ~SpectrumAcquisitionControl()
virtual NetOceanDirect::SpectrumAcquisitionControl::~SpectrumAcquisitionControl |
( |
| ) |
|
|
inlinevirtual |
◆ getDeviceIdleState()
bool SpectrumAcquisitionControl::getDeviceIdleState |
( |
long | deviceID, |
|
|
int% | errorCode ) |
Retrieves the device idle state. Very few device supported this command.
- See also
- setAbortAcquisition()
-
setAcquireSpectraToBuffer()
- Parameters
-
[in] | deviceID | the device ID for the device to be queried (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails |
- Returns
- True if device is idle otherwise its false.
◆ getInstance()
◆ setAbortAcquisition()
void SpectrumAcquisitionControl::setAbortAcquisition |
( |
long | deviceID, |
|
|
int% | errorCode ) |
Tells the device to stop the spectra acquisition and transition the device into an idle state. Before reading spectra again, be sure to call the method "setAcquireSpectraToBuffer()" first followed by the read spectra command. Very few device supported this command.
- See also
- getDeviceIdleState()
- Parameters
-
[in] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails |
◆ setAcquireSpectraToBuffer()
void SpectrumAcquisitionControl::setAcquireSpectraToBuffer |
( |
long | deviceID, |
|
|
int% | errorCode ) |
Tells the device to start spectra acquisition.Very few device supported this command.
- See also
- getDeviceIdleState()
- Parameters
-
[in] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails |
[in] | scansToAverage | the number of scans to average on the device for each measurement |
◆ proc
The documentation for this class was generated from the following files: