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

#include <ShutterAPI.h>

Public Member Functions

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

Static Public Member Functions

static ShutterAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static ShutterAPIinstance
 

Constructor & Destructor Documentation

◆ ShutterAPI()

oceandirect::api::ShutterAPI::ShutterAPI ( )

◆ ~ShutterAPI()

virtual oceandirect::api::ShutterAPI::~ShutterAPI ( )
virtual

Member Function Documentation

◆ getInstance()

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

◆ getShutterState()

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

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

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

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

Set the shutter to open or closed.

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

◆ shutdown()

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

Member Data Documentation

◆ instance

ShutterAPI* oceandirect::api::ShutterAPI::instance
staticprotected

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