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

#include <NetLighthouseLamp.h>

Inherits ManagedObject.

Public Member Functions

virtual ~NetLighthouseLamp ()
 
virtual net_lh_enable_state_t getLampState (unsigned int deviceID, int %errorCode)
 
virtual void setLampState (unsigned int deviceID, int %errorCode, net_lh_enable_state_t state)
 

Static Public Member Functions

static NetLighthouseLamp getInstance ()
 

Protected Member Functions

 NetLighthouseLamp ()
 

Static Protected Attributes

static NetLighthouseLamp lamp
 

Constructor & Destructor Documentation

◆ NetLighthouseLamp()

NetLighthouseLamp::NetLighthouseLamp ( )
protected

◆ ~NetLighthouseLamp()

virtual NetLighthouse::NetLighthouseLamp::~NetLighthouseLamp ( )
inlinevirtual

Member Function Documentation

◆ getInstance()

NetLighthouseLamp NetLighthouseLamp::getInstance ( )
static

◆ getLampState()

net_lh_enable_state_t NetLighthouseLamp::getLampState ( unsigned int deviceID,
int % errorCode )
virtual

.getLampState Return the lamp enable pin state.

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

◆ setLampState()

void NetLighthouseLamp::setLampState ( unsigned int deviceID,
int % errorCode,
net_lh_enable_state_t state )
virtual

.setLampState Set the lamp enable pin to turn the connected light source on or off.

See also
getLampState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
state"on" to turn the light source on, "off" to turn the light source off.

Member Data Documentation

◆ lamp

NetLighthouseLamp NetLighthouse::NetLighthouseLamp::lamp
staticprotected

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