#include <LedActivity.h>
Inherits NetOceanDirect::ManagedObject< LedActivityAPI >.
◆ LedActivity() [1/2]
LedActivity::LedActivity |
( |
| ) |
|
|
protected |
◆ LedActivity() [2/2]
LedActivity::LedActivity |
( |
LedActivityAPI * | instance | ) |
|
◆ ~LedActivity()
virtual NetOceanDirect::LedActivity::~LedActivity |
( |
| ) |
|
|
inlinevirtual |
◆ getInstance()
◆ 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] | deviceID | the device ID for the device to be queried (from OceanDirect::findDevices()) |
[out] | errorCode | set 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] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set 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] | enable | if true, light source is to be enabled - will be disabled otherwise |
◆ ledSource
The documentation for this class was generated from the following files: