Class UnitReleasingMessage

Namespace

Acuit.Pinpoint.Workstation.Messaging

Assembly

Acuit.Pinpoint.Workstation.Abstractions.dll

The message raised by the IMessenger service when a unit is potentially about to be released from a manned (non-automated) station.

public class UnitReleasingMessage : UnitEventMessage, IAsyncHandlingMessage, ICancelMessage

Inheritance

object

UnitEventMessage

UnitReleasingMessage

Implements

IAsyncHandlingMessage

ICancelMessage

Inherited Members

UnitEventMessage.UnitAtStation

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This message allows the unit release to be canceled before the unit release is sent to Acuit Pinpoint. The UnitReleasedMessage message should be used to know when the unit is actually released.

Constructors

UnitReleasingMessage(IUnitAtStation, CancellationToken)

Initializes a new instance of the UnitReleasingMessage class.

public UnitReleasingMessage(IUnitAtStation unitAtStation, CancellationToken cancellationToken)

Parameters

unitAtStation IUnitAtStation

The IUnitAtStation representing the unit at the station.

cancellationToken CancellationToken

A token that can request cancellation of asynchronous handlers.

Exceptions

ArgumentNullException

unitAtStation is null.

Properties

AsyncHandlers

Gets the AsyncHandlers instance to which asynchronous handlers can be added.

public AsyncHandlers AsyncHandlers { get; }

Property Value

AsyncHandlers

Cancel

Gets or sets whether to cancel the unit release.

public bool Cancel { get; set; }

Property Value

bool