Class MessageUtil

Namespace

Hi.Common.Messages

Assembly

HiGeom.dll

Extension helpers for reporting SimpleMessage records onto an IProgress<T> of IMessage sink — the IMessage-channel counterpart of NcDiagnosticProgress's shorthand methods. Every helper is named {Category}{Severity} and is id-first; the structured id is used for filtering / suppression. All overloads are null-safe on host.

Each helper has a {Category}{Severity}Fmt sibling taking a FormattableString: it keeps the interpolated template and values (Format / Args) so a client can re-render the message in another language, while the notification stays the invariant English rendering. The sibling must be opted into by name — an interpolated string literal passed to the string helper binds to string and is not captured.

public static class MessageUtil

Inheritance

object

MessageUtil

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ConfigurationError(IProgress<IMessage>, string, string, object)

Reports Configuration + Error (dependency/config missing, cannot proceed).

public static void ConfigurationError(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

ConfigurationErrorFmt(IProgress<IMessage>, string, FormattableString, object)

Templated ConfigurationError(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void ConfigurationErrorFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

ConfigurationMessage(IProgress<IMessage>, string, string, object)

Reports Configuration + Message (dependency/config applied, informational).

public static void ConfigurationMessage(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

ConfigurationMessageFmt(IProgress<IMessage>, string, FormattableString, object)

Templated ConfigurationMessage(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void ConfigurationMessageFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

ConfigurationWarning(IProgress<IMessage>, string, string, object)

Reports Configuration + Warning (dependency/config missing, using fallback).

public static void ConfigurationWarning(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

ConfigurationWarningFmt(IProgress<IMessage>, string, FormattableString, object)

Templated ConfigurationWarning(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void ConfigurationWarningFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

SystemError(IProgress<IMessage>, string, string, object)

Reports System + Error (exception or unconsidered case).

public static void SystemError(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

SystemErrorFmt(IProgress<IMessage>, string, FormattableString, object)

Templated SystemError(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void SystemErrorFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

SystemMessage(IProgress<IMessage>, string, string, object)

Reports System + Message (pipeline lifecycle / informational).

public static void SystemMessage(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

SystemMessageFmt(IProgress<IMessage>, string, FormattableString, object)

Templated SystemMessage(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void SystemMessageFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

SystemProgress(IProgress<IMessage>, string, string, object)

Reports System + Progress (ongoing pipeline progress).

public static void SystemProgress(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

SystemProgressFmt(IProgress<IMessage>, string, FormattableString, object)

Templated SystemProgress(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void SystemProgressFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

SystemSuccess(IProgress<IMessage>, string, string, object)

Reports System + Success (pipeline step completed).

public static void SystemSuccess(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

SystemSuccessFmt(IProgress<IMessage>, string, FormattableString, object)

Templated SystemSuccess(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void SystemSuccessFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

SystemWarning(IProgress<IMessage>, string, string, object)

Reports System + Warning (pipeline anomaly, processing continues).

public static void SystemWarning(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

SystemWarningFmt(IProgress<IMessage>, string, FormattableString, object)

Templated SystemWarning(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void SystemWarningFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

UnsupportedError(IProgress<IMessage>, string, string, object)

Reports Unsupported + Error (recognized but unimplemented, likely matters).

public static void UnsupportedError(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

UnsupportedErrorFmt(IProgress<IMessage>, string, FormattableString, object)

Templated UnsupportedError(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void UnsupportedErrorFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

UnsupportedMessage(IProgress<IMessage>, string, string, object)

Reports Unsupported + Message (recognized, intentionally not simulated).

public static void UnsupportedMessage(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

UnsupportedMessageFmt(IProgress<IMessage>, string, FormattableString, object)

Templated UnsupportedMessage(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void UnsupportedMessageFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

UnsupportedWarning(IProgress<IMessage>, string, string, object)

Reports Unsupported + Warning (recognized but unimplemented, likely harmless).

public static void UnsupportedWarning(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

UnsupportedWarningFmt(IProgress<IMessage>, string, FormattableString, object)

Templated UnsupportedWarning(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void UnsupportedWarningFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

ValidationError(IProgress<IMessage>, string, string, object)

Reports Validation + Error (manufacturing/physics is unfeasible).

public static void ValidationError(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

ValidationErrorFmt(IProgress<IMessage>, string, FormattableString, object)

Templated ValidationError(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void ValidationErrorFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object

ValidationWarning(IProgress<IMessage>, string, string, object)

Reports Validation + Warning (manufacturing/physics may be unfeasible).

public static void ValidationWarning(this IProgress<IMessage> host, string id, string text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text string

detail object

ValidationWarningFmt(IProgress<IMessage>, string, FormattableString, object)

Templated ValidationWarning(IProgress<IMessage>, string, string, object) — keeps format + args for localization.

public static void ValidationWarningFmt(this IProgress<IMessage> host, string id, FormattableString text, object detail = null)

Parameters

host IProgress<IMessage>

id string

text FormattableString

detail object