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

Public Member Functions

void configureAltPin (long deviceID, int *errorCode, int pinNumber, int pinType)
 
double getMaximumOutputVoltageDC (long deviceID, int *errorCode)
 
double getMinimumOutputVoltageDC (long deviceID, int *errorCode)
 
int getNumberOfVoltageDCOutputs (long deviceID, int *errorCode)
 
void setVoltageDCOutVolts (long deviceID, int *errorCode, int output, double voltage)
 

Static Public Member Functions

static AnalogOutAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ configureAltPin()

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

Configure the specified analog output 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 output.
pinTypethe desired alternate type.

◆ getMaximumOutputVoltageDC()

double oceandirect::api::AnalogOutAPI::getMaximumOutputVoltageDC ( long  deviceID,
int *  errorCode 
)

Get the maximum DC output voltage for the analog outputs.

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 output.

◆ getMinimumOutputVoltageDC()

double oceandirect::api::AnalogOutAPI::getMinimumOutputVoltageDC ( long  deviceID,
int *  errorCode 
)

Get the minimum DC output voltage for the analog outputs.

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 output.

◆ getNumberOfVoltageDCOutputs()

int oceandirect::api::AnalogOutAPI::getNumberOfVoltageDCOutputs ( long  deviceID,
int *  errorCode 
)

Get the number of analog outputs.

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 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
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.
outputthe index of the specified analog output.
voltagethe desired output voltage.

The documentation for this class was generated from the following file: