Class State

Representation of a stack level state

Inheritance

object

State

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DuetControlServer.SPI.Channel

Assembly: DuetControlServer.dll

Syntax

public class State

Constructors

State(PipelineStackItem)

Constructor of this class

Declaration

public State(PipelineStackItem stackItem)

Parameters

Type	Name	Description
PipelineStackItem	stackItem	Corresponding state of the firmware stage on the code pipeline

State(PipelineStackItem, bool)

Constructor of this class

Declaration

public State(PipelineStackItem stackItem, bool msActive)

Parameters

Type	Name	Description
PipelineStackItem	stackItem	Corresponding state of the firmware stage on the code pipeline
bool	msActive

Properties

File

File being executed on this state

Declaration

public CodeFile? File { get; }

Property Value

Type	Description
CodeFile

Remarks

This is only assigned once after an instance has been created

FlushRequests

Queue of pending flush requests

Declaration

public Queue<TaskCompletionSource<bool>> FlushRequests { get; }

Property Value

Type	Description
Queue<TaskCompletionSource<bool>>

LockRequests

Queue of pending lock/unlock requests

Declaration

public Queue<LockRequest> LockRequests { get; }

Property Value

Type	Description
Queue<LockRequest>

MacroCompleted

Indicates if the firmware has been notified about the macro completion

Declaration

public bool MacroCompleted { get; set; }

Property Value

Type	Description
bool

MacroError

Indicates if a macro was supposed to be opened but it failed

Declaration

public bool MacroError { get; set; }

Property Value

Type	Description
bool

MotionSystemWasActive

Indicates if the motion system was active when this stack item was created

Declaration

public bool MotionSystemWasActive { get; set; }

Property Value

Type	Description
bool

PendingCodes

Pending codes ready to be sent over to the firmware

Declaration

public Channel<Code> PendingCodes { get; }

Property Value

Type	Description
Channel<Code>

StartCode

Code that started this state

Declaration

public Code? StartCode { get; set; }

Property Value

Type	Description
Code

SuspendedCodes

Queue of suspended G/M/T-codes to resend when this state becomes active again

Declaration

public Queue<Code> SuspendedCodes { get; }

Property Value

Type	Description
Queue<Code>

WaitingForAcknowledgement

Indicates if this state is waiting for a confirmation

Declaration

public bool WaitingForAcknowledgement { get; set; }

Property Value

Type	Description
bool

Methods

SetBusy(bool)

Called to flag if the pipeline is busy or not

Declaration

public void SetBusy(bool isBusy)

Parameters

Type	Name	Description
bool	isBusy