Returns the value for switch device id as a double

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.1.1.2619)

Syntax

C#
double GetSwitchValue(
	short id
)
Visual Basic
Function GetSwitchValue ( _
	id As Short _
) As Double
Visual C++
double GetSwitchValue(
	short id
)

Parameters

id
Type: System..::..Int16
The device number (0 to MaxSwitch - 1)

Return Value

The value for this switch, this is expected to be between MinSwitchValue(Int16) and MaxSwitchValue(Int16).

Remarks

Must be implemented, must not throw a MethodNotImplementedException.

Some devices do not support reading their state although they do allow state to be set. In these cases, on startup, the driver can not know the hardware state and it is recommended that the driver either:

  • Sets the device to a known state on connection
  • Throws an InvalidOperationException until the client software has set the device state for the first time

In both cases the driver should save a local copy of the state which it last set and return this through GetSwitch(Int16) and GetSwitchValue(Int16)

Devices are numbered from 0 to MaxSwitch - 1.

This is a Version 2 method.

Exceptions

ExceptionCondition
ASCOM..::..InvalidOperationExceptionIf there is a temporary condition that prevents the device value being returned.
ASCOM..::..InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1

See Also