Class VariableRequest

Namespace

DuetControlServer.Link

Assembly

DuetControlServer.dll

Internal storage class for variable requests

public class VariableRequest

Inheritance

object

VariableRequest

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

VariableRequest(CodeChannel, bool, string, string?)

Internal storage class for variable requests

public VariableRequest(CodeChannel channel, bool createVariable, string varName, string? expression)

Parameters

channel CodeChannel

Where to evaluate the expression

createVariable bool

Whether the variable is supposed to be created

varName string

Name of the variable

expression string

Expression to evaluate

Properties

Channel

Where the expression is evaluated

public CodeChannel Channel { get; }

Property Value

CodeChannel

CreateVariable

Whether the variable is supposed to be created

public bool CreateVariable { get; }

Property Value

bool

Expression

Expression to set or null if the variable is supposed to be deleted

public string? Expression { get; }

Property Value

string

Task

Task that completes when the request has been fulfilled

public Task<object?> Task { get; }

Property Value

Task<object>

VariableName

Name of the variable

public string VariableName { get; }

Property Value

string

Written

Whether the request has been sent to the firmware

public bool Written { get; set; }

Property Value

bool

Methods

SetCanceled()

Set the task to canceled

public void SetCanceled()

SetException(Exception)

Set an exception for the task

public void SetException(Exception exception)

Parameters

exception Exception

Exception to set

SetResult(object?)

Set the result of the evaluated expression

public void SetResult(object? result)

Parameters

result object

Result to set