refactor(ablegacy): confine libplctag to its adapter behind AbStatus/AbTransportException

src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/AbLegacyStatusMapper.cs

@@ -1,9 +1,9 @@
-using libplctag;
+using ZB.MOM.WW.OtOpcUa.Driver.Ab.Transport;
 
 namespace ZB.MOM.WW.OtOpcUa.Driver.AbLegacy;
 
 /// <summary>
-///     Maps libplctag status codes + PCCC STS/EXT_STS bytes to OPC UA StatusCodes. Mirrors the
+///     Maps transport status codes + PCCC STS/EXT_STS bytes to OPC UA StatusCodes. Mirrors the
 ///     AbCip mapper — PCCC errors roughly align with CIP general-status in shape but with a
 ///     different byte vocabulary (PCCC STS nibble-low + EXT_STS on code 0x0F).
 /// </summary>
@@ -22,44 +22,41 @@ public static class AbLegacyStatusMapper
     public const uint BadTypeMismatch = 0x80740000u;
 
     /// <summary>
-    ///     Map a libplctag return/status code to an OPC UA StatusCode. The integer passed here
-    ///     is <c>(int)Tag.GetStatus()</c> — the underlying value of the libplctag.NET
-    ///     <see cref="Status"/> enum. Delegates to the strongly-typed overload so the mapping
-    ///     stays correct regardless of how the wrapper renumbers native PLCTAG_ERR_* constants
-    ///     in future releases.
+    ///     Map the integer form of an <see cref="AbStatus"/> (what <see cref="IAbLegacyTagRuntime.GetStatus"/>
+    ///     returns) to an OPC UA StatusCode.
     /// </summary>
-    /// <param name="status">The integer status code from libplctag.</param>
+    /// <param name="status">The integer transport status.</param>
     /// <returns>The corresponding OPC UA status code.</returns>
-    public static uint MapLibplctagStatus(int status) => MapLibplctagStatus((Status)status);
+    public static uint MapStatus(int status) => MapStatus((AbStatus)status);
 
-    /// <summary>
-    ///     Map a libplctag.NET <see cref="Status"/> enum value to an OPC UA StatusCode. This is
-    ///     the canonical core; the <c>int</c> overload exists only for the
-    ///     <see cref="IAbLegacyTagRuntime.GetStatus"/> seam which boxes the enum as an int.
-    /// </summary>
-    /// <param name="status">The libplctag Status enum value.</param>
+    /// <summary>Map a transport-neutral <see cref="AbStatus"/> to an OPC UA StatusCode.</summary>
+    /// <param name="status">The transport status.</param>
     /// <returns>The corresponding OPC UA status code.</returns>
-    public static uint MapLibplctagStatus(Status status) => status switch
+    public static uint MapStatus(AbStatus status) => status switch
     {
-        Status.Ok => Good,
-        Status.Pending => GoodMoreData,
-        Status.ErrorTimeout => BadTimeout,
-        Status.ErrorNotFound or Status.ErrorNoMatch or Status.ErrorBadDevice => BadNodeIdUnknown,
-        Status.ErrorNotAllowed => BadNotWritable,
-        Status.ErrorOutOfBounds or Status.ErrorTooLarge or Status.ErrorTooSmall => BadOutOfRange,
-        Status.ErrorUnsupported or Status.ErrorNotImplemented => BadNotSupported,
-        Status.ErrorBadConnection or Status.ErrorBadGateway or Status.ErrorBadReply
-            or Status.ErrorWinsock or Status.ErrorOpen or Status.ErrorClose
-            or Status.ErrorRead or Status.ErrorWrite or Status.ErrorRemoteErr
-            or Status.ErrorPartial or Status.ErrorAbort => BadCommunicationError,
-        _ => BadCommunicationError,
+        AbStatus.Ok => Good,
+        AbStatus.Pending => GoodMoreData,
+        AbStatus.Timeout => BadTimeout,
+        AbStatus.NotFound => BadNodeIdUnknown,
+        AbStatus.NotAllowed => BadNotWritable,
+        AbStatus.OutOfBounds or AbStatus.TooLarge or AbStatus.TooSmall => BadOutOfRange,
+        AbStatus.Unsupported => BadNotSupported,
+        AbStatus.TypeMismatch => BadTypeMismatch,
+        AbStatus.DeviceStateConflict => BadDeviceFailure,
+        _ => BadCommunicationError, // BadConnection, BadReply, Partial, Abort
     };
 
+    /// <summary>Map an exception thrown by a transport to an OPC UA StatusCode.</summary>
+    /// <param name="ex">The exception.</param>
+    /// <returns>The mapped status for an <see cref="AbTransportException"/>, else BadCommunicationError.</returns>
+    public static uint MapException(Exception ex) =>
+        ex is AbTransportException ate ? MapStatus(ate.Status) : BadCommunicationError;
+
     /// <summary>
     ///     Map a PCCC STS (status) byte. Common codes per AB PCCC reference:
     ///     0x00 = success, 0x10 = illegal command, 0x20 = bad address, 0x30 = protected,
     ///     0x40 = programmer busy, 0x50 = file locked, 0xF0 = extended status follows.
-    ///     libplctag surfaces only its own <see cref="Status"/> enum rather than exposing
+    ///     the transports surface only an <see cref="AbStatus"/> rather than exposing
     ///     the raw STS byte, so this method is not wired into the current read/write path.
     ///     It is retained as the reference mapping for future PCCC-STS inspection.
     /// </summary>