Class RemoveComponentMessage

Namespace

Acuit.Pinpoint.Workstation.Messaging

Assembly

Acuit.Pinpoint.Workstation.Abstractions.dll

The message raised by the IMessenger service when the operator initiates removing a component from the unit at the station.

public class RemoveComponentMessage : WorkstationRequestMessage<ComponentStatus?>, IWorkstationRequestMessage

Inheritance

object

RequestMessage<ComponentStatus>

WorkstationRequestMessage<ComponentStatus>

RemoveComponentMessage

Implements

IWorkstationRequestMessage

Inherited Members

RequestMessage<ComponentStatus>.Reply(ComponentStatus)

RequestMessage<ComponentStatus>.Response

RequestMessage<ComponentStatus>.HasReceivedResponse

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

By default, Acuit Pinpoint Workstation will handle this message when a unit is at the station and ComponentTypeName matches a component that can be scanned at the station by getting confirmation from the operator and then removing the component, displaying any error message reported by Acuit Pinpoint while attempting to remove the component.

If the component was removed, the message Response will contain a ComponentStatus representing the component removal; otherwise, it will contain null (i.e., the operator did not confirm or an error occurred).

A plug-in can customize the default behavior by registering a recipient for this message. To suppress the default behavior, the plug-in should use Reply(T) to set the response to the message.

A plug-in can emulate the operator action that this message represents by sending this message.

Constructors

RemoveComponentMessage(string)

Initializes a new instance of the RemoveComponentMessage class.

public RemoveComponentMessage(string componentTypeName)

Parameters

componentTypeName string

The component type name.

Exceptions

ArgumentNullException

componentTypeName is null.

Properties

ComponentTypeName

Gets the component type name.

public string ComponentTypeName { get; }

Property Value

string