Class StepDiagnostic

Namespace

Hi.MachiningProcs

Assembly

HiMech.dll

An IMessage produced while constructing a MachiningStep, anchored to the step's execution-order StepIndex and (when available) its NC-source SentenceCarrier.

Decorator over an inner Message — the five IMessage members delegate to it — so a plain SimpleMessage emitted during step processing can be upgraded to a step-anchored diagnostic without the producer needing to know the step context.

public class StepDiagnostic : IMessage, IMotionStepIndex

Inheritance

object

StepDiagnostic

Implements

IMessage

IMotionStepIndex

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

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

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

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

StepDiagnostic(int, ISentenceCarrier, IMessage)

Initializes a new instance of the StepDiagnostic class.

public StepDiagnostic(int stepIndex, ISentenceCarrier sentenceCarrier, IMessage message)

Parameters

stepIndex int

Execution-order index of the step.

sentenceCarrier ISentenceCarrier

NC-source carrier for the step; may be null.

message IMessage

The wrapped inner message.

Properties

Message

The wrapped message supplying severity / category / id / notification / detail.

public IMessage Message { get; }

Property Value

IMessage

SentenceCarrier

NC-source carrier for the step; null when the source is not an ISentenceCarrier (e.g. the legacy hard / CSV runners, which the soft runner is expected to supersede).

public ISentenceCarrier SentenceCarrier { get; }

Property Value

ISentenceCarrier

StepIndex

Execution-order index of the step this diagnostic belongs to.

public int StepIndex { get; }

Property Value

int

Methods

GetCategory()

Gets the classification — see Category.

public Category GetCategory()

Returns

Category

The category of this message.

GetDetail()

Gets the optional detail payload or exception; null when not applicable.

public object GetDetail()

Returns

object

The detail object, or null.

GetId()

Gets the structured id used for filtering / suppression; may be null.

public string GetId()

Returns

string

The message id, or null when not applicable.

GetNotification()

Gets the end-user friendly notification text.

public string GetNotification()

Returns

string

The notification text.

GetSeverity()

Gets the importance level — see Severity.

public Severity GetSeverity()

Returns

Severity

The severity of this message.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.