org.minetti.astrodevice.common.object
Interface CameraAdjustableGainCapabilities

All Superinterfaces:

CameraGainCapabilities

public interface CameraAdjustableGainCapabilities
extends CameraGainCapabilities

Object representing the gain capabilities of a camera with a min and max integer value which specify a valid range.

Author:

Jean-Philippe MINETTI

Method Summary

short	getGainMax() Returns the maximum gain value supported by the camera.
short	getGainMin() Returns the minimum gain value supported by the camera.

Method Detail

getGainMin

short getGainMin()

Returns the minimum gain value supported by the camera.

When specifying the gain setting with an integer value, getGainMin is used in conjunction with getGainMax() to specify the range of valid settings.

getGainMax() shall be greater than getGainMin. If either is available, then both must be available.

Please see CameraOrbProcess.setGain(long, short) for more information.

It is recommended that this function be called only after a connection is established with the camera hardware, to ensure that the driver is aware of the capabilities of the specific camera model.

Returns:

Minimum gain value supported by the camera.

Throws:

NotConnectedException - Must throw an exception if the information is not available (Some drivers may require an active connection in order to retrieve necessary information from the camera).

PropertyNotImplementedException - Must throw an exception if getGainMin is not supported.

getGainMax

short getGainMax()

Returns the maximum gain value supported by the camera.

When specifying the gain setting with an integer value, getGainMax is used in conjunction with getGainMin() to specify the range of valid settings.

getGainMax shall be greater than getGainMin(). If either is available, then both must be available.

Please see CameraOrbProcess.setGain(long, short) for more information.

It is recommended that this function be called only after a connection is established with the camera hardware, to ensure that the driver is aware of the capabilities of the specific camera model.

Returns:

Maximum gain value supported by the camera.

Throws:

NotConnectedException - Must throw an exception if the information is not available (Some drivers may require an active connection in order to retrieve necessary information from the camera).

PropertyNotImplementedException - Must throw an exception if getGainMax is not supported.