Inherits NetOceanDirect::ManagedObject< LampAPI >.
|
| Lamp (LampAPI *instance) |
|
bool | isEnable (long deviceID, int% errorCode) |
|
void | setEnable (long deviceID, int% errorCode, bool enable) |
|
| ManagedObject (LampAPI *instance) |
|
LampAPI * | GetInstance () |
|
|
static Lamp | getInstance () |
|
◆ isEnable()
bool Lamp::isEnable |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Read the strobe lamp state connected to the given device.
- See also
- setEnable()
- 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 |
- 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] | 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, lamp is to be enabled - will be disabled otherwise |
The documentation for this class was generated from the following files: