Class ScanComponentResult

Namespace

Acuit.Pinpoint.Workstation.Messaging

Assembly

Acuit.Pinpoint.Workstation.Abstractions.dll

The result of a component scan request.

public class ScanComponentResult

Inheritance

object

ScanComponentResult

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ScanComponentResult()

public ScanComponentResult()

Properties

Canceled

Gets a ScanComponentResult indicating that the scan was canceled.

public static ScanComponentResult Canceled { get; }

Property Value

ScanComponentResult

IsCanceled

Gets whether the component scan was canceled. The scan will be canceled if the operator cancels or skips the scan, or if the scan is cancelled via CancellationToken.

public bool IsCanceled { get; }

Property Value

bool

ReasonInvalid

Gets the reason that the component is invalid, if it is invalid.

public string? ReasonInvalid { get; }

Property Value

string

UnitComponent

Gets the unit component information, or null if the scan was canceled.

public UnitComponent? UnitComponent { get; }

Property Value

UnitComponent

Methods

Create(UnitComponent, string?)

Creates a ScanComponentResult instance for a component scan result.

public static ScanComponentResult Create(UnitComponent unitComponent, string? reasonInvalid)

Parameters

unitComponent UnitComponent

The unit component information.

reasonInvalid string

The reason that the component is invalid, if it is invalid.

Returns

ScanComponentResult

A new ScanComponentResult instance.

Exceptions

ArgumentNullException

unitComponent is null.