feat(uns): S7/AbCip/AbLegacy/TwinCAT/Focas typed tag-config editors (F-uns-1 T4-T8)

2026-06-09 09:42:40 -04:00
parent 5990b673cc
commit 75021fa2c9
15 changed files with 860 additions and 0 deletions
@@ -0,0 +1,48 @@
+using System.Text.Json.Nodes;
+using ZB.MOM.WW.OtOpcUa.Driver.AbCip;
+
+namespace ZB.MOM.WW.OtOpcUa.AdminUI.Uns.TagEditors;
+
+/// <summary>Typed working model for an AB CIP / EtherNet-IP tag's TagConfig JSON (the driver-specific addressing/encoding
+/// fields; name/writable live on the Tag entity). Preserves unrecognised JSON keys across a load→save.</summary>
+public sealed class AbCipTagConfigModel
+{
+    /// <summary>Which device (<c>AbCipDeviceOptions.HostAddress</c>) this tag lives on. Optional.</summary>
+    public string DeviceHostAddress { get; set; } = "";
+
+    /// <summary>Logix symbolic path (controller or program scope). Required.</summary>
+    public string TagPath { get; set; } = "";
+
+    /// <summary>Logix atomic type, or <c>AbCipDataType.Structure</c> for UDT-typed tags.</summary>
+    public AbCipDataType DataType { get; set; } = AbCipDataType.DInt;
+
+    private JsonObject _bag = new();
+
+    /// <summary>Loads a model from a TagConfig JSON string, defaulting any absent field and retaining
+    /// every original key (so fields this editor doesn't expose survive a load→save).</summary>
+    public static AbCipTagConfigModel FromJson(string? json)
+    {
+        var o = TagConfigJson.ParseOrNew(json);
+        return new AbCipTagConfigModel
+        {
+            DeviceHostAddress = TagConfigJson.GetString(o, "deviceHostAddress") ?? "",
+            TagPath = TagConfigJson.GetString(o, "tagPath") ?? "",
+            DataType = TagConfigJson.GetEnum(o, "dataType", AbCipDataType.DInt),
+            _bag = o,
+        };
+    }
+
+    /// <summary>Serialises this model back to a TagConfig JSON string, writing the exposed fields
+    /// (enum as its name string; the optional host address omitted when blank) over the preserved key bag.</summary>
+    public string ToJson()
+    {
+        TagConfigJson.Set(_bag, "deviceHostAddress", string.IsNullOrWhiteSpace(DeviceHostAddress) ? null : DeviceHostAddress.Trim());
+        TagConfigJson.Set(_bag, "tagPath", TagPath.Trim());
+        TagConfigJson.Set(_bag, "dataType", DataType);
+        return TagConfigJson.Serialize(_bag);
+    }
+
+    /// <summary>Validation hook; returns an error message or null when the model is valid.</summary>
+    public string? Validate()
+        => string.IsNullOrWhiteSpace(TagPath) ? "Tag path is required." : null;
+}
@@ -0,0 +1,48 @@
+using System.Text.Json.Nodes;
+using ZB.MOM.WW.OtOpcUa.Driver.AbLegacy;
+
+namespace ZB.MOM.WW.OtOpcUa.AdminUI.Uns.TagEditors;
+
+/// <summary>Typed working model for an AB Legacy (PCCC) tag's TagConfig JSON (the driver-specific addressing/encoding
+/// fields; name/writable live on the Tag entity). Preserves unrecognised JSON keys across a load→save.</summary>
+public sealed class AbLegacyTagConfigModel
+{
+    /// <summary>Which device (<c>AbLegacyDeviceOptions.HostAddress</c>) this tag lives on. Optional.</summary>
+    public string DeviceHostAddress { get; set; } = "";
+
+    /// <summary>Canonical PCCC file-address string, e.g. <c>N7:0</c>, <c>B3:0/0</c>. Required.</summary>
+    public string Address { get; set; } = "";
+
+    /// <summary>PCCC data type that maps onto SLC / MicroLogix / PLC-5 files.</summary>
+    public AbLegacyDataType DataType { get; set; } = AbLegacyDataType.Int;
+
+    private JsonObject _bag = new();
+
+    /// <summary>Loads a model from a TagConfig JSON string, defaulting any absent field and retaining
+    /// every original key (so fields this editor doesn't expose survive a load→save).</summary>
+    public static AbLegacyTagConfigModel FromJson(string? json)
+    {
+        var o = TagConfigJson.ParseOrNew(json);
+        return new AbLegacyTagConfigModel
+        {
+            DeviceHostAddress = TagConfigJson.GetString(o, "deviceHostAddress") ?? "",
+            Address = TagConfigJson.GetString(o, "address") ?? "",
+            DataType = TagConfigJson.GetEnum(o, "dataType", AbLegacyDataType.Int),
+            _bag = o,
+        };
+    }
+
+    /// <summary>Serialises this model back to a TagConfig JSON string, writing the exposed fields
+    /// (enum as its name string; the optional host address omitted when blank) over the preserved key bag.</summary>
+    public string ToJson()
+    {
+        TagConfigJson.Set(_bag, "deviceHostAddress", string.IsNullOrWhiteSpace(DeviceHostAddress) ? null : DeviceHostAddress.Trim());
+        TagConfigJson.Set(_bag, "address", Address.Trim());
+        TagConfigJson.Set(_bag, "dataType", DataType);
+        return TagConfigJson.Serialize(_bag);
+    }
+
+    /// <summary>Validation hook; returns an error message or null when the model is valid.</summary>
+    public string? Validate()
+        => string.IsNullOrWhiteSpace(Address) ? "Address is required." : null;
+}
@@ -0,0 +1,48 @@
+using System.Text.Json.Nodes;
+using ZB.MOM.WW.OtOpcUa.Driver.FOCAS;
+
+namespace ZB.MOM.WW.OtOpcUa.AdminUI.Uns.TagEditors;
+
+/// <summary>Typed working model for a FOCAS (FANUC CNC) tag's TagConfig JSON (the driver-specific addressing/encoding
+/// fields; name/writable live on the Tag entity). Preserves unrecognised JSON keys across a load→save.</summary>
+public sealed class FocasTagConfigModel
+{
+    /// <summary>Which device (<c>FocasDeviceOptions.HostAddress</c>) this tag lives on. Optional.</summary>
+    public string DeviceHostAddress { get; set; } = "";
+
+    /// <summary>Canonical FOCAS address string, e.g. <c>X0.0</c>, <c>R100</c>, <c>PARAM:1815/0</c>, <c>MACRO:500</c>. Required.</summary>
+    public string Address { get; set; } = "";
+
+    /// <summary>FOCAS atomic data type.</summary>
+    public FocasDataType DataType { get; set; } = FocasDataType.Int32;
+
+    private JsonObject _bag = new();
+
+    /// <summary>Loads a model from a TagConfig JSON string, defaulting any absent field and retaining
+    /// every original key (so fields this editor doesn't expose survive a load→save).</summary>
+    public static FocasTagConfigModel FromJson(string? json)
+    {
+        var o = TagConfigJson.ParseOrNew(json);
+        return new FocasTagConfigModel
+        {
+            DeviceHostAddress = TagConfigJson.GetString(o, "deviceHostAddress") ?? "",
+            Address = TagConfigJson.GetString(o, "address") ?? "",
+            DataType = TagConfigJson.GetEnum(o, "dataType", FocasDataType.Int32),
+            _bag = o,
+        };
+    }
+
+    /// <summary>Serialises this model back to a TagConfig JSON string, writing the exposed fields
+    /// (enum as its name string; the optional host address omitted when blank) over the preserved key bag.</summary>
+    public string ToJson()
+    {
+        TagConfigJson.Set(_bag, "deviceHostAddress", string.IsNullOrWhiteSpace(DeviceHostAddress) ? null : DeviceHostAddress.Trim());
+        TagConfigJson.Set(_bag, "address", Address.Trim());
+        TagConfigJson.Set(_bag, "dataType", DataType);
+        return TagConfigJson.Serialize(_bag);
+    }
+
+    /// <summary>Validation hook; returns an error message or null when the model is valid.</summary>
+    public string? Validate()
+        => string.IsNullOrWhiteSpace(Address) ? "Address is required." : null;
+}
@@ -0,0 +1,48 @@
+using System.Text.Json.Nodes;
+using ZB.MOM.WW.OtOpcUa.Driver.S7;
+
+namespace ZB.MOM.WW.OtOpcUa.AdminUI.Uns.TagEditors;
+
+/// <summary>Typed working model for a Siemens S7 tag's TagConfig JSON (the driver-specific addressing/encoding
+/// fields; name/writable live on the Tag entity). Preserves unrecognised JSON keys across a load→save.</summary>
+public sealed class S7TagConfigModel
+{
+    /// <summary>S7 address string, e.g. <c>DB1.DBW0</c>, <c>M0.0</c>, <c>I0.0</c>, <c>QD4</c>. Required.</summary>
+    public string Address { get; set; } = "";
+
+    /// <summary>Logical data type — drives the underlying S7.Net read/write width.</summary>
+    public S7DataType DataType { get; set; } = S7DataType.Int16;
+
+    /// <summary>For <c>DataType = String</c>: S7-string max length (max 254).</summary>
+    public int StringLength { get; set; }
+
+    private JsonObject _bag = new();
+
+    /// <summary>Loads a model from a TagConfig JSON string, defaulting any absent field and retaining
+    /// every original key (so fields this editor doesn't expose survive a load→save).</summary>
+    public static S7TagConfigModel FromJson(string? json)
+    {
+        var o = TagConfigJson.ParseOrNew(json);
+        return new S7TagConfigModel
+        {
+            Address = TagConfigJson.GetString(o, "address") ?? "",
+            DataType = TagConfigJson.GetEnum(o, "dataType", S7DataType.Int16),
+            StringLength = TagConfigJson.GetInt(o, "stringLength"),
+            _bag = o,
+        };
+    }
+
+    /// <summary>Serialises this model back to a TagConfig JSON string, writing the exposed fields
+    /// (enum as its name string) over the preserved key bag.</summary>
+    public string ToJson()
+    {
+        TagConfigJson.Set(_bag, "address", Address.Trim());
+        TagConfigJson.Set(_bag, "dataType", DataType);
+        TagConfigJson.Set(_bag, "stringLength", StringLength);
+        return TagConfigJson.Serialize(_bag);
+    }
+
+    /// <summary>Validation hook; returns an error message or null when the model is valid.</summary>
+    public string? Validate()
+        => string.IsNullOrWhiteSpace(Address) ? "Address is required." : null;
+}
@@ -0,0 +1,48 @@
+using System.Text.Json.Nodes;
+using ZB.MOM.WW.OtOpcUa.Driver.TwinCAT;
+
+namespace ZB.MOM.WW.OtOpcUa.AdminUI.Uns.TagEditors;
+
+/// <summary>Typed working model for a TwinCAT ADS tag's TagConfig JSON (the driver-specific addressing/encoding
+/// fields; name/writable live on the Tag entity). Preserves unrecognised JSON keys across a load→save.</summary>
+public sealed class TwinCATTagConfigModel
+{
+    /// <summary>Which device (<c>TwinCATDeviceOptions.HostAddress</c>) this tag lives on. Optional.</summary>
+    public string DeviceHostAddress { get; set; } = "";
+
+    /// <summary>Full TwinCAT symbolic name, e.g. <c>MAIN.bStart</c>, <c>GVL.Counter</c>. Required.</summary>
+    public string SymbolPath { get; set; } = "";
+
+    /// <summary>TwinCAT / IEC 61131-3 atomic data type.</summary>
+    public TwinCATDataType DataType { get; set; } = TwinCATDataType.DInt;
+
+    private JsonObject _bag = new();
+
+    /// <summary>Loads a model from a TagConfig JSON string, defaulting any absent field and retaining
+    /// every original key (so fields this editor doesn't expose survive a load→save).</summary>
+    public static TwinCATTagConfigModel FromJson(string? json)
+    {
+        var o = TagConfigJson.ParseOrNew(json);
+        return new TwinCATTagConfigModel
+        {
+            DeviceHostAddress = TagConfigJson.GetString(o, "deviceHostAddress") ?? "",
+            SymbolPath = TagConfigJson.GetString(o, "symbolPath") ?? "",
+            DataType = TagConfigJson.GetEnum(o, "dataType", TwinCATDataType.DInt),
+            _bag = o,
+        };
+    }
+
+    /// <summary>Serialises this model back to a TagConfig JSON string, writing the exposed fields
+    /// (enum as its name string; the optional host address omitted when blank) over the preserved key bag.</summary>
+    public string ToJson()
+    {
+        TagConfigJson.Set(_bag, "deviceHostAddress", string.IsNullOrWhiteSpace(DeviceHostAddress) ? null : DeviceHostAddress.Trim());
+        TagConfigJson.Set(_bag, "symbolPath", SymbolPath.Trim());
+        TagConfigJson.Set(_bag, "dataType", DataType);
+        return TagConfigJson.Serialize(_bag);
+    }
+
+    /// <summary>Validation hook; returns an error message or null when the model is valid.</summary>
+    public string? Validate()
+        => string.IsNullOrWhiteSpace(SymbolPath) ? "Symbol path is required." : null;
+}