|
virtual int | getCount (long deviceID, int *errorCode) |
|
virtual bool | getLampStrobeEnable (long deviceID, int *errorCode) |
|
virtual bool | hasEnable (long deviceID, int *errorCode, int lightSourceIndex) |
|
virtual bool | isEnabled (long deviceID, int *errorCode, int lightSourceIndex) |
|
virtual void | setEnable (long deviceID, int *errorCode, int lightSourceIndex, bool enable) |
|
virtual void | setLampStrobeEnable (long deviceID, int *errorCode, bool strobeEnable) |
|
◆ getCount()
virtual int oceandirect::api::LightSourceAPI::getCount |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
|
virtual |
Gets the number of light sources that are connected to the given device. Such light sources could be individual LEDs, light bulbs, lasers, etc. Each of these light sources may have different capabilities, such as programmable intensities and enables, which should be queried before they are used.
- Parameters
-
deviceID | the device ID for the device to be queried (from OceanDirect::findDevices()) |
errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
- Returns
- number of light sources connected to the given device
◆ getLampStrobeEnable()
virtual bool oceandirect::api::LightSourceAPI::getLampStrobeEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
|
virtual |
Get strobe enable.
- See also
- setLampStrobeEnable()
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
- Returns
- true if strobe is enabled, false otherwise.
◆ hasEnable()
virtual bool oceandirect::api::LightSourceAPI::hasEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
lightSourceIndex |
|
) |
| |
|
virtual |
Determine if the specified light source has enable/disable functionality.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
lightSourceIndex | the index of the specified light source. |
- Returns
- true if the light source has enable/disable capability, false otherwise.
◆ isEnabled()
virtual bool oceandirect::api::LightSourceAPI::isEnabled |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
lightSourceIndex |
|
) |
| |
|
virtual |
Determine if the specified light source is enabled or disabled.
- See also
- setEnable()
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
lightSourceIndex | the index of the specified light source. |
- Returns
- true if the light source is enabled, false if the light source is disabled.
◆ setEnable()
virtual void oceandirect::api::LightSourceAPI::setEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
lightSourceIndex, |
|
|
bool |
enable |
|
) |
| |
|
virtual |
Set the specified light source to enabled or disabled.
- See also
- isEnabled()
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
lightSourceIndex | the index of the specified light source. |
enable | true to enable the light source, false to disable the light source. |
◆ setLampStrobeEnable()
virtual void oceandirect::api::LightSourceAPI::setLampStrobeEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
bool |
strobeEnable |
|
) |
| |
|
virtual |
Set strobe enable.
- See also
- getLampStrobeEnable()
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
strobeEnable | true to set strobe enable, false to disable. |
The documentation for this class was generated from the following file: