Inherits NetOceanDirect::ManagedObject< IrradCalibrAPI >.
|
array< double > | read (long deviceID, int% errorCode, int bufferLength) |
|
int | readCalibrationDataSize (long deviceID, int% errorCode) |
|
float | readCollectionArea (long deviceID, int% errorCode) |
|
int | write (long deviceID, int% errorCode, array< float >^ buffer, int bufferLength) |
|
void | writeCollectionArea (long deviceID, int% errorCode, float area) |
|
| ManagedObject (IrradCalibrAPI *instance) |
|
IrradCalibrAPI * | GetInstance () |
|
|
IrradCalibrAPI * | m_Instance |
|
◆ read()
array< double > IrradCalibrate::read |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
int |
bufferLength |
|
) |
| |
Reads the given device's onboard irradiance calibration. The buffer length can be computed using the return values of readCalibrationDataSize().
- Parameters
-
[in] | deviceID | the device ID for the device to be queried (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
[in] | bufferLength | the number of bytes to read from the device |
- Returns
- a tracked handle to a new array of length bufferLength containing the irradiance calibration
◆ readCalibrationDataSize()
int IrradCalibrate::readCalibrationDataSize |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Reads the given device's onboard irradiance calibration data count.
- Parameters
-
- Returns
- The size of the irradiance calibration data.
◆ readCollectionArea()
float IrradCalibrate::readCollectionArea |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the amount of area used to collect light for the given device.
- Parameters
-
- Returns
- the amount of detector area used to collect light, in square meters (m^2) // TODO: Confirm units
◆ write()
int IrradCalibrate::write |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
array< float >^ |
buffer, |
|
|
int |
bufferLength |
|
) |
| |
Writes an irradiance calibration to the given device's onboard memory.
- Parameters
-
[in] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
[in] | buffer | a buffer containing the new irradiance calibration to be written (length of bufferLength) |
[in] | bufferLength | the length of buffer, in elements |
- Returns
- the number of elements written to the device
◆ writeCollectionArea()
void IrradCalibrate::writeCollectionArea |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
float |
area |
|
) |
| |
Sets the amount of area used to collect light (as an abstract value used for irradiance calculations, not by actually changing anything on the detector) for the given device.
- Parameters
-
[in] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
[in] | area | the area on the detector collecting light, in square meters (m^2) // TODO: Confirm units |
The documentation for this class was generated from the following files: