FilterWheel Class

FilterWheel device class

Definition

Namespace: ASCOM.Com.DriverAccess
Assembly: ASCOM.Com (in ASCOM.Com.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea

C#

public class FilterWheel : ASCOMDevice, 
	IFilterWheelV3, IAscomDeviceV2, IAscomDevice, IFilterWheelV2

VB

Public Class FilterWheel
	Inherits ASCOMDevice
	Implements IFilterWheelV3, IAscomDeviceV2, IAscomDevice, IFilterWheelV2

FilterWheel(String)	Initialise FilterWheel device
FilterWheel(String, ILogger)	Initialise FilterWheel device with a debug logger

Connected	Set True to enable the link. Set False to disable the link. You can also read the property to check whether it is connected. (Inherited from ASCOMDevice)
Connecting	Completion variable for asynchronous connect and disconnect operations (Inherited from ASCOMDevice)
Description	Returns a description of the driver, such as manufacturer and model number.
DeviceState	Returns the device's operational state in a single call (Inherited from ASCOMDevice)
DriverInfo	Descriptive and version information about this ASCOM driver.
DriverVersion	A string in the form "n.n" containing only the major and minor version of the driver.
FilterWheels	Return a list of all FilterWheels registered in the ASCOM Profile
FilterWheelState	FilterWheel device state
FocusOffsets	Focus offset of each filter in the wheel
InterfaceVersion	The interface version number that this device implements. (Inherited from ASCOMDevice)
Name	The short name of the driver, for display purposes
Names	Name of each filter in the wheel
Position	Sets or returns the current filter wheel position
SupportedActions	Returns the list of action names supported by this driver. (Inherited from ASCOMDevice)

Action	Invokes the specified device-specific action. (Inherited from ASCOMDevice)
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 ASCOMDevice)
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 ASCOMDevice)
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 ASCOMDevice)
Connect	Connect to device asynchronously (Inherited from ASCOMDevice)
Disconnect	Disconnect from device asynchronously (Inherited from ASCOMDevice)
Dispose	This method is a "clean-up" method that is primarily of use to drivers that are written in languages such as C# and VB.NET where resource clean-up is initially managed by the language's runtime garbage collection mechanic. Driver authors should take care to ensure that a client or runtime calling Dispose() does not adversely affect other connected clients. Applications should not call this method. (Inherited from ASCOMDevice)
SetupDialog	Show the device set-up dialog (Inherited from ASCOMDevice)

ConnectAsync	Returns an awaitable, running, Task that connects to the device. (Polls IAscomDeviceV2.Connecting) (Defined by ClientExtensions)
DisconnectAsync	Returns an awaitable, running, Task that disconnects from the device. (Polls IAscomDeviceV2.Connecting) (Defined by ClientExtensions)
PositionSetAsync	Returns an awaitable, running, Task that moves the filter wheel to the specified filter wheel position (Defined by ClientExtensions)

Supported in: 2.0