OceanDirect  1.31.1-rc1
OceanDirect C++/C API
oceandirect::api::AnalogInAPI Class Reference

Public Member Functions

void configureAltPin (long deviceID, int *errorCode, int pinNumber, int pinType)
 
double getMaximumInputVoltageDC (long deviceID, int *errorCode)
 
double getMinimumInputVoltageDC (long deviceID, int *errorCode)
 
int getNumberOfVoltageDCInputs (long deviceID, int *errorCode)
 
double getVoltageDCInputVolts (long deviceID, int *errorCode, int input)
 

Static Public Member Functions

static AnalogInAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ configureAltPin()

void oceandirect::api::AnalogInAPI::configureAltPin ( long  deviceID,
int *  errorCode,
int  pinNumber,
int  pinType 
)

Configure the specified analog input as an alternate type.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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.
pinNumberthe pin number of the specified analog input.
pinTypethe desired alternate type.

◆ getMaximumInputVoltageDC()

double oceandirect::api::AnalogInAPI::getMaximumInputVoltageDC ( long  deviceID,
int *  errorCode 
)

Get the maximum DC input voltage for the analog inputs.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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.
inputthe 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: