NetOceanDirect  1.31.0
OceanDirect .NET API
Public Member Functions | Static Public Member Functions
NetOceanDirect::Temperature Class Reference

Inherits NetOceanDirect::ManagedObject< TemperatureAPI >.

Public Member Functions

int getCount (long deviceID, int% errorCode)
 
double getTemperature (long deviceID, int% errorCode, int index)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< TemperatureAPI >
 ManagedObject (TemperatureAPI *instance)
 
TemperatureAPI * GetInstance ()
 

Static Public Member Functions

static Temperature getInstance ()
 

Additional Inherited Members

- Protected Attributes inherited from NetOceanDirect::ManagedObject< TemperatureAPI >
TemperatureAPI * m_Instance
 

Member Function Documentation

◆ getCount()

int Temperature::getCount ( long  deviceID,
int%  errorCode 
)

Retrieves the number of temperature sensors available on the given device.

Parameters
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
Returns
the number of available temperature sensors, or 0 if an error occurred

◆ getTemperature()

double Temperature::getTemperature ( long  deviceID,
int%  errorCode,
int  index 
)

Retrieves the current temperature as reported by the specified temperature sensor on the given device.

Parameters
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
[in]indexthe index of the temperature sensor to be read (should be < getCount())
Returns
the current temperature reported by the sensor, in degrees Celsius

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