feat: 增加浏览功能

Author: ArgoZhang

src/extensions/BootstrapBlazor.OpcDa/Extensions/Extensions.cs

@@ -24,4 +24,15 @@ public static IOpcSubscription ToOpcSubscription(this ISubscription subscription
     }
 
     public static ISubscription CreateSubscription(this Server server, string name, int updateRate = 1000, bool active = true) => server.CreateSubscription(new SubscriptionState { Name = name, Deadband = 0, UpdateRate = updateRate, Active = active });
+
+    public static BrowseFilters ToFilters(this OpcBrowseFilters filtes)
+    {
+        return new BrowseFilters
+        {
+            ReturnAllProperties = filtes.ReturnAllProperties,
+            ReturnPropertyValues = filtes.ReturnPropertyValues,
+            MaxElementsReturned = filtes.MaxElementsReturned,
+            ElementNameFilter = filtes.ElementNameFilter
+        };
+    }
 }

src/extensions/BootstrapBlazor.OpcDa/IOpcDaServer.cs

@@ -69,12 +69,12 @@ public interface IOpcDaServer : IDisposable
     /// <param name="filters"></param>
     /// <param name="position"></param>
     /// <returns></returns>
-    BrowseElement[] Browser(string name, BrowseFilters filters, out BrowsePosition position);
+    OpcBrowseElement[] Browse(string name, OpcBrowseFilters filters, out OpcBrowsePosition position);
 
     /// <summary>
     /// 浏览 OPC Server 中的位号 (即数据项或者标签)
     /// </summary>
     /// <param name="position"></param>
     /// <returns></returns>
-    BrowseElement[] BrowserNext(ref BrowsePosition position);
+    OpcBrowseElement[] BrowseNext(OpcBrowsePosition position);
 }

src/extensions/BootstrapBlazor.OpcDa/Mock/MockOpcDaServer.cs

@@ -2,6 +2,8 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 // Website: https://www.blazor.zone or https://argozhang.github.io/
 
+using Opc.Da;
+
 namespace BootstrapBlazor.OpcDa;
 
 /// <summary>
@@ -61,6 +63,29 @@ public HashSet<OpcWriteItem> Write(params HashSet<OpcWriteItem> items)
                     .ToHashSet(OpcItemEqualityComparer<OpcWriteItem>.Default);
     }
 
+    /// <summary>
+    /// 浏览 OPC Server 中的位号 (即数据项或者标签)
+    /// </summary>
+    /// <param name="name"></param>
+    /// <param name="filters"></param>
+    /// <param name="position"></param>
+    /// <returns></returns>
+    public OpcBrowseElement[] Browse(string name, OpcBrowseFilters filters, out OpcBrowsePosition? position)
+    {
+        position = null;
+        return [];
+    }
+
+    /// <summary>
+    /// 浏览 OPC Server 中的位号 (即数据项或者标签)
+    /// </summary>
+    /// <param name="position"></param>
+    /// <returns></returns>
+    public OpcBrowseElement[] BrowseNext(OpcBrowsePosition position)
+    {
+        return [];
+    }
+
     public void Dispose()
     {
 

src/extensions/BootstrapBlazor.OpcDa/OpcBrowseElement.cs

@@ -0,0 +1,35 @@
+// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+// Website: https://www.blazor.zone or https://argozhang.github.io/
+
+using Opc.Da;
+
+namespace BootstrapBlazor.OpcDa;
+
+/// <summary>
+/// 对 OpcDataServer BrowseElement 的封装类
+/// </summary>
+public class OpcBrowseElement
+{
+    /// <summary>
+    /// 获得/设置 节点名称
+    /// </summary>
+    public string Name => _element.Name;
+
+    /// <summary>
+    /// 获得/设置 是否是数据项
+    /// </summary>
+    public bool IsItem => _element.IsItem;
+
+    /// <summary>
+    /// 获得/设置 是否有子节点
+    /// </summary>
+    public bool HasChildren => _element.HasChildren;
+
+    internal OpcBrowseElement(BrowseElement element)
+    {
+        _element = element;
+    }
+
+    private readonly BrowseElement _element;
+}

src/extensions/BootstrapBlazor.OpcDa/OpcBrowseFilters.cs

@@ -0,0 +1,31 @@
+// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+// Website: https://www.blazor.zone or https://argozhang.github.io/
+
+namespace BootstrapBlazor.OpcDa;
+
+/// <summary>
+/// 对 OpcDataServer BrowseFilters 的封装类
+/// </summary>
+public class OpcBrowseFilters
+{
+    /// <summary>
+    /// 获得/设置 最大返回节点数量
+    /// </summary>
+    public int MaxElementsReturned { get; set; }
+
+    /// <summary>
+    /// 获得/设置 元素名称过滤器
+    /// </summary>
+    public string? ElementNameFilter { get; set; }
+
+    /// <summary>
+    /// 获得/设置 是否返回所有属性
+    /// </summary>
+    public bool ReturnAllProperties { get; set; }
+
+    /// <summary>
+    /// 获得/设置 是否返回属性值
+    /// </summary>
+    public bool ReturnPropertyValues { get; set; }
+}

src/extensions/BootstrapBlazor.OpcDa/OpcBrowsePosition.cs

@@ -0,0 +1,18 @@
+// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+// Website: https://www.blazor.zone or https://argozhang.github.io/
+
+namespace BootstrapBlazor.OpcDa;
+
+/// <summary>
+/// 对 OpcDataServer BrowsePosition 的封装类
+/// </summary>
+public class OpcBrowsePosition
+{
+    internal OpcBrowsePosition(Opc.Da.BrowsePosition position)
+    {
+        Position = position;
+    }
+
+    internal Opc.Da.BrowsePosition Position { get; set; }
+}

src/extensions/BootstrapBlazor.OpcDa/OpcDaServer.cs

@@ -55,30 +55,32 @@ public bool Connect(string serverName)
     /// <param name="filters"></param>
     /// <param name="position"></param>
     /// <returns></returns>
-    public BrowseElement[] Browser(string name, BrowseFilters filters, out BrowsePosition position)
+    public OpcBrowseElement[] Browse(string name, OpcBrowseFilters filters, out OpcBrowsePosition position)
     {
         if (_server is not { IsConnected: true })
         {
             throw new InvalidOperationException("OPC Server is not connected.");
         }
 
-        return _server.Browse(new ItemIdentifier(name), filters, out position);
+        var results = _server.Browse(new ItemIdentifier(name), filters.ToFilters(), out var pos);
+        position = new OpcBrowsePosition(pos);
+        return results.Select(element => new OpcBrowseElement(element)).ToArray();
     }
 
     /// <summary>
     /// <inheritdoc/>
     /// </summary>
     /// <param name="position"></param>
     /// <returns></returns>
-    public BrowseElement[] BrowserNext(ref BrowsePosition position)
+    public OpcBrowseElement[] BrowseNext(OpcBrowsePosition position)
     {
         if (_server is not { IsConnected: true })
         {
             throw new InvalidOperationException("OPC Server is not connected.");
         }
 
-
-        return _server.BrowseNext(ref position);
+        var pos = position.Position;
+        return _server.BrowseNext(ref pos).Select(element => new OpcBrowseElement(element)).ToArray();
     }
 
     /// <summary>