OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::SpectrumAcquisitionControlAPI Class Reference

#include <SpectrumAcquisitionControlAPI.h>

Public Member Functions

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

Static Public Member Functions

static SpectrumAcquisitionControlAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static SpectrumAcquisitionControlAPIinstance
 

Constructor & Destructor Documentation

◆ SpectrumAcquisitionControlAPI()

oceandirect::api::SpectrumAcquisitionControlAPI::SpectrumAcquisitionControlAPI ( )

◆ ~SpectrumAcquisitionControlAPI()

virtual oceandirect::api::SpectrumAcquisitionControlAPI::~SpectrumAcquisitionControlAPI ( )
virtual

Member Function Documentation

◆ getDeviceIdleState()

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

Get the idle state of the spectrometer.

See also
setAbortAcquisition()
setAcquireSpectraToBuffer()
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.

◆ getInstance()

static SpectrumAcquisitionControlAPI * oceandirect::api::SpectrumAcquisitionControlAPI::getInstance ( )
static

◆ setAbortAcquisition()

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

Abort any current acquisition.

See also
getDeviceIdleState()
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()

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

Start acquisition into the buffer.

See also
getDeviceIdleState()
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.

◆ shutdown()

static void oceandirect::api::SpectrumAcquisitionControlAPI::shutdown ( )
static

Member Data Documentation

◆ instance

SpectrumAcquisitionControlAPI* oceandirect::api::SpectrumAcquisitionControlAPI::instance
staticprotected

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