Class Code

Namespace

DuetControlServer.Commands

Assembly

DuetControlServer.dll

Implementation of the Code command

public sealed class Code : Code, IConnectionCommand

Inheritance

object

BaseCommand

Command<Message>

Code

Code

Implements

IConnectionCommand

Inherited Members

Code.CopyFrom(Code)

Code.HasParameter(char)

Code.GetParameter(char)

Code.GetParameter(char, object)

Code.TryGetParameter(char, out CodeParameter)

Code.GetFloat(char)

Code.GetFloat(char, float)

Code.TryGetFloat(char, out float)

Code.TryGetFloat(char, out float?)

Code.GetInt(char)

Code.GetInt(char, int)

Code.TryGetInt(char, out int)

Code.TryGetInt(char, out int?)

Code.GetUInt(char)

Code.GetUInt(char, uint)

Code.TryGetUInt(char, out uint)

Code.TryGetUInt(char, out uint?)

Code.GetLong(char)

Code.GetLong(char, long)

Code.TryGetLong(char, out long)

Code.TryGetLong(char, out long?)

Code.GetBool(char)

Code.GetBool(char, bool)

Code.TryGetBool(char, out bool)

Code.TryGetBool(char, out bool?)

Code.GetString(char)

Code.GetOptionalString(char)

Code.GetString(char, string)

Code.TryGetString(char, out string)

Code.GetDriverId(char)

Code.GetDriverId(char, DriverId)

Code.TryGetDriverId(char, out DriverId)

Code.GetIPAddress(char)

Code.GetIPAddress(char, IPAddress)

Code.TryGetIPAddress(char, out IPAddress)

Code.GetFloatArray(char)

Code.GetFloatArray(char, float[])

Code.TryGetFloatArray(char, out float[])

Code.GetIntArray(char)

Code.GetIntArray(char, int[])

Code.TryGetIntArray(char, out int[])

Code.GetUIntArray(char)

Code.GetUIntArray(char, uint[])

Code.TryGetUIntArray(char, out uint[])

Code.GetLongArray(char)

Code.GetLongArray(char, long[])

Code.TryGetLongArray(char, out long[])

Code.GetDriverIdArray(char)

Code.GetDriverIdArray(char, DriverId[])

Code.TryGetDriverIdArray(char, out DriverId[])

Code.GetUnprecedentedString(bool)

Code.ToString()

Code.ToShortString()

Code.Parse(TextReader, Code)

Code.ConvertDriverIds()

Code.ParseAsync(Stream, Code, CodeParserBuffer, CancellationToken)

Code.UpdateFromJson(JsonElement)

Code.UpdateFromJsonReader(ref Utf8JsonReader)

Code.SourceConnection

Code.Result

Code.Type

Code.Channel

Code.IsFromFileChannel

Code.LineNumber

Code.ExplicitLineNumber

Code.Indent

Code.Keyword

Code.KeywordArgument

Code.MajorNumber

Code.MinorNumber

Code.Flags

Code.Comment

Code.FilePosition

Code.Length

Code.Parameters

Command<Message>.InvokeAsync(CancellationToken)

BaseCommand.Command

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Code(CodeProcessor, Expressions, ICodeHandler, ICodeHandler, ICodeHandler, ICodeHandler, IHostApplicationLifetime, LinkInterface, ILogger<Code>, IOptions<Settings>)

Constructor of a new code

public Code(CodeProcessor codeProcessor, Expressions expressions, ICodeHandler gCodes, ICodeHandler mCodes, ICodeHandler tCodes, ICodeHandler keywords, IHostApplicationLifetime lifetime, LinkInterface linkInterface, ILogger<Code> logger, IOptions<Settings> settings)

Parameters

codeProcessor CodeProcessor

Code processor

expressions Expressions

Meta G-code expression parser

gCodes ICodeHandler

G-code handler

mCodes ICodeHandler

M-code handler

tCodes ICodeHandler

T-code handler

keywords ICodeHandler

Keyword handler

lifetime IHostApplicationLifetime

Host application lifetime

linkInterface LinkInterface

Link interface

logger ILogger<Code>

Logger instance

settings IOptions<Settings>

Settings

Code(string, CodeProcessor, Expressions, ICodeHandler, ICodeHandler, ICodeHandler, ICodeHandler, IHostApplicationLifetime, LinkInterface, ILogger<Code>, IOptions<Settings>)

Constructor of a new code which also parses the given text-based G/M/T-code

public Code(string code, CodeProcessor codeProcessor, Expressions expressions, ICodeHandler gCodes, ICodeHandler mCodes, ICodeHandler tCodes, ICodeHandler keywords, IHostApplicationLifetime lifetime, LinkInterface linkInterface, ILogger<Code> logger, IOptions<Settings> settings)

Parameters

code string

Text-based G/M/T-code

codeProcessor CodeProcessor

Code processor

expressions Expressions

Meta G-code expression parser

gCodes ICodeHandler

G-code handler

mCodes ICodeHandler

M-code handler

tCodes ICodeHandler

T-code handler

keywords ICodeHandler

Keyword handler

lifetime IHostApplicationLifetime

Host application lifetime

linkInterface LinkInterface

Link interface

logger ILogger<Code>

Logger instance

settings IOptions<Settings>

Settings

Properties

Connection

Source connection of this command

public Connection? Connection { get; set; }

Property Value

Connection

Methods

ExecuteAsync(CancellationToken)

Run an arbitrary G/M/T-code and wait for it to finish or to be enqueued if it is asynchronous

public override Task<Message?> ExecuteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional cancellation token

Returns

Task<Message>

Result of the code

Exceptions

OperationCanceledException

Code has been cancelled

Reset()

Resets more Code fields

public override void Reset()

SetCancelled()

Set this code as cancelled

public void SetCancelled()

SetException(Exception)

Set an exception for this code

public void SetException(Exception e)

Parameters

e Exception

Exception to set

SetFinished()

Set this code as complete

public void SetFinished()