|
static AnalogOutAPI * | getInstance () |
|
static void | shutdown () |
|
◆ configureAltPin()
void oceandirect::api::AnalogOutAPI::configureAltPin |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
pinNumber, |
|
|
int |
pinType |
|
) |
| |
Configure the specified analog output as an alternate type.
- 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. |
pinNumber | the pin number of the specified analog output. |
pinType | the desired alternate type. |
◆ getMaximumOutputVoltageDC()
double oceandirect::api::AnalogOutAPI::getMaximumOutputVoltageDC |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the maximum DC output voltage for the analog outputs.
- 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
- the maximum analog DC output.
◆ getMinimumOutputVoltageDC()
double oceandirect::api::AnalogOutAPI::getMinimumOutputVoltageDC |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the minimum DC output voltage for the analog outputs.
- 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
- the minimum analog DC output.
◆ getNumberOfVoltageDCOutputs()
int oceandirect::api::AnalogOutAPI::getNumberOfVoltageDCOutputs |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the number of analog outputs.
- 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
- the number of analog DC outputs.
◆ setVoltageDCOutVolts()
void oceandirect::api::AnalogOutAPI::setVoltageDCOutVolts |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
output, |
|
|
double |
voltage |
|
) |
| |
Set the DC output voltage for the specified analog output.
- 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. |
output | the index of the specified analog output. |
voltage | the desired output voltage. |
The documentation for this class was generated from the following file: