Joseph Doherty
18 lines
813 B
C#
18 lines
813 B
C#
using System;
|
|
|
|
namespace ZB.MOM.WW.MxGateway.Worker.MxAccess;
|
|
|
|
/// <summary>
|
|
/// Acknowledges an alarm by writing its MXAccess ack item (<c>AckMsg</c>)
|
|
/// after authenticating as the operator. Must be called on the worker STA.
|
|
/// </summary>
|
|
public interface IAlarmAckWriter : IDisposable
|
|
{
|
|
/// <summary>Authenticates <paramref name="ackOperator"/> and writes <paramref name="comment"/> to <paramref name="itemAddress"/>.</summary>
|
|
/// <param name="itemAddress">The ack item, e.g. <c>Obj.Alarm.AckMsg</c>.</param>
|
|
/// <param name="comment">The acknowledgement comment.</param>
|
|
/// <param name="ackOperator">The operator to authenticate as.</param>
|
|
/// <returns>The outcome.</returns>
|
|
AlarmAckResult Acknowledge(string itemAddress, string comment, AlarmAckOperator ackOperator);
|
|
}
|