ICoverCalibratorV2CalibratorState Property

CalibratorStatus CalibratorState { get; }

ReadOnly Property CalibratorState As CalibratorStatus
	Get

property CalibratorStatus CalibratorState {
	CalibratorStatus get ();
}

Property Value

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

Whenever the calibrator is changing both CalibratorChanging must be True and CalibratorState must be NotReady.

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 .

This property is intended to be available under all but the most disastrous driver conditions.If something has gone wrong, the CoverState must be Error rather than throwing an exception.

Reference