Class ComponentScanResult

Namespace

Acuit.Pinpoint.Workstation

Assembly

Acuit.Pinpoint.Workstation.Interfaces.dll

The result of a component scan request.

public class ComponentScanResult

Inheritance

object

ComponentScanResult

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

ComponentScanResult(bool, string, UnitComponent, bool)

Initializes a new instance of the ComponentScanResult class.

public ComponentScanResult(bool isValid, string reasonInvalid, UnitComponent unitComponent, bool isCanceled)

Parameters

isValid bool

Whether a valid component scan exists, whether or not one occurred as a result of this component scan request.

reasonInvalid string

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

unitComponent UnitComponent

The unit component information if a new component scan was recorded, or null if one was not recorded.

isCanceled bool

Whether the component scan was canceled or skipped by the operator.

Properties

IsCanceled

Gets whether the component scan was canceled or skipped by the operator.

public bool IsCanceled { get; }

Property Value

bool

IsValid

Gets whether a valid component scan exists, whether or not one occurred as a result of this component scan request.

public bool IsValid { get; }

Property Value

bool

Remarks

If a new component scan occurred, this will be the same as the IsValid property of UnitComponent. If a component scan did not occur for any reason (e.g., a valid scan already exists when the SkipIfHaveValid option is set, or the component scan was canceled or skipped), this will reflect the last component scan result, if one exists, for the component.

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 if a new component scan was recorded, or null if one was not recorded.

public UnitComponent UnitComponent { get; }

Property Value

UnitComponent