Photomechanics API
LegacyMftCommandBase Class Reference

Represents turn table API command. More...

Inheritance diagram for LegacyMftCommandBase:
[legend]

Public Member Functions

virtual void HandleCustomMessage (String message)
 Custom messages (i.e. any message except status message) handler. More...
 
override String ToString ()
 
void SetStatus (TurntableCommandStatus status)
 Contrary to modern MFT, we have to handle command statuses on a command runner level.
 
- Public Member Functions inherited from TurntableCommandBase
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

 LegacyMftCommandBase (String commandString)
 Construct new LegacyMftCommandBase with given command string.
 
- Protected Member Functions inherited from TurntableCommandBase
 TurntableCommandBase ()
 Initialized TurntableCommandBase state awaiting mechanisms.
 

Properties

String CommandString [get]
 Command string. More...
 
- Properties inherited from TurntableCommandBase
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...
 

Additional Inherited Members

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

Detailed Description

Represents turn table API command.

Member Function Documentation

◆ HandleCustomMessage()

virtual void LegacyMftCommandBase.HandleCustomMessage ( String  message)
virtual

Property Documentation

◆ CommandString

String LegacyMftCommandBase.CommandString
get

Command string.

"RotateSteps:1000"