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

#include <LedActivity.h>

Inherits NetOceanDirect::ManagedObject< LedActivityAPI >.

Public Member Functions

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

Static Public Member Functions

static LedActivity getInstance ()
 

Protected Member Functions

 LedActivity ()
 

Static Protected Attributes

static LedActivity ledSource
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ LedActivity() [1/2]

LedActivity::LedActivity ( )
protected

◆ LedActivity() [2/2]

LedActivity::LedActivity ( LedActivityAPI * instance)

◆ ~LedActivity()

virtual NetOceanDirect::LedActivity::~LedActivity ( )
inlinevirtual

Member Function Documentation

◆ getInstance()

LedActivity LedActivity::getInstance ( )
static

◆ isEnabled()

bool LedActivity::isEnabled ( long deviceID,
int% errorCode )

Retrieves whether the LED activity light connected to the given device is currently enabled.

See also
setEnable()
Parameters
[in]deviceIDthe device ID for the device to be queried (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 the specified light source is currently enabled, false otherwise also returns false if an error occurred.

◆ setEnable()

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

Enables/disables the specified light source connected to the given device.

See also
isEnabled()
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, light source is to be enabled - will be disabled otherwise

Member Data Documentation

◆ ledSource

LedActivity NetOceanDirect::LedActivity::ledSource
staticprotected

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