Support Matrix in AttributeReader and AttributeWriter

Author: kevinherron

opc-ua-sdk/sdk-server/src/main/java/org/eclipse/milo/opcua/sdk/server/AttributeReader.java

@@ -116,7 +116,15 @@ public static DataValue readAttribute(
         try {
           NumericRange range = NumericRange.parse(indexRange);
 
-          Object valueAtRange = NumericRange.readFromValueAtRange(dv.getValue().getValue(), range);
+          Object valueAtRange;
+          if (dv.getValue().getValue() instanceof Matrix matrix) {
+            valueAtRange = NumericRange.readFromValueAtRange(matrix.nestedArrayValue(), range);
+            if (ArrayUtil.getValueRank(valueAtRange) > 1) {
+              valueAtRange = new Matrix(valueAtRange);
+            }
+          } else {
+            valueAtRange = NumericRange.readFromValueAtRange(dv.getValue(), range);
+          }
 
           return dvb.setValue(Variant.of(valueAtRange))
               .applyTimestamps(attributeId, timestamps)

opc-ua-sdk/sdk-server/src/main/java/org/eclipse/milo/opcua/sdk/server/AttributeWriter.java

@@ -28,13 +28,7 @@
 import org.eclipse.milo.opcua.stack.core.NodeIds;
 import org.eclipse.milo.opcua.stack.core.StatusCodes;
 import org.eclipse.milo.opcua.stack.core.UaException;
-import org.eclipse.milo.opcua.stack.core.types.builtin.ByteString;
-import org.eclipse.milo.opcua.stack.core.types.builtin.DataValue;
-import org.eclipse.milo.opcua.stack.core.types.builtin.DateTime;
-import org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject;
-import org.eclipse.milo.opcua.stack.core.types.builtin.NodeId;
-import org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode;
-import org.eclipse.milo.opcua.stack.core.types.builtin.Variant;
+import org.eclipse.milo.opcua.stack.core.types.builtin.*;
 import org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte;
 import org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger;
 import org.eclipse.milo.opcua.stack.core.util.ArrayUtil;
@@ -107,10 +101,24 @@ public static StatusCode writeAttribute(
       try {
         NumericRange range = NumericRange.parse(indexRange);
 
-        Object current = node.getAttribute(AccessContext.INTERNAL, attributeId);
+        Object currentValue = node.getAttribute(AccessContext.INTERNAL, attributeId);
+        if (currentValue instanceof DataValue dataValue) {
+          currentValue = dataValue.getValue().getValue();
+        }
+        if (currentValue instanceof Matrix matrix) {
+          currentValue = matrix.nestedArrayValue();
+        }
+
+        Object updateValue = updateVariant.getValue();
+        if (updateValue instanceof Matrix matrix) {
+          updateValue = matrix.nestedArrayValue();
+        }
+
+        Object valueAtRange = NumericRange.writeToValueAtRange(currentValue, updateValue, range);
 
-        Object valueAtRange =
-            NumericRange.writeToValueAtRange(Variant.of(current), updateVariant, range);
+        if (ArrayUtil.getValueRank(valueAtRange) > 1) {
+          valueAtRange = new Matrix(valueAtRange);
+        }
 
         updateVariant = new Variant(valueAtRange);
       } catch (UaException e) {
@@ -252,6 +260,10 @@ private static DataValue validateDataType(
       }
     }
 
+    if (o instanceof Matrix matrix) {
+      o = matrix.nestedArrayValue();
+    }
+
     Class<?> valueClass = o.getClass().isArray() ? ArrayUtil.getType(o) : o.getClass();
 
     Class<?> expectedClass = getExpectedClass(server, dataType, valueClass);
@@ -296,6 +308,10 @@ private static void validateArrayType(
     Object o = variant.getValue();
     if (o == null) return;
 
+    if (o instanceof Matrix matrix) {
+      o = matrix.nestedArrayValue();
+    }
+
     boolean valueIsArray = o.getClass().isArray();
 
     switch (valueRank) {

opc-ua-stack/stack-core/src/main/java/org/eclipse/milo/opcua/stack/core/util/ArrayUtil.java

@@ -104,6 +104,26 @@ public static int[] getDimensions(Object array) {
     return dimensions.toArray();
   }
 
+  /**
+   * Get the ValueRank of an Object that may or may not be an array.
+   *
+   * <p>The return value is either -1 (scalar) or the number of dimensions (>=1).
+   *
+   * @param array the Object to check.
+   * @return the ValueRank of the object.
+   */
+  public static int getValueRank(Object array) {
+    Class<?> type = array.getClass();
+    int rank = 0;
+
+    while (type.isArray()) {
+      rank++;
+      type = type.getComponentType();
+    }
+
+    return rank == 0 ? -1 : rank;
+  }
+
   public static Class<?> getType(Object array) {
     Class<?> type = array.getClass();
 

opc-ua-stack/stack-core/src/test/java/org/eclipse/milo/opcua/stack/core/util/ArrayUtilTest.java

@@ -14,6 +14,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.lang.reflect.Array;
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 
@@ -93,4 +94,12 @@ public static Object[][] getTypedArrays() {
   public void testGetType(Object array, Class<?> type) throws Exception {
     assertEquals(type, ArrayUtil.getType(array));
   }
+
+  @Test
+  void getValueRank() {
+    assertEquals(-1, ArrayUtil.getValueRank(0));
+    assertEquals(1, ArrayUtil.getValueRank(new int[1]));
+    assertEquals(2, ArrayUtil.getValueRank(new int[1][1]));
+    assertEquals(3, ArrayUtil.getValueRank(new int[1][1][1]));
+  }
 }