ICameraV3Gains Property |
Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
SyntaxReturn Value
Type: ArrayListThe list of supported gain names as an ArrayList of strings
Exceptions| Exception | Condition |
|---|---|
| PropertyNotImplementedException | When the Gain property is not implemented or is operating in GAIN VALUE mode. |
| NotConnectedException | If the device is not connected |
| DriverException | An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself. |
RemarksThis is an optional property and can throw a PropertyNotImplementedException.
When Gain is operating in GAINS INDEX mode:- The Gains property must return a zero-based ArrayList of available gain setting names.
- The GainMin and GainMax properties must throw PropertyNotImplementedExceptions.
The returned gain names could, for example, be a list of ISO settings for a DSLR camera or a list of gain names for a CMOS camera. Typically the application software will display the returned gain names in a drop list, from which the astronomer can select the required value. The application can then configure the required gain by setting the camera's Gain property to the array index of the selected description.
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.
This is only available in Camera Interface Version 2 and later.
See Also