NetOceanDirect 3.1.3
OceanDirect .NET API
NetOceanDirect::Lamp Class Reference

#include <Lamp.h>

Inherits NetOceanDirect::ManagedObject< LampAPI >.

Public Member Functions

 Lamp (LampAPI *instance)
 
virtual ~Lamp ()
 
bool isEnable (long deviceID, int% errorCode)
 
void setEnable (long deviceID, int% errorCode, bool enable)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< LampAPI >
 ManagedObject (LampAPI *instance)
 
 !ManagedObject ()
 
virtual ~ManagedObject ()
 
LampAPI * GetInstance ()
 

Static Public Member Functions

static Lamp getInstance ()
 

Protected Member Functions

 Lamp ()
 

Static Protected Attributes

static Lamp strobe
 

Additional Inherited Members

- Protected Attributes inherited from NetOceanDirect::ManagedObject< LampAPI >
LampAPI * m_Instance
 

Constructor & Destructor Documentation

◆ Lamp() [1/2]

Lamp::Lamp ( )
protected

◆ Lamp() [2/2]

Lamp::Lamp ( LampAPI * instance)

◆ ~Lamp()

virtual NetOceanDirect::Lamp::~Lamp ( )
inlinevirtual

Member Function Documentation

◆ getInstance()

Lamp Lamp::getInstance ( )
static

◆ isEnable()

bool Lamp::isEnable ( long deviceID,
int% errorCode )

Read the strobe lamp state connected to the given device.

See also
setEnable()
Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails
Returns
true if lamp is enabled otherwise its false.

◆ setEnable()

void Lamp::setEnable ( long deviceID,
int% errorCode,
bool enable )

Enables/disables the specified strobe lamp connected to the given device.

See also
isEnable()
Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails
[in]enableif true, lamp is to be enabled - will be disabled otherwise

Member Data Documentation

◆ strobe

Lamp NetOceanDirect::Lamp::strobe
staticprotected

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