Click or drag to resize

ISwitchV2SwitchStep Method

Returns the step size that this device supports (the difference between successive values of the device).

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
Copy
double SwitchStep(
	short id
)

Parameters

id
Type: SystemInt16
The device number (0 to MaxSwitch - 1)

Return Value

Type: Double
The step size for this device.
Exceptions
ExceptionCondition
InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1
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

Must be implemented, must not throw MethodNotImplementedException.

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) must return the value 1.0.

Devices are numbered from 0 to MaxSwitch - 1.

This is a Version 2 method.

See Also