lmxopcua/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IAddressSpaceBuilder.cs

namespace ZB.MOM.WW.OtOpcUa.Core.Abstractions;

/// <summary>
///     Streaming builder API a driver uses to register OPC UA nodes during discovery.
///     Core owns the tree; driver streams <c>AddFolder</c> / <c>AddVariable</c> calls
///     as it discovers nodes — no buffering of the whole tree.
/// </summary>
/// <remarks>
///     Drivers register nodes via this builder rather than returning a tree object,
///     supporting incremental / large address spaces without forcing the driver to
///     buffer the whole tree.
/// </remarks>
public interface IAddressSpaceBuilder
{
    /// <summary>
    ///     Add a folder node. Returns a child builder scoped to inside this folder, so subsequent
    ///     calls on the child place nodes under it.
    /// </summary>
    /// <param name="browseName">OPC UA browse name (the segment of the path under the parent).</param>
    /// <param name="displayName">Human-readable display name. May equal <paramref name="browseName"/>.</param>
    /// <returns>A child builder scoped to inside the new folder.</returns>
    IAddressSpaceBuilder Folder(string browseName, string displayName);

    /// <summary>
    ///     Add a variable node corresponding to a tag. Driver-side full reference + data-type
    ///     metadata come from the <see cref="DriverAttributeInfo"/> DTO.
    /// </summary>
    /// <param name="browseName">OPC UA browse name (the segment of the path under the parent folder).</param>
    /// <param name="displayName">Human-readable display name. May equal <paramref name="browseName"/>.</param>
    /// <param name="attributeInfo">Driver-side metadata for the variable.</param>
    /// <returns>A handle for the registered variable, used by Core for subscription routing.</returns>
    IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo attributeInfo);

    /// <summary>
    ///     Add a property to the current node (folder or variable). Properties are static metadata
    ///     read once at build time (e.g. OPC 40010 Identification fields per the schemas-repo
    ///     <c>_base</c> equipment-class template).
    /// </summary>
    /// <param name="browseName">The property browse name.</param>
    /// <param name="dataType">The property data type.</param>
    /// <param name="value">The property value.</param>
    void AddProperty(string browseName, DriverDataType dataType, object? value);
}

/// <summary>Opaque handle for a registered variable. Used by Core for subscription routing.</summary>
public interface IVariableHandle
{
    /// <summary>Driver-side full reference for read/write addressing.</summary>
    string FullReference { get; }

    /// <summary>
    ///     Annotate this variable with an OPC UA <c>AlarmConditionState</c>. Drivers with
    ///     <see cref="DriverAttributeInfo.IsAlarm"/> = true call this during discovery so the
    ///     concrete address-space builder can materialize a sibling condition node. The returned
    ///     sink receives lifecycle transitions raised through <see cref="IAlarmSource.OnAlarmEvent"/>
    ///     — the generic node manager wires the subscription; the concrete builder decides how
    ///     to surface the state (e.g. OPC UA <c>AlarmConditionState.Activate</c>,
    ///     <c>Acknowledge</c>, <c>Deactivate</c>).
    /// </summary>
    /// <param name="info">The alarm condition information.</param>
    /// <returns>The sink that receives lifecycle transitions for this alarm condition.</returns>
    IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info);
}

/// <summary>
///     Metadata used to materialize an OPC UA <c>AlarmConditionState</c> sibling for a variable.
///     Populated by the driver's discovery step; concrete builders decide how to surface it.
/// </summary>
/// <param name="SourceName">Human-readable alarm name used for the <c>SourceName</c> event field.</param>
/// <param name="InitialSeverity">Severity at address-space build time; updates arrive via <see cref="IAlarmConditionSink"/>.</param>
/// <param name="InitialDescription">Initial description; updates arrive via <see cref="IAlarmConditionSink"/>.</param>
/// <param name="InAlarmRef">
///     Driver-side full reference for the boolean attribute that toggles when the
///     alarm condition becomes active. Consumed by the server-level alarm-condition
///     service to subscribe to active/inactive transitions. Null when the driver
///     reports alarm transitions through some other channel.
/// </param>
/// <param name="PriorityRef">
///     Driver-side full reference for the integer attribute carrying the alarm's
///     current priority / severity. Live updates flow through the same subscription
///     pipeline as <paramref name="InAlarmRef"/>. Null when the driver does not
///     expose live priority changes.
/// </param>
/// <param name="DescAttrNameRef">
///     Driver-side full reference for the string attribute carrying the human-readable
///     description / message. Null when the driver does not expose a live description.
/// </param>
/// <param name="AckedRef">
///     Driver-side full reference for the boolean attribute that toggles when the
///     alarm is acknowledged. Null when acknowledgement is not observable on the
///     driver side.
/// </param>
/// <param name="AckMsgWriteRef">
///     Driver-side full reference the server writes to acknowledge the condition,
///     typically the alarm's <c>.AckMsg</c> attribute. Null when the driver does not
///     accept acknowledgement writes (or routes them through a separate API).
/// </param>
public sealed record AlarmConditionInfo(
    string SourceName,
    AlarmSeverity InitialSeverity,
    string? InitialDescription,
    string? InAlarmRef = null,
    string? PriorityRef = null,
    string? DescAttrNameRef = null,
    string? AckedRef = null,
    string? AckMsgWriteRef = null);

/// <summary>
///     Sink a concrete address-space builder returns from <see cref="IVariableHandle.MarkAsAlarmCondition"/>.
///     The generic node manager routes per-alarm <see cref="IAlarmSource.OnAlarmEvent"/> payloads here —
///     the sink translates the transition into an OPC UA condition state change or whatever the
///     concrete builder's backing address space supports.
/// </summary>
public interface IAlarmConditionSink
{
    /// <summary>Push an alarm transition (Active / Acknowledged / Inactive) for this condition.</summary>
    /// <param name="args">The alarm event arguments.</param>
    void OnTransition(AlarmEventArgs args);
}