Click or drag to resize

Rotator Class

Provides universal access to Rotator drivers
Inheritance Hierarchy
SystemObject
  ASCOM.DriverAccessAscomDriver
    ASCOM.DriverAccessRotator

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

The Rotator type exposes the following members.

Constructors
 NameDescription
Public methodRotator Creates a rotator object with the given ProgID
Top
Properties
 NameDescription
Public propertyCanReverse Indicates whether the Rotator supports the Reverse method.
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.
(Inherited from AscomDriver)
Public propertyConnecting Returns True while the device is undertaking an asynchronous connect or disconnect operation.
(Inherited from AscomDriver)
Public propertyDescription Returns a description of the device, such as manufacturer and model number. Any ASCII characters may be used.
(Inherited from AscomDriver)
Public propertyDeviceState Returns the device's operational state in a single call.
(Inherited from AscomDriver)
Public propertyDriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from AscomDriver)
Public propertyDriverVersion A string containing only the major and minor version of the driver.
(Inherited from AscomDriver)
Public propertyHasConnectAndDeviceState Returns if the device has a Platform 7 or later interface that supports Connect / Disconnect and DeviceState
(Inherited from AscomDriver)
Public propertyInterfaceVersion The interface version number that this device supports.
(Inherited from AscomDriver)
Public propertyIsMoving Indicates whether the rotator is currently moving
Public propertyMechanicalPosition This returns the raw mechanical position of the rotator in degrees.
Public propertyName The short name of the driver, for display purposes
(Inherited from AscomDriver)
Public propertyPosition Current instantaneous Rotator position, allowing for any sync offset, in degrees.
Public propertyReverse Sets or Returns the rotator’s Reverse state.
Public propertyRotatorState Rotator device state
Public propertyStepSize The minimum StepSize, in degrees.
Public propertySupportedActionsReturns the list of custom action names supported by this driver.
(Inherited from AscomDriver)
Public propertyTargetPosition The destination position angle for Move() and MoveAbsolute().
Top
Methods
 NameDescription
Public methodActionInvokes the specified device-specific custom action.
(Inherited from AscomDriver)
Public methodStatic memberChoose Brings up the ASCOM Chooser Dialogue to choose a Rotator
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.
(Inherited from AscomDriver)
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.
(Inherited from AscomDriver)
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.
(Inherited from AscomDriver)
Public methodConnect Connect to the device asynchronously
(Inherited from AscomDriver)
Public methodDisconnect Disconnect from the device asynchronously
(Inherited from AscomDriver)
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.
(Inherited from AscomDriver)
Public methodHalt Immediately stop any Rotator motion due to a previous Move or MoveAbsolute method call.
Public methodMove Causes the rotator to move Position degrees relative to the current Position value.
Public methodMoveAbsolute Causes the rotator to move the absolute position of Position degrees.
Public methodMoveMechanical Moves the rotator to the specified mechanical angle.
Public methodSetupDialog Launches a configuration dialogue box for the driver. The call will not return until the user clicks OK or cancel manually.
(Inherited from AscomDriver)
Public methodSync Syncs the rotator to the specified position angle without moving it.
Top
See Also