ASCOM Library
ISwitch
Returns the step size that this device supports (the difference between successive values of the device).
Definition
Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
The step size for this device.
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
double SwitchStep(
short id
)VB
Function SwitchStep (
id As Short
) As DoubleParameters
Return Value
DoubleThe step size for this device.
Remarks
Must be implemented, must not throw NotImplementedException.
SwitchStep, MinSwitchValue and MaxSwitchValue can be used to determine the way the device is controlled and/or displayed, for example by setting the number of decimal places or number of states for a display.
SwitchStep(Int16) must be greater than zero and the number of steps can be calculated as: ((MaxSwitchValue(Int16) - MinSwitchValue(Int16)) / SwitchStep(Int16)) + 1.
The switch range (MaxSwitchValue(Int16) - MinSwitchValue(Int16)) must be an exact multiple of SwitchStep(Int16).
If a two state device cannot report its state, SwitchStep(Int16) should return the value 1.0.
Devices are numbered from 0 to MaxSwitch - 1.
This is a Version 2 method.
Exceptions
| InvalidValueException | If id is outside the range 0 to MaxSwitch - 1 |
| NotConnectedException | When Connected is False. |
| 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. |