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

Public Member Functions

bool getShutterState (long deviceID, int *errorCode)
 
void setShutterOpen (long deviceID, int *errorCode, bool opened)
 

Static Public Member Functions

static ShutterAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ getShutterState()

bool oceandirect::api::ShutterAPI::getShutterState ( long  deviceID,
int *  errorCode 
)

Get the shutter on whether it's open or closed.

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
Return true if the shutter is open otherwise it's false.

◆ setShutterOpen()

void oceandirect::api::ShutterAPI::setShutterOpen ( long  deviceID,
int *  errorCode,
bool  opened 
)

Set the shutter to open or closed.

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.
openedtrue to open the shutter false to close the shutter.

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