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

#include <LedActivityAPI.h>

Public Member Functions

 LedActivityAPI ()
 
virtual ~LedActivityAPI ()
 
virtual bool getLedActivityEnable (long deviceID, int *errorCode)
 
virtual void setLedActivityEnable (long deviceID, int *errorCode, bool enable)
 

Static Public Member Functions

static LedActivityAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static LedActivityAPIinstance
 

Constructor & Destructor Documentation

◆ LedActivityAPI()

oceandirect::api::LedActivityAPI::LedActivityAPI ( )

◆ ~LedActivityAPI()

virtual oceandirect::api::LedActivityAPI::~LedActivityAPI ( )
virtual

Member Function Documentation

◆ getInstance()

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

◆ getLedActivityEnable()

virtual bool oceandirect::api::LedActivityAPI::getLedActivityEnable ( long deviceID,
int * errorCode )
virtual

Get the LED state.

See also
setLedActivityEnable()
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 LED is enabled, false otherwise.

◆ setLedActivityEnable()

virtual void oceandirect::api::LedActivityAPI::setLedActivityEnable ( long deviceID,
int * errorCode,
bool enable )
virtual

Set the LED state.

See also
getLedActivityEnable()
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 enabble the LED, false to disable the LED.

◆ shutdown()

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

Member Data Documentation

◆ instance

LedActivityAPI* oceandirect::api::LedActivityAPI::instance
staticprotected

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