Inherits NetOceanDirect::ManagedObject< BinningAPI >.
|
unsigned char | getDefaultFactor (long deviceID, int% errorCode) |
|
unsigned char | getFactor (long deviceID, int% errorCode) |
|
unsigned char | getMaxFactor (long deviceID, int% errorCode) |
|
void | setDefaultFactor (long deviceID, int% errorCode) |
|
void | setDefaultFactor2 (long deviceID, int% errorCode, const unsigned char binningFactor) |
|
void | setFactor (long deviceID, int% errorCode, const unsigned char binningFactor) |
|
| ManagedObject (BinningAPI *instance) |
|
BinningAPI * | GetInstance () |
|
◆ getDefaultFactor()
unsigned char Binning::getDefaultFactor |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's default pixel binning factor setting.
- Parameters
-
- Returns
- the given device's default pixel binning factor, or 0 if an error occurred
◆ getFactor()
unsigned char Binning::getFactor |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the fiven device's current pixel binning factor setting, which determines how many consecutive pixels are being grouped into each bin.
- Parameters
-
- Returns
- current pixel binning factor for the given device, or 0 if an error occurred
◆ getMaxFactor()
unsigned char Binning::getMaxFactor |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's maximum possible pixel binning factor setting.
- Parameters
-
- Returns
- the given device's maximum possible pixel binning factor setting
◆ setDefaultFactor()
void Binning::setDefaultFactor |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Restores the given device's pixel binning factor setting to its default value.
- Parameters
-
◆ setDefaultFactor2()
void Binning::setDefaultFactor2 |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
const unsigned char |
binningFactor |
|
) |
| |
Changes the default value for the given device's pixel binning factor setting to a new value. This new default will then be applied each time the device powers on, or when setDefaultFactor() is called.
- 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] | binningFactor | the new pixel binning factor default value, which should be a valid binning factor according to the device's user's manual |
◆ setFactor()
void Binning::setFactor |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
const unsigned char |
binningFactor |
|
) |
| |
Sets the given device's pixel binning factor, which determines how many consecutive pixels are grouped into each bin.
- 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] | binningFactor | the new pixel binning factor, which should be a valid binning factor according to the device's user's manual |
The documentation for this class was generated from the following files: