|
static AnalogInAPI * | getInstance () |
|
static void | shutdown () |
|
◆ configureAltPin()
void oceandirect::api::AnalogInAPI::configureAltPin |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
pinNumber, |
|
|
int |
pinType |
|
) |
| |
Configure the specified analog input 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 input. |
pinType | the desired alternate type. |
◆ getMaximumInputVoltageDC()
double oceandirect::api::AnalogInAPI::getMaximumInputVoltageDC |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the maximum DC input voltage for the analog inputs.
- 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 input.
◆ getMinimumInputVoltageDC()
double oceandirect::api::AnalogInAPI::getMinimumInputVoltageDC |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the minimum DC input voltage for the analog inputs.
- 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 input.
◆ getNumberOfVoltageDCInputs()
int oceandirect::api::AnalogInAPI::getNumberOfVoltageDCInputs |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the number of analog inputs.
- 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 inputs.
◆ getVoltageDCInputVolts()
double oceandirect::api::AnalogInAPI::getVoltageDCInputVolts |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
input |
|
) |
| |
Get the DC input voltage for the specified analog input.
- 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. |
input | the index of the specified analog output. |
- Returns
- the DC input voltage for the specified input.
The documentation for this class was generated from the following file: