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

#include <NetLighthouseShutter.h>

Inherits ManagedObject.

Public Member Functions

virtual ~NetLighthouseShutter ()
 
virtual net_lh_open_state_t getShutterState (unsigned int deviceID, int %errorCode)
 
virtual void setShutterState (unsigned int deviceID, int %errorCode, net_lh_open_state_t state)
 

Static Public Member Functions

static NetLighthouseShutter getInstance ()
 

Protected Member Functions

 NetLighthouseShutter ()
 

Static Protected Attributes

static NetLighthouseShutter shutter
 

Constructor & Destructor Documentation

◆ NetLighthouseShutter()

NetLighthouseShutter::NetLighthouseShutter ( )
protected

◆ ~NetLighthouseShutter()

virtual NetLighthouse::NetLighthouseShutter::~NetLighthouseShutter ( )
inlinevirtual

Member Function Documentation

◆ getInstance()

NetLighthouseShutter NetLighthouseShutter::getInstance ( )
static

◆ getShutterState()

net_lh_open_state_t NetLighthouseShutter::getShutterState ( unsigned int deviceID,
int % 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()

void NetLighthouseShutter::setShutterState ( unsigned int deviceID,
int % errorCode,
net_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.

Member Data Documentation

◆ shutter

NetLighthouseShutter NetLighthouse::NetLighthouseShutter::shutter
staticprotected

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