ISwitchV2MaxSwitchValue Method

Returns the maximum value for this switch device, this must be greater than MinSwitchValue(Int16).

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
double MaxSwitchValue(
	short id
)

Parameters

id  Int16
The device number (0 to MaxSwitch - 1)

Return Value

Double
The maximum value to which this device can be set or which a read only sensor will return.

Remarks

Must be implemented, must not throw a NotImplementedException.

If a two state device cannot report its state, MaxSwitchValue(Int16) should return the value 1.0.

Devices are numbered from 0 to MaxSwitch - 1.

This is a Version 2 method.

Exceptions

InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1
NotConnectedExceptionWhen Connected is False.
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.

Version Information

.NET Standard

Supported in: 2.0

See Also