com.prosysopc.ua.typedictionary

Interface UaDataTypeSpecification

All Superinterfaces:

UaNamespaceTranslateable<UaDataTypeSpecification>

All Known Subinterfaces:

OptionSetSpecification, OptionSetStructureSpecification, StructureSpecification

All Known Implementing Classes:

EnumerationSpecification, SimpleTypeSpecification

public interface UaDataTypeSpecification
extends UaNamespaceTranslateable<UaDataTypeSpecification>

Base interface for "Specification(s)" of OPC UA DataTypes. For example, StructureSpecification contains information about the fields of the Structure.

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.UaNamespaceTranslateable

UaNamespaceTranslateable.Context

Method Summary

Modifier and Type	Method and Description
Class<?>	getJavaClass() Returns the java Class that maps to this type.
String	getName() Returns the name of the type.
UaNodeId	getTypeId() Returns the DataType NodeId modeling the type.
String	getXmlName() Internal.
boolean	isAbstract() Returns true if the type is known to be abstract, false otherwise.
DataTypeDefinition	toDataTypeDefinition(NamespaceTable namespaceTable) Returns data of this UaDataTypeSpecification as a DataTypeDefinition.

Methods inherited from interface com.prosysopc.ua.UaNamespaceTranslateable

withTranslatedNamespaces

Method Detail

getJavaClass

Class<?> getJavaClass()

Returns the java Class that maps to this type.

getName

String getName()

Returns the name of the type.

getTypeId

UaNodeId getTypeId()

Returns the DataType NodeId modeling the type.

getXmlName

String getXmlName()

Internal. Application code shouldn't use this, but SDK may use this instead of getName() if more context is available, such as symbolic names in NodeSet documents. Returns same as getName() if there no such context.

isAbstract

boolean isAbstract()

Returns true if the type is known to be abstract, false otherwise.

Note that if the UaDataTypeSpecification has been formed outside of client-server communication or a NodeSet, it might not be possible to determine this information, in which case this method returns false.

toDataTypeDefinition

DataTypeDefinition toDataTypeDefinition(NamespaceTable namespaceTable)

Returns data of this UaDataTypeSpecification as a DataTypeDefinition. This method is mostly intended for SDK's internal use for the DataTypeDefinition Attribute's value for UaDataType nodes, but may be useful in some complicated aggregation servers.

Note that not all UaDataTypeSpecifications can be converted to a DataTypeDefinition (such as SimpleTypeSpecification), in which case this method returns null. Enumeration and OptionSet-types (including 'OptionSet'-Structure subtypes, but not the base 'OptionSet' Structure type) use EnumDefinition. Structures use StructureDefinition.

Parameters:

namespaceTable - a NamespaceTable.

Returns:

DataTypeDefinition based of the data of this StructureSpecification or null in the case of SimpleTypeSpecification.

Throws:

IllegalArgumentException - if the given NamespaceTable cannot be used e.g. for UaNodeId-> NodeId conversion of getTypeId().