Click or drag to resize

ICoverCalibratorV1CalibratorState Property

Returns the state of the calibration device, if present, otherwise returns "NotPresent"

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
Copy
CalibratorStatus CalibratorState { get; }

Property Value

Type: CalibratorStatus
Exceptions
ExceptionCondition
NotConnectedExceptionIf the device is not connected.
DriverExceptionAn 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.
Remarks

This is a mandatory property that must return a value, it must not throw a PropertyNotImplementedException.

The Unknown state must only be returned if the device is unaware of the calibrator's state e.g. if the hardware does not report the device's state and the calibrator has just been powered on. Clients do not need to take special action if this state is returned, they must carry on as usual, issuing CalibratorOn(Int32) and CalibratorOff commands as required.

If the calibrator hardware cannot report its state, the device could mimic this by recording the last configured state and returning this. Driver authors or device manufacturers may also wish to offer users the capability of powering up in a known state and driving the hardware to this state when Connected is set .

See Also