com.prosysopc.ua.nodes

Interface UaType

All Superinterfaces:

UaNode

All Known Subinterfaces:

UaDataType, UaExternalNode, UaObjectType, UaReferenceType, UaVariableType

All Known Implementing Classes:

UaDataTypeImpl, UaDataTypeNode, UaExternalNodeImpl, UaObjectTypeImpl, UaObjectTypeNode, UaReferenceTypeImpl, UaReferenceTypeNode, UaTypeImpl, UaTypeNode, UaVariableTypeImpl, UaVariableTypeNode

public interface UaType
extends UaNode

Common interface for all UA Types.

Note that the specification does not define any generic behavior for types and there is no specific node class, called type.

This interface is defined solely to make it possible to classify the UA types from the instances.

See Also:

UaDataType, UaObjectType, UaReferenceType, UaVariableType

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.nodes.UaNode

UaNode.Parameters

Method Summary

Modifier and Type	Method and Description
void	addSubType(UaType type) Add a new sub type for the type.
Boolean	getIsAbstract() Returns true if this is an abstract type, false otherwise.
UaType	getSuperType() Returns the UA type that is defined as the ancestor of the type in the UA AddressSpace.
default NodeId	getSuperTypeId() Returns the same as UaNode.getNodeId() of getSuperType().
boolean	hasSuperType() Returns whether the type has a super type.
boolean	inheritsFrom(NodeId typeId) Check if the type inherits from the specified type.
boolean	inheritsFrom(UaType type) Check if the type inherits from the specified type.
default UaNodeId	inheritsFromAny(Collection<UaNodeId> typeIds) Same as inheritsFrom(NodeId), but checks multiple types.
default UaNodeId	inheritsFromAny(UaNodeId... typeIds) Same as inheritsFrom(NodeId), but checks multiple types.
void	setIsAbstract(Boolean isAbstract) Sets the IsAbstract Attribute value.
void	setSuperType(UaType parent) Set the ModelParent reference.

Methods inherited from interface com.prosysopc.ua.nodes.UaNode

addComponent, addOrganizes, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributes, getAttributesMap, getBrowseName, getBrowsePaths, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeClass, getNodeId, getNodeVersionNode, getOrganizedNode, getOrganizedNodes, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUaBrowsePaths, getUaNodeId, getUserData, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserData, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute

Method Detail

addSubType

void addSubType(UaType type)

Add a new sub type for the type.

Adds a new reference of type HasSubType to the node with target set to type.

Parameters:

type - the node to add.

getIsAbstract

Boolean getIsAbstract()

Returns true if this is an abstract type, false otherwise.

getSuperType

UaType getSuperType()

Returns the UA type that is defined as the ancestor of the type in the UA AddressSpace. Or null, if the type has no super type (e.g. BaseObjectType has no super type)

See Also:

hasSuperType()

getSuperTypeId

default NodeId getSuperTypeId()

Returns the same as UaNode.getNodeId() of getSuperType().

hasSuperType

boolean hasSuperType()

Returns whether the type has a super type. If not, getSuperType() returns null.

inheritsFrom

boolean inheritsFrom(NodeId typeId)

Check if the type inherits from the specified type.

Parameters:

typeId - The NodeId of the type to check

Returns:

true if this type inherits from the specified type, i.e. it is itself or (recursively) has a supertype that equals to typeId

See Also:

getSuperType()

inheritsFrom

boolean inheritsFrom(UaType type)

Check if the type inherits from the specified type.

Parameters:

type - The NodeId of the type to check

Returns:

true if this type inherits from the specified type, i.e. it is itself or (recursively) has a modelParent that equals to typeId

See Also:

getSuperType()

inheritsFromAny

default UaNodeId inheritsFromAny(Collection<UaNodeId> typeIds)

Same as inheritsFrom(NodeId), but checks multiple types. Returns the first match in super-type hierarchy (including and starting from this type and following inverse HasSubType references) that is one of the given types, or null if there is no match. Returns null if given null or empty collection.

inheritsFromAny

default UaNodeId inheritsFromAny(UaNodeId... typeIds)

Same as inheritsFrom(NodeId), but checks multiple types. Returns the first match in super-type hierarchy (including and starting from this type and following inverse HasSubType references) that is one of the given types, or null if there is no match. Returns null for null and empty arrays.

setIsAbstract

void setIsAbstract(Boolean isAbstract)

Sets the IsAbstract Attribute value.

See Also:

getIsAbstract()

setSuperType

void setSuperType(UaType parent)

Set the ModelParent reference.

Parameters:

parent - the super type to set.