ICameraV3Offsets Property |
Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
SyntaxReturn Value
Type: ArrayListThe list of supported offset names as an ArrayList of strings
Exceptions| Exception | Condition |
|---|---|
| PropertyNotImplementedException | When the Offset property is not implemented or is operating in OFFSET 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 Offset is operating in OFFSETS INDEX mode:- The Offsets property must return a zero-based ArrayList of available offset setting names.
- The OffsetMin and OffsetMax properties must throw PropertyNotImplementedExceptions.
The returned offset names are at the manufacturer / driver author's discretion and could for example be: "Low gain", "Medium gain" and "High gain"to match the offset to different camera use scenarios. Typically the application software will display the returned offset names in a drop list, from which the astronomer can select the required value. The application can then configure the required offset by setting the camera's Offset 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 3 and later.
See Also