IFilter |
Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.0.0-rc.0+0
SyntaxExceptions| Exception | Condition |
|---|---|
| InvalidValueException | Must throw an InvalidValueException if an invalid position is set |
| 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. |
RemarksMust be implemented, must not throw a PropertyNotImplementedException.
This is an asynchronous operation: Writing to Position must return as soon as the filter change operation has been successfully started. Reading the Position property must return -1 while the change is in progress. After the requested position has been successfully reached and motion stops, reading Position must return the requested new filter number.
Write a position number between 0 and N-1, where N is the number of filter slots (see Names). Starts filter wheel rotation immediately. Reading the property gives current slot number (if wheel stationary) or -1 if wheel is moving.Returning a position of -1 is mandatory while the filter wheel is in motion; valid slot numbers must not be reported back while the filter wheel is rotating past filter positions.
Note
Some filter wheels are built into the camera (one driver, two interfaces). Some cameras may not actually rotate the wheel until the exposure is triggered. In this case, the written value is available immediately as the read value, and -1 is never produced.
Revision History| Date | Version | Description |
|---|---|---|
| IFilterWheel | Platform 5.0 | Member added. |
See Also