Click or drag to resize

AscomDriver Class

Base class for ASCOM driver access toolkit device classes. This class contains the methods common to all devices so that they can be maintained in just one place.
Inheritance Hierarchy
SystemObject
  ASCOM.DriverAccessAscomDriver
    More

Namespace: ASCOM.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 7.0.0-rc.0+0
Syntax
Copy
public class AscomDriver : IDisposable

The AscomDriver type exposes the following members.

Constructors
 NameDescription
Public methodAscomDriverInitializes a new instance of the AscomDriver class
Public methodAscomDriver(String) Creates a new instance of the AscomDriver class.
Top
Properties
 NameDescription
Public propertyConnected Set True to connect to the device hardware. Set False to disconnect from the device hardware. You can also read the property to check whether it is connected. This reports the current hardware state.
Public propertyConnecting Returns True while the device is undertaking an asynchronous connect or disconnect operation.
Public propertyDescription Returns a description of the device, such as manufacturer and model number. Any ASCII characters may be used.
Public propertyDeviceState Returns the device's operational state in a single call.
Public propertyDriverInfo Descriptive and version information about this ASCOM driver.
Public propertyDriverVersion A string containing only the major and minor version of the driver.
Public propertyHasConnectAndDeviceState Returns if the device has a Platform 7 or later interface that supports Connect / Disconnect and DeviceState
Public propertyInterfaceVersion The interface version number that this device supports.
Public propertyName The short name of the driver, for display purposes
Public propertySupportedActionsReturns the list of custom action names supported by this driver.
Top
Methods
 NameDescription
Public methodActionInvokes the specified device-specific custom action.
Public methodCommandBlind 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.
Public methodCommandBool 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.
Public methodCommandString 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.
Public methodConnect Connect to the device asynchronously
Public methodDisconnect Disconnect from the device asynchronously
Public methodDispose 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.
Public methodSetupDialog Launches a configuration dialogue box for the driver. The call will not return until the user clicks OK or cancel manually.
Top
See Also
Inheritance Hierarchy