OceanDirectLighthouse  3.1.1
OceanDirect Lighthouse C++/C API
oceandirect::api::LHShutterAPI Class Reference

Public Member Functions

virtual lh_open_state_t getShutterState (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual void setShutterState (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_open_state_t state)
 

Member Function Documentation

◆ getShutterState()

virtual lh_open_state_t oceandirect::api::LHShutterAPI::getShutterState ( lh_device_id_t  deviceID,
lh_error_code_t *  errorCode 
)
virtual

.getShutterState Determine the current shutter state.

See also
setShutterState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
"open" if the shutter is open, "closed" if the shutter is closed, or on error.

◆ setShutterState()

virtual void oceandirect::api::LHShutterAPI::setShutterState ( lh_device_id_t  deviceID,
lh_error_code_t *  errorCode,
lh_open_state_t  state 
)
virtual

.setShutterState Set the shutter state to open or closed.

See also
getShutterState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
state"open" to open the shutter, "closed" to close the shutter.

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