NetOceanDirectLighthouse 3.1.3
OceanDirect Lighthouse .NET API
NetLighthouse::NetLighthouseLed Class Reference

#include <NetLighthouseLed.h>

Inherits ManagedObject.

Public Member Functions

virtual ~NetLighthouseLed ()
 
virtual net_lh_enable_state_t getLedState (unsigned int deviceID, int %errorCode)
 
virtual void setLedState (unsigned int deviceID, int% errorCode, net_lh_enable_state_t state)
 

Static Public Member Functions

static NetLighthouseLed getInstance ()
 

Protected Member Functions

 NetLighthouseLed ()
 

Static Protected Attributes

static NetLighthouseLed led
 

Constructor & Destructor Documentation

◆ NetLighthouseLed()

NetLighthouseLed::NetLighthouseLed ( )
protected

◆ ~NetLighthouseLed()

virtual NetLighthouse::NetLighthouseLed::~NetLighthouseLed ( )
inlinevirtual

Member Function Documentation

◆ getInstance()

NetLighthouseLed NetLighthouseLed::getInstance ( )
static

◆ getLedState()

net_lh_enable_state_t NetLighthouseLed::getLedState ( unsigned int deviceID,
int % errorCode )
virtual

.getLedState Return the LED state, "on" or "off".

See also
setLedState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
"on" if the LED is turned on, "off" if the LED is turned off or on error.

◆ setLedState()

void NetLighthouseLed::setLedState ( unsigned int deviceID,
int% errorCode,
net_lh_enable_state_t state )
virtual

.setLedState Turn the LED on or off.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
state"on" to turn the LED on, "off" to turn the LED off.

Member Data Documentation

◆ led

NetLighthouseLed NetLighthouse::NetLighthouseLed::led
staticprotected

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