Photomechanics API
IRotationFeedbackProvider Interface Reference

Provides info about current steps. More...

Inheritance diagram for IRotationFeedbackProvider:
[legend]

Public Member Functions

Task< Double > GetCurrentDegrees ()
 Get current rotation state (independently from periodic notifications). More...
 
Task SetDegreesPerNotify (Double degrees)
 Set notifications interval. More...
 
Task DisableNotifications ()
 Disable notifications. More...
 

Events

TypedEventHandler< IRotationFeedbackProvider, Double > CurrentDegreesNotifyReceived
 Occurs when current steps number is received. More...
 

Detailed Description

Provides info about current steps.

Member Function Documentation

◆ GetCurrentDegrees()

Task< Double > IRotationFeedbackProvider.GetCurrentDegrees ( )

Get current rotation state (independently from periodic notifications).

Returns
Rotation position in degrees at the time the command was executed.
Exceptions
TurntableOperationFailedExceptionThrown when turn table returns fail result of operation.

◆ SetDegreesPerNotify()

Task IRotationFeedbackProvider.SetDegreesPerNotify ( Double  degrees)

Set notifications interval.

Parameters
degreesNotification interval in degrees. Must be greater then zero.
Exceptions
ArgumentExceptionInvalid notifications interval.
TurntableOperationFailedExceptionThrown when turn table returns fail result of operation.

◆ DisableNotifications()

Task IRotationFeedbackProvider.DisableNotifications ( )

Disable notifications.

Exceptions
TurntableOperationFailedExceptionThrown when turn table returns fail result of operation.

Event Documentation

◆ CurrentDegreesNotifyReceived

TypedEventHandler<IRotationFeedbackProvider, Double> IRotationFeedbackProvider.CurrentDegreesNotifyReceived

Occurs when current steps number is received.

Exceptions
TurntableOperationFailedExceptionThrown when turn table returns fail result of operation.