Examples with StructureDescription org.eclipse.milo.opcua.stack.core.types.structured.StructureDescription used on opensource projects

Example 1 with StructureDescription

use of org.eclipse.milo.opcua.stack.core.types.structured.StructureDescription in project milo by eclipse.

the class DataTypeDictionaryGenerator method createStructuredType.

private StructuredType createStructuredType(StructureDescription description) {
    QualifiedName name = description.getName();
    StructureDefinition definition = description.getStructureDefinition();
    StructureType structureType = definition.getStructureType();
    StructuredType structuredType = new StructuredType();
    structuredType.setName(name.getName());
    // Create a combined list of StructuredFields from all parent types
    LinkedList<StructureDefinition> definitions = new LinkedList<>();
    definitions.addFirst(definition);
    NodeId baseDataTypeId = definition.getBaseDataType();
    while (baseDataTypeId != null && baseDataTypeId.isNotNull() && !Identifiers.Structure.equals(baseDataTypeId) && !Identifiers.Union.equals(baseDataTypeId)) {
        StructureDescription baseDescription = structureDescriptions.get(baseDataTypeId);
        StructureDefinition baseDefinition = baseDescription.getStructureDefinition();
        definitions.addFirst(baseDefinition);
        baseDataTypeId = baseDefinition.getBaseDataType();
    }
    LinkedHashMap<String, StructureField> allFields = new LinkedHashMap<>();
    for (StructureDefinition d : definitions) {
        for (StructureField f : d.getFields()) {
            allFields.put(f.getName(), f);
        }
    }
    List<StructureField> fields = new ArrayList<>(allFields.values());
    if (structureType == StructureType.StructureWithOptionalFields) {
        int optionalFieldCount = 0;
        for (StructureField field : fields) {
            if (field.getIsOptional()) {
                optionalFieldCount++;
                FieldType fieldType = new FieldType();
                fieldType.setName(field.getName() + "Present");
                fieldType.setTypeName(new QName(Namespaces.OPC_UA_BSD, "Bit"));
                structuredType.getField().add(fieldType);
            }
        }
        if (optionalFieldCount > 0) {
            int reservedFieldCount = (optionalFieldCount + 31) / 32;
            for (int i = 0; i < reservedFieldCount; i++) {
                long reservedBits = 32 - optionalFieldCount;
                optionalFieldCount -= 32;
                FieldType fieldType = new FieldType();
                fieldType.setLength(reservedBits);
                fieldType.setName("Reserved" + i);
                fieldType.setTypeName(new QName(Namespaces.OPC_UA_BSD, "Bit"));
                structuredType.getField().add(fieldType);
            }
        }
    } else if (structureType == StructureType.Union) {
        FieldType fieldType = new FieldType();
        fieldType.setName("SwitchField");
        fieldType.setTypeName(new QName(Namespaces.OPC_UA_BSD, "UInt32"));
        structuredType.getField().add(fieldType);
    }
    long switchValue = 0L;
    for (StructureField field : fields) {
        String fieldName = field.getName();
        NodeId fieldDataTypeId = field.getDataType();
        DataTypeLocation dataTypeLocation = dataTypeLookup.apply(fieldDataTypeId);
        String dataTypeName = dataTypeLocation.dataTypeName;
        String dictionaryNamespaceUri = dataTypeLocation.dictionaryNamespaceUri;
        namespaces.add(dictionaryNamespaceUri);
        FieldType fieldType = new FieldType();
        fieldType.setName(fieldName);
        fieldType.setTypeName(new QName(dictionaryNamespaceUri, dataTypeName));
        if (structureType == StructureType.StructureWithOptionalFields) {
            if (field.getIsOptional()) {
                fieldType.setSwitchField(fieldName + "Present");
            }
        } else if (structureType == StructureType.Union) {
            fieldType.setSwitchField("SwitchField");
            fieldType.setSwitchValue(++switchValue);
        }
        if (field.getValueRank() >= 1) {
            // Fixed-dimension array... specify a LengthField
            FieldType lengthFieldType = new FieldType();
            lengthFieldType.setName(fieldName + "Length");
            lengthFieldType.setTypeName(new QName(Namespaces.OPC_UA_BSD, "Int32"));
            if (structureType == StructureType.StructureWithOptionalFields) {
                if (field.getIsOptional()) {
                    lengthFieldType.setSwitchField(fieldName + "Present");
                }
            } else if (structureType == StructureType.Union) {
                fieldType.setSwitchField("SwitchField");
                fieldType.setSwitchValue(switchValue);
            }
            structuredType.getField().add(lengthFieldType);
            fieldType.setLengthField(fieldName + "Length");
        } else if (field.getValueRank() != -1) {
            // Not scalar, not fixed-dimension, not supported
            throw new IllegalArgumentException("cannot encode field \"" + fieldName + "\" " + "with ValueRank: %s" + field.getValueRank());
        }
        structuredType.getField().add(fieldType);
    }
    return structuredType;
}

Example 2 with StructureDescription

use of org.eclipse.milo.opcua.stack.core.types.structured.StructureDescription in project tech-pdai-spring-demos by realpdai.

the class ExampleNamespace method registerCustomUnionType.

private void registerCustomUnionType() throws Exception {
    NodeId dataTypeId = CustomUnionType.TYPE_ID.toNodeIdOrThrow(getServer().getNamespaceTable());
    NodeId binaryEncodingId = CustomUnionType.BINARY_ENCODING_ID.toNodeIdOrThrow(getServer().getNamespaceTable());
    dictionaryManager.registerUnionCodec(new CustomUnionType.Codec().asBinaryCodec(), "CustomUnionType", dataTypeId, binaryEncodingId);
    StructureField[] fields = new StructureField[] { new StructureField("foo", LocalizedText.NULL_VALUE, Identifiers.UInt32, ValueRanks.Scalar, null, getServer().getConfig().getLimits().getMaxStringLength(), false), new StructureField("bar", LocalizedText.NULL_VALUE, Identifiers.String, ValueRanks.Scalar, null, uint(0), false) };
    StructureDefinition definition = new StructureDefinition(binaryEncodingId, Identifiers.Structure, StructureType.Union, fields);
    StructureDescription description = new StructureDescription(dataTypeId, new QualifiedName(getNamespaceIndex(), "CustomUnionType"), definition);
    dictionaryManager.registerStructureDescription(description, binaryEncodingId);
}

Example 3 with StructureDescription

use of org.eclipse.milo.opcua.stack.core.types.structured.StructureDescription in project tech-pdai-spring-demos by realpdai.

the class ExampleNamespace method registerCustomStructType.

private void registerCustomStructType() throws Exception {
    // Get the NodeId for the DataType and encoding Nodes.
    NodeId dataTypeId = CustomStructType.TYPE_ID.toNodeIdOrThrow(getServer().getNamespaceTable());
    NodeId binaryEncodingId = CustomStructType.BINARY_ENCODING_ID.toNodeIdOrThrow(getServer().getNamespaceTable());
    // At a minimum, custom types must have their codec registered.
    // If clients don't need to dynamically discover types and will
    // register the codecs on their own then this is all that is
    // necessary.
    // The dictionary manager will add a corresponding DataType Node to
    // the AddressSpace.
    dictionaryManager.registerStructureCodec(new CustomStructType.Codec().asBinaryCodec(), "CustomStructType", dataTypeId, binaryEncodingId);
    // If the custom type also needs to be discoverable by clients then it
    // needs an entry in a DataTypeDictionary that can be read by those
    // clients. We describe the type using StructureDefinition or
    // EnumDefinition and register it with the dictionary manager.
    // The dictionary manager will add all the necessary nodes to the
    // AddressSpace and generate the required dictionary bsd.xml file.
    StructureField[] fields = new StructureField[] { new StructureField("foo", LocalizedText.NULL_VALUE, Identifiers.String, ValueRanks.Scalar, null, getServer().getConfig().getLimits().getMaxStringLength(), false), new StructureField("bar", LocalizedText.NULL_VALUE, Identifiers.UInt32, ValueRanks.Scalar, null, uint(0), false), new StructureField("baz", LocalizedText.NULL_VALUE, Identifiers.Boolean, ValueRanks.Scalar, null, uint(0), false) };
    StructureDefinition definition = new StructureDefinition(binaryEncodingId, Identifiers.Structure, StructureType.Structure, fields);
    StructureDescription description = new StructureDescription(dataTypeId, new QualifiedName(getNamespaceIndex(), "CustomStructType"), definition);
    dictionaryManager.registerStructureDescription(description, binaryEncodingId);
}

Example 4 with StructureDescription

use of org.eclipse.milo.opcua.stack.core.types.structured.StructureDescription in project milo by eclipse.

the class ExampleNamespace method registerCustomUnionType.

private void registerCustomUnionType() throws Exception {
    NodeId dataTypeId = CustomUnionType.TYPE_ID.toNodeIdOrThrow(getServer().getNamespaceTable());
    NodeId binaryEncodingId = CustomUnionType.BINARY_ENCODING_ID.toNodeIdOrThrow(getServer().getNamespaceTable());
    dictionaryManager.registerUnionCodec(new CustomUnionType.Codec().asBinaryCodec(), "CustomUnionType", dataTypeId, binaryEncodingId);
    StructureField[] fields = new StructureField[] { new StructureField("foo", LocalizedText.NULL_VALUE, Identifiers.UInt32, ValueRanks.Scalar, null, getServer().getConfig().getLimits().getMaxStringLength(), false), new StructureField("bar", LocalizedText.NULL_VALUE, Identifiers.String, ValueRanks.Scalar, null, uint(0), false) };
    StructureDefinition definition = new StructureDefinition(binaryEncodingId, Identifiers.Structure, StructureType.Union, fields);
    StructureDescription description = new StructureDescription(dataTypeId, new QualifiedName(getNamespaceIndex(), "CustomUnionType"), definition);
    dictionaryManager.registerStructureDescription(description, binaryEncodingId);
}

Example 5 with StructureDescription

use of org.eclipse.milo.opcua.stack.core.types.structured.StructureDescription in project milo by eclipse.

the class ExampleNamespace method registerCustomStructType.

private void registerCustomStructType() throws Exception {
    // Get the NodeId for the DataType and encoding Nodes.
    NodeId dataTypeId = CustomStructType.TYPE_ID.toNodeIdOrThrow(getServer().getNamespaceTable());
    NodeId binaryEncodingId = CustomStructType.BINARY_ENCODING_ID.toNodeIdOrThrow(getServer().getNamespaceTable());
    // At a minimum, custom types must have their codec registered.
    // If clients don't need to dynamically discover types and will
    // register the codecs on their own then this is all that is
    // necessary.
    // The dictionary manager will add a corresponding DataType Node to
    // the AddressSpace.
    dictionaryManager.registerStructureCodec(new CustomStructType.Codec().asBinaryCodec(), "CustomStructType", dataTypeId, binaryEncodingId);
    // If the custom type also needs to be discoverable by clients then it
    // needs an entry in a DataTypeDictionary that can be read by those
    // clients. We describe the type using StructureDefinition or
    // EnumDefinition and register it with the dictionary manager.
    // The dictionary manager will add all the necessary nodes to the
    // AddressSpace and generate the required dictionary bsd.xml file.
    StructureField[] fields = new StructureField[] { new StructureField("foo", LocalizedText.NULL_VALUE, Identifiers.String, ValueRanks.Scalar, null, getServer().getConfig().getLimits().getMaxStringLength(), false), new StructureField("bar", LocalizedText.NULL_VALUE, Identifiers.UInt32, ValueRanks.Scalar, null, uint(0), false), new StructureField("baz", LocalizedText.NULL_VALUE, Identifiers.Boolean, ValueRanks.Scalar, null, uint(0), false) };
    StructureDefinition definition = new StructureDefinition(binaryEncodingId, Identifiers.Structure, StructureType.Structure, fields);
    StructureDescription description = new StructureDescription(dataTypeId, new QualifiedName(getNamespaceIndex(), "CustomStructType"), definition);
    dictionaryManager.registerStructureDescription(description, binaryEncodingId);
}