Photomechanics API
TurntableCommandBase Class Reference

Base class for ITurntableCommand, implements common functionality. More...

Inheritance diagram for TurntableCommandBase:
[legend]

Public Member Functions

void Dispose ()
 
async 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...
 
async Task WaitFinishAsync ()
 Wait for command to finish asynchronously. More...
 
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...
 

Protected Member Functions

 TurntableCommandBase ()
 Initialized TurntableCommandBase state awaiting mechanisms.
 

Properties

Stopwatch RunningTimeStopwatch [get]
 Stopwatch that is started when command created.
 
ILogger Logger [get, set]
 Logger attached to this command. More...
 
TurntableCommandStatus Status [get, protected set]
 Command status. More...
 
- Properties inherited from ITurntableCommand
TurntableCommandStatus Status [get]
 Command status. More...
 
ILogger Logger [get]
 Logger attached to this command. More...
 

Events

TypedEventHandler< ITurntableCommand, TurntableCommandStatus > StatusChanged
 
- Events inherited from ITurntableCommand
TypedEventHandler< ITurntableCommand, TurntableCommandStatus > StatusChanged
 Occurs when command execution is finished.
 

Detailed Description

Base class for ITurntableCommand, implements common functionality.

Member Function Documentation

◆ WaitEnterProcessingStateAsync()

async Task TurntableCommandBase.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).

Implements ITurntableCommand.

◆ WaitFinishAsync()

async Task TurntableCommandBase.WaitFinishAsync ( )

Wait for command to finish asynchronously.

Implements ITurntableCommand.

Property Documentation

◆ Logger

ILogger TurntableCommandBase.Logger
getset

Logger attached to this command.

Implements ITurntableCommand.

◆ Status

TurntableCommandStatus TurntableCommandBase.Status
getprotected set

Command status.

Implements ITurntableCommand.