NetOceanDirect  2.4.0
OceanDirect .NET API
Public Member Functions | Static Public Member Functions | List of all members
NetOceanDirect::SpectrumAcquisitionControl Class Reference

Inherits NetOceanDirect::ManagedObject< SpectrumAcquisitionControlAPI >.

Public Member Functions

bool getDeviceIdleState (long deviceID, int% errorCode)
 
void setAbortAcquisition (long deviceID, int% errorCode)
 
void setAcquireSpectraToBuffer (long deviceID, int% errorCode)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< SpectrumAcquisitionControlAPI >
 ManagedObject (SpectrumAcquisitionControlAPI *instance)
 
SpectrumAcquisitionControlAPI * GetInstance ()
 

Static Public Member Functions

static SpectrumAcquisitionControl getInstance ()
 

Additional Inherited Members

- Protected Attributes inherited from NetOceanDirect::ManagedObject< SpectrumAcquisitionControlAPI >
SpectrumAcquisitionControlAPI * m_Instance
 

Member Function Documentation

◆ getDeviceIdleState()

bool SpectrumAcquisitionControl::getDeviceIdleState ( long  deviceID,
int%  errorCode 
)

Retrieves the device idle state. Very few device supported this command.

Parameters
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset 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.

◆ 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.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset 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.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset 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]scansToAveragethe number of scans to average on the device for each measurement

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