Class ReleaseUnitMessage

Namespace

Acuit.Pinpoint.Workstation.Messaging

Assembly

Acuit.Pinpoint.Workstation.Abstractions.dll

The message raised by the IMessenger service when the operator initiates releasing the unit at the station.

public class ReleaseUnitMessage : WorkstationRequestMessage<Task<bool>>, IWorkstationRequestMessage

Inheritance

object

RequestMessage<Task<bool>>

WorkstationRequestMessage<Task<bool>>

ReleaseUnitMessage

Implements

IWorkstationRequestMessage

Inherited Members

RequestMessage<Task<bool>>.Reply(Task<bool>)

RequestMessage<Task<bool>>.Response

RequestMessage<Task<bool>>.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 there is a unit at the station (which implies that the station is not automated) as follows:

1. Send the UnitReleasingMessage message. If any recipient cancels the release, the following steps will not occur and the unit will not be released.
2. Release the unit via UnitReleased3(string, int), displaying an error message if there is an error.
3. Display any alarm messages, workflow errors, or alerts returned from Acuit Pinpoint.
4. Send the UnitReleasedMessage message.

The message Response will contain a task object representing the asynchronous operation. Once the operation completes, the Result property on the task object contains true if the unit was released; otherwise, it will contain false (e.g., a unit is at the station and something like a test in progress prevents the unit from being released).

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

ReleaseUnitMessage()

public ReleaseUnitMessage()