Class Code

Implementation of the Code command

Inheritance

object

BaseCommand

Command<Message>

Code

Code

Implements

IConnectionCommand

Inherited Members

Code.SourceConnection

Code.Result

Code.Type

Code.Channel

Code.IsFromFileChannel

Code.LineNumber

Code.Indent

Code.Keyword

Code.KeywordArgument

Code.MajorNumber

Code.MinorNumber

Code.Flags

Code.Comment

Code.FilePosition

Code.Length

Code.Parameters

Code.Parameter(char)

Code.Parameter(char, object)

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(StreamReader, Code, CodeParserBuffer)

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

Command<Message>.Invoke()

BaseCommand.Command

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Namespace: DuetControlServer.Commands

Assembly: DuetControlServer.dll

Syntax

public sealed class Code : Code, IConnectionCommand

Constructors

Code()

Constructor of a new code

Declaration

public Code()

Code(string)

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

Declaration

public Code(string code)

Parameters

Type	Name	Description
string	code

Fields

FileLocks

Lock around the files being written

Declaration

public static readonly AsyncLock[] FileLocks

Field Value

Type	Description
AsyncLock[]

FilesBeingWritten

Current stream writer of the files being written to (M28/M29)

Declaration

public static readonly StreamWriter?[] FilesBeingWritten

Field Value

Type	Description
StreamWriter[]

Properties

Connection

Source connection of this command

Declaration

public Connection? Connection { get; set; }

Property Value

Type	Description
Connection

Methods

CancelPending(CodeChannel)

Cancel pending codes of the given channel

Declaration

public static void CancelPending(CodeChannel channel)

Parameters

Type	Name	Description
CodeChannel	channel	Channel to cancel codes from

EmulatingMarlin()

Check if Marlin is being emulated

Declaration

public Task<bool> EmulatingMarlin()

Returns

Type	Description
Task<bool>	True if Marlin is being emulated

Execute()

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

Declaration

public override Task<Message?> Execute()

Returns

Type	Description
Task<Message>	Result of the code

Overrides

Command<Message>.Execute()

Exceptions

Type	Condition
OperationCanceledException	Code has been cancelled

Reset()

Resets more Code fields

Declaration

public override void Reset()

Overrides

Code.Reset()

SetCancelled()

Set this code as cancelled

Declaration

public void SetCancelled()

SetException(Exception)

Set an exception for this code

Declaration

public void SetException(Exception e)

Parameters

Type	Name	Description
Exception	e	Exception to set

SetFinished()

Set this code as complete

Declaration

public void SetFinished()

Implements

IConnectionCommand