feat: Extended the browse item with array-information.

chrisdutz · chrisdutz · commit 44680103c497 · 2024-07-12T17:30:07.000+02:00
diff --git a/plc4go/assets/testing/protocols/eip/DriverTestsuite.xml b/plc4go/assets/testing/protocols/eip/DriverTestsuite.xml
@@ -28,7 +28,7 @@
   <driver-name>eip</driver-name>
   <driver-parameters>
     <parameter>
-      <name>bigEndian</name>
+      <name>big-endian</name>
       <value>false</value>
     </parameter>
   </driver-parameters>
diff --git a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcBrowseItem.java b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcBrowseItem.java
@@ -21,6 +21,7 @@
 import org.apache.plc4x.java.api.model.PlcTag;
 import org.apache.plc4x.java.api.value.PlcValue;
 
+import java.util.List;
 import java.util.Map;
 
 public interface PlcBrowseItem {
@@ -50,6 +51,13 @@ public interface PlcBrowseItem {
      */
     boolean isSubscribable();
 
+    boolean isArray();
+
+    /**
+     * @return list of elements providing information about the array dimensions of this item.
+     */
+    List<PlcBrowseItemArrayInfo> getArrayInformation();
+
     /**
      * @return returns any children this item might have
      */
diff --git a/plc4j/drivers/ads/src/main/java/org/apache/plc4x/java/ads/protocol/AdsProtocolLogic.java b/plc4j/drivers/ads/src/main/java/org/apache/plc4x/java/ads/protocol/AdsProtocolLogic.java
@@ -505,13 +505,16 @@ public CompletableFuture<PlcBrowseResponse> browseWithInterceptor(PlcBrowseReque
                 options.put("size-in-bytes", new PlcUDINT(symbol.getSize()));
 
                 if (plc4xPlcValueType == org.apache.plc4x.java.api.types.PlcValueType.List) {
-                    List<ArrayInfo> arrayInfo = new ArrayList<>();
+                    List<ArrayInfo> arrayInfo = new ArrayList<>(dataType.getArrayInfo().size());
+                    List<PlcBrowseItemArrayInfo> itemArrayInfo = new ArrayList<>(dataType.getArrayInfo().size());
                     for (AdsDataTypeArrayInfo adsDataTypeArrayInfo : dataType.getArrayInfo()) {
                         arrayInfo.add(new DefaultArrayInfo(
                             (int) adsDataTypeArrayInfo.getLowerBound(), (int) adsDataTypeArrayInfo.getUpperBound()));
+                        itemArrayInfo.add(new DefaultPlcBrowseItemArrayInfo(
+                            adsDataTypeArrayInfo.getLowerBound(), adsDataTypeArrayInfo.getUpperBound()));
                     }
                     DefaultListPlcBrowseItem item = new DefaultListPlcBrowseItem(new SymbolicAdsTag(symbol.getName(), plc4xPlcValueType, arrayInfo), itemName,
-                        true, !symbol.getFlagReadOnly(), true, childMap, options);
+                        true, !symbol.getFlagReadOnly(), true, childMap, options, itemArrayInfo);
 
                     // Check if this item should be added to the result
                     if (interceptor.intercept(item)) {
@@ -571,17 +574,23 @@ protected List<PlcBrowseItem> getBrowseItems(String basePath, long baseGroupId,
             options.put("size-in-bytes", new PlcUDINT(childDataType.getSize()));
 
             if (plc4xPlcValueType == org.apache.plc4x.java.api.types.PlcValueType.List) {
-                List<ArrayInfo> arrayInfo = new ArrayList<>();
+                List<ArrayInfo> arrayInfo = new ArrayList<>(childDataType.getArrayInfo().size());
+                List<PlcBrowseItemArrayInfo> itemArrayInfo = new ArrayList<>(childDataType.getArrayInfo().size());
                 for (AdsDataTypeArrayInfo adsDataTypeArrayInfo : childDataType.getArrayInfo()) {
                     arrayInfo.add(new DefaultArrayInfo(
                         (int) adsDataTypeArrayInfo.getLowerBound(), (int) adsDataTypeArrayInfo.getUpperBound()));
+                    itemArrayInfo.add(new DefaultPlcBrowseItemArrayInfo(
+                        adsDataTypeArrayInfo.getLowerBound(), adsDataTypeArrayInfo.getUpperBound()));
                 }
                 // Add the type itself.
-                values.add(new DefaultListPlcBrowseItem(new SymbolicAdsTag(basePath + "." + child.getPropertyName(), plc4xPlcValueType, arrayInfo), itemName,
-                    true, parentWritable, true, childMap, options));
+                values.add(new DefaultListPlcBrowseItem(new SymbolicAdsTag(
+                    basePath + "." + child.getPropertyName(), plc4xPlcValueType, arrayInfo), itemName,
+                    true, parentWritable, true, childMap, options, itemArrayInfo));
             } else {
                 // Add the type itself.
-                values.add(new DefaultPlcBrowseItem(new SymbolicAdsTag(basePath + "." + child.getPropertyName(), plc4xPlcValueType, Collections.emptyList()), itemName,
+                values.add(new DefaultPlcBrowseItem(new SymbolicAdsTag(
+                    basePath + "." + child.getPropertyName(), plc4xPlcValueType,
+                    Collections.emptyList()), itemName,
                     true, parentWritable, true, childMap, options));
             }
         }
diff --git a/plc4j/drivers/ctrlx/src/main/java/org/apache/plc4x/java/ctrlx/readwrite/connection/CtrlXConnection.java b/plc4j/drivers/ctrlx/src/main/java/org/apache/plc4x/java/ctrlx/readwrite/connection/CtrlXConnection.java
@@ -261,7 +261,7 @@ public CompletableFuture<PlcBrowseResponse> browseWithInterceptor(PlcBrowseReque
                                 new DefaultListPlcBrowseItem(
                                     new CtrlXTag(curNode, PlcValueType.BOOL, Collections.emptyList()),
                                     curNode, true, true, true,
-                                    Collections.emptyMap(), Collections.emptyMap())));
+                                    Collections.emptyMap(), Collections.emptyMap(), Collections.emptyList())));
                         }
                     }
                     // If this node has children, then it's branch, and we need to add its children to the queue.
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/messages/DefaultListPlcBrowseItem.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/messages/DefaultListPlcBrowseItem.java
@@ -19,25 +19,41 @@
 package org.apache.plc4x.java.spi.messages;
 
 import org.apache.plc4x.java.api.messages.PlcBrowseItem;
+import org.apache.plc4x.java.api.messages.PlcBrowseItemArrayInfo;
 import org.apache.plc4x.java.api.model.PlcTag;
 import org.apache.plc4x.java.api.value.PlcValue;
 import org.apache.plc4x.java.spi.codegen.WithOption;
 import org.apache.plc4x.java.spi.generation.SerializationException;
 import org.apache.plc4x.java.spi.generation.WriteBuffer;
 
 import java.nio.charset.StandardCharsets;
+import java.util.List;
 import java.util.Map;
 
 public class DefaultListPlcBrowseItem extends DefaultPlcBrowseItem {
 
+    private final List<PlcBrowseItemArrayInfo> arrayInformation;
+
     public DefaultListPlcBrowseItem(PlcTag tag,
                                     String name,
                                     boolean readable,
                                     boolean writable,
                                     boolean subscribable,
                                     Map<String, PlcBrowseItem> children,
-                                    Map<String, PlcValue> options) {
+                                    Map<String, PlcValue> options,
+                                    List<PlcBrowseItemArrayInfo> arrayInformation) {
         super(tag, name, readable, writable, subscribable, children, options);
+        this.arrayInformation = arrayInformation;
+    }
+
+    @Override
+    public boolean isArray() {
+        return (arrayInformation != null) && !arrayInformation.isEmpty();
+    }
+
+    @Override
+    public List<PlcBrowseItemArrayInfo> getArrayInformation() {
+        return arrayInformation;
     }
 
     @Override
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/messages/DefaultPlcBrowseItem.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/messages/DefaultPlcBrowseItem.java
@@ -19,6 +19,7 @@
 package org.apache.plc4x.java.spi.messages;
 
 import org.apache.plc4x.java.api.messages.PlcBrowseItem;
+import org.apache.plc4x.java.api.messages.PlcBrowseItemArrayInfo;
 import org.apache.plc4x.java.api.model.PlcTag;
 import org.apache.plc4x.java.api.value.PlcValue;
 import org.apache.plc4x.java.spi.codegen.WithOption;
@@ -27,6 +28,8 @@
 import org.apache.plc4x.java.spi.utils.Serializable;
 
 import java.nio.charset.StandardCharsets;
+import java.util.Collections;
+import java.util.List;
 import java.util.Map;
 
 public class DefaultPlcBrowseItem implements PlcBrowseItem, Serializable {
@@ -81,6 +84,15 @@ public boolean isSubscribable() {
         return subscribable;
     }
 
+    @Override
+    public boolean isArray() {
+        return false;
+    }
+
+    public List<PlcBrowseItemArrayInfo> getArrayInformation() {
+        return Collections.emptyList();
+    }
+
     @Override
     public Map<String, PlcBrowseItem> getChildren() {
         return children;
diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/messages/DefaultPlcBrowseItemArrayInfo.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/messages/DefaultPlcBrowseItemArrayInfo.java
@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.plc4x.java.spi.messages;
+
+import org.apache.plc4x.java.api.messages.PlcBrowseItemArrayInfo;
+
+public class DefaultPlcBrowseItemArrayInfo implements PlcBrowseItemArrayInfo {
+
+    private final long lowerBound;
+    private final long upperBound;
+
+    public DefaultPlcBrowseItemArrayInfo(long lowerBound, long upperBound) {
+        this.lowerBound = lowerBound;
+        this.upperBound = upperBound;
+    }
+
+    @Override
+    public long getLowerBound() {
+        return lowerBound;
+    }
+
+    @Override
+    public long getUpperBound() {
+        return upperBound;
+    }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -261,7 +261,7 @@ public CompletableFuture<PlcBrowseResponse> browseWithInterceptor(PlcBrowseReque`
`261`	`261`	`new DefaultListPlcBrowseItem(`
`262`	`262`	`new CtrlXTag(curNode, PlcValueType.BOOL, Collections.emptyList()),`
`263`	`263`	`curNode, true, true, true,`
`264`		`- Collections.emptyMap(), Collections.emptyMap())));`
	`264`	`+ Collections.emptyMap(), Collections.emptyMap(), Collections.emptyList())));`
`265`	`265`	`}`
`266`	`266`	`}`
`267`	`267`	`// If this node has children, then it's branch, and we need to add its children to the queue.`