Struct StepVariableWrite

Namespace

Hi.MachiningSteps

Assembly

HiMech.dll

One write of a batch of step-variable values (WriteStepVariables(IReadOnlyList<StepVariableWrite>)): the step, the key and the value — a number (stored as a double) or a string, or null to take the key back off the step. The brief-into-DB chain's C4c.

public readonly record struct StepVariableWrite : IEquatable<StepVariableWrite>

Implements

IEquatable<StepVariableWrite>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

MaskUtil.GetMaskedValue<T>(T, T, bool)

MaskUtil.SetMask<T>(ref T, T, bool)

ColorUtil.GetGloomyColor(object, double, double)

KindNameUtil.KindName(object)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

StepVariableWrite(int, string, object)

One write of a batch of step-variable values (WriteStepVariables(IReadOnlyList<StepVariableWrite>)): the step, the key and the value — a number (stored as a double) or a string, or null to take the key back off the step. The brief-into-DB chain's C4c.

public StepVariableWrite(int StepIndex, string Key, object Value)

Parameters

StepIndex int

The step index.

Key string

The step variable's key.

Value object

The value (StepVariableValue); null deletes the step's row under the key.

Fields

SegmentLength

The writes a caller hands the host at a time — one transaction a segment: a mapping, a training or a script writing many steps keeps a transaction to this many rows.

public const int SegmentLength = 4096

Field Value

int

Properties

Key

The step variable's key.

public string Key { get; init; }

Property Value

string

StepIndex

The step index.

public int StepIndex { get; init; }

Property Value

int

Value

The value (StepVariableValue); null deletes the step's row under the key.

public object Value { get; init; }

Property Value

object