Click or drag to resize
Switch Methods

The Switch type exposes the following members.

Methods
  Name Description
Public method Code example Action
Invokes the specified device-specific action.
(Inherited from AscomDriver.)
Public method CanWrite
Reports if the specified switch device can be written to, default true. This is false if the device cannot be written to, for example a limit switch or a sensor.
Public method Static member Choose
Brings up the ASCOM Chooser Dialog to choose a Switch
Public method CommandBlind
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AscomDriver.)
Public method CommandBool
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AscomDriver.)
Public method CommandString
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from AscomDriver.)
Public method Dispose
Releases the unmanaged late bound COM object
(Inherited from AscomDriver.)
Public method GetSwitch
Return the state of switch device id as a boolean.
Public method GetSwitchDescription
Gets the description of the specified switch device. This is to allow a fuller description of the device to be returned, for example for a tool tip.
Public method GetSwitchName
Return the name of switch device n. This method is mandatory.
Public method GetSwitchValue
Returns the value for switch device id as a double.
Public method MaxSwitchValue
Returns the maximum value for this switch device, this must be greater than MinSwitchValue(Int16).
Public method MinSwitchValue
Returns the minimum value for this switch device, this must be less than MaxSwitchValue(Int16).
Public method SetSwitch
Sets a switch controller device to the specified state If the device cannot be set then throws a MethodNotImplementedException.
Public method SetSwitchName
Sets a switch device name to a specified value. If the device name cannot be set by the application this must return the MethodNotImplementedException .
Public method SetSwitchValue
Set the value for this device as a double. If the switch cannot be set then throws a MethodNotImplementedException. If the value is not between the MaxSwitchValue(Int16) and MinSwitchValue(Int16) then throws an InvalidValueException.
Public method SetupDialog
Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
(Inherited from AscomDriver.)
Public method SwitchStep
Returns the step size that this device supports. This gives the difference between successive values of the device.
Top
See Also