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

#include <LampAPI.h>

Public Member Functions

 LampAPI ()
 
virtual ~LampAPI ()
 
virtual bool isStrobeLampEnable (long deviceID, int *errorCode)
 
virtual void setStrobeLampEnable (long deviceID, int *errorCode, bool enable)
 

Static Public Member Functions

static LampAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static LampAPIinstance
 

Constructor & Destructor Documentation

◆ LampAPI()

oceandirect::api::LampAPI::LampAPI ( )

◆ ~LampAPI()

virtual oceandirect::api::LampAPI::~LampAPI ( )
virtual

Member Function Documentation

◆ getInstance()

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

◆ isStrobeLampEnable()

virtual bool oceandirect::api::LampAPI::isStrobeLampEnable ( long deviceID,
int * errorCode )
virtual

Get the strobe lamp state.

See also
setStrobeLampEnable()
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 strobe lamp is enabled, false otherwise.

◆ setStrobeLampEnable()

virtual void oceandirect::api::LampAPI::setStrobeLampEnable ( long deviceID,
int * errorCode,
bool enable )
virtual

Set the strobe lamp state.

See also
isStrobeLampEnable()
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.
enabletrue to set strobe lamp enabled, false to disable.

◆ shutdown()

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

Member Data Documentation

◆ instance

LampAPI* oceandirect::api::LampAPI::instance
staticprotected

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