Photomechanics API
Photomechanics.Photo3DStudio.TurntableControl.Interfaces.ITurntableCommand Interface Reference

Represents turntable command that has status and can be awaited. More...

Inheritance diagram for Photomechanics.Photo3DStudio.TurntableControl.Interfaces.ITurntableCommand:
[legend]

Public Member Functions

Task WaitEnterProcessingStateAsync ()
 Wait for command to enter TurntableCommandStatus.Processing state asynchronously. Processing state means that turntable accepted command, started executing it and will return Success status later on. Used for lengthy processes (i.e. rotation commands). More...
 
Task WaitFinishAsync ()
 Wait for command to finish asynchronously. More...
 

Properties

TurntableCommandStatus Status [get]
 Command status. More...
 

Events

TypedEventHandler< ITurntableCommand, TurntableCommandStatusStatusChanged
 Occurs when command execution is finished. More...
 

Detailed Description

Represents turntable command that has status and can be awaited.

Member Function Documentation

◆ WaitEnterProcessingStateAsync()

Task Photomechanics.Photo3DStudio.TurntableControl.Interfaces.ITurntableCommand.WaitEnterProcessingStateAsync ( )

Wait for command to enter TurntableCommandStatus.Processing state asynchronously. Processing state means that turntable accepted command, started executing it and will return Success status later on. Used for lengthy processes (i.e. rotation commands).

Implemented in Photomechanics.Photo3DStudio.TurntableControl.TurntableCommandBase.

◆ WaitFinishAsync()

Task Photomechanics.Photo3DStudio.TurntableControl.Interfaces.ITurntableCommand.WaitFinishAsync ( )

Wait for command to finish asynchronously.

Implemented in Photomechanics.Photo3DStudio.TurntableControl.TurntableCommandBase.

Property Documentation

◆ Status

TurntableCommandStatus Photomechanics.Photo3DStudio.TurntableControl.Interfaces.ITurntableCommand.Status
get

Command status.

Event Documentation

◆ StatusChanged

TypedEventHandler<ITurntableCommand, TurntableCommandStatus> Photomechanics.Photo3DStudio.TurntableControl.Interfaces.ITurntableCommand.StatusChanged

Occurs when command execution is finished.