ClientExtensionsMoveMechanicalAsync Method

Returns an awaitable, running, Task that moves the rotator to the specified mechanical position

Definition

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

C#

public static Task MoveMechanicalAsync(
	this IRotatorV3 device,
	double position,
	CancellationToken cancellationToken = default,
	int pollInterval = 1000,
	ILogger logger = null
)

VB

<ExtensionAttribute>
Public Shared Function MoveMechanicalAsync ( 
	device As IRotatorV3,
	position As Double,
	Optional cancellationToken As CancellationToken = Nothing,
	Optional pollInterval As Integer = 1000,
	Optional logger As ILogger = Nothing
) As Task

Parameters

device IRotatorV3: The Rotator device
position Double: The required filter wheel position
cancellationToken CancellationToken (Optional): Cancellation token - Default: None
pollInterval Int32 (Optional): Interval between polls of the completion variable (milliseconds) - Default: 1000 milliseconds.
logger ILogger (Optional): ILogger instance that will receive operation messages from the method - Default: No logger

Return Value

Task
Awaitable task that ends when the rotator is at the required mechanical position

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IRotatorV3. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Initiator: MoveMechanical(Single)

Complete when: IsMoving is

Version Information

.NET Standard

Supported in: 2.0