com.prosysopc.ua.server.nodes

Class UaTypeNode

java.lang.Object

com.prosysopc.ua.nodes.AbstractUaNode

com.prosysopc.ua.server.nodes.ServerNode

com.prosysopc.ua.server.nodes.BaseNode

com.prosysopc.ua.server.nodes.UaTypeNode

All Implemented Interfaces:

UaNode, UaType

Direct Known Subclasses:

UaDataTypeNode, UaObjectTypeNode, UaReferenceTypeNode, UaVariableTypeNode

public abstract class UaTypeNode
extends BaseNode
implements UaType

Generic type node. This is a base node type for all type nodes.

Note that the OPC UA Specification does not define or represent such a common "base class" for all type nodes. However, all type nodes support IsAbstract attribute, and the nodes exist in the Types section of the address space only.

Nested Class Summary

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

UaNode.Parameters

Field Summary

Fields inherited from class com.prosysopc.ua.server.nodes.BaseNode

NODE_VERSION_PROPERTY_NAME, useQuickPropertyLookup

Fields inherited from class com.prosysopc.ua.server.nodes.ServerNode

eventListeners, INITIALIZATION_TIME, nodeManager, supportedAttributesMap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UaTypeNode(NodeManagerUaNode nodeManager, NodeId nodeId, QualifiedName browseName, LocalizedText displayName)
protected	UaTypeNode(NodeManagerUaNode nodeManager, NodeId nodeId, String name, Locale locale) Create a new node with name to be used for browseName and displayName.
protected	UaTypeNode(UaNode.Parameters parameters)

Method Summary

Modifier and Type	Method and Description
void	addSubType(UaType node) Add a new sub type for the type.
protected void	afterAddReference(UaReference reference)
protected boolean	beforeAddReference(UaReference reference)
UaNode	getComponent(QualifiedName componentName) Get the component, which has the specified name.
UaTypeInstanceDeclarationHierarchy	getInstanceDeclarationHierarchy() Equivalent to UaTypeInstanceDeclarationHierarchy.fromUaType(UaTypeNode) using this UaTypeNode, but the result is cached within this 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.
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.
protected void	initSupportedAttributes(List<UnsignedInteger> list)
protected void	readAttributeValue(UnsignedInteger attributeId, DataValue dataValue) Read the value of an attribute.
void	resetInstanceDeclarationHierarchy()
void	setIsAbstract(Boolean isAbstract) Sets the IsAbstract Attribute value.
void	setSuperType(UaType superType) Set the ModelParent reference.
String	toString()
protected void	writeAttributeValue(UnsignedInteger attributeId, Object value, StatusCode statusCode, DateTime sourceTime, UnsignedShort sourcePicoseconds)

Methods inherited from class com.prosysopc.ua.server.nodes.BaseNode

addPlainProperty, addPlainVariable, assertTypeSupport, assertTypeSupport, createNodeId, createNodeId, createReflectiveInstanceProperty, createReflectiveInstanceProperty, deleteReference, deleteReference, doAddProperty, getAttributes, getAttributes, getAttributesMap, getAttributesMap, getBrowseName, getComponents, getDescription, getDescription, getDisplayName, getDisplayName, getMethod, getNodeClass, getNodeVersion, getNodeVersionNode, getProperties, getProperty, getPropertyReference, getPropertyValue, getReferencesAsList, getStandardBrowseName, getStandardDisplayText, getUserWriteMask, getWriteMask, hasProperty, hasReference, hasTypeDefinition, hasUserWriteAccess, hasWriteAccess, incNodeVersion, initNodeVersion, isChildOfType, readAttribute, readAttribute, registerCallbackProperty, registerPlainInstanceProperty, registerPlainInstanceProperty, registerPlainProperty, registerPlainProperty, registerPlainVariable, registerPlainVariable, registerReflectiveInstanceProperty, registerReflectiveInstanceVariable, registerReflectiveProperty, registerReflectiveVariable, removeProperty, setAccessLevelRecursively, setAccessLevelRecursively, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setNodeVersion, setPropertyValue, setUserWriteMask, setWriteMask, writeAttribute

Methods inherited from class com.prosysopc.ua.server.nodes.ServerNode

addComponent, addDataChangeListener, addEventListener, addNewReference, addNewReference, addOrganizes, addProperties, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, afterDeleteReference, dataChange, deleteReference, deleteReference, deleteReferences, doDeleteReference, equals, findPlaceholders, fireDataChange, fireEvent, fireEventInParents, getAddressSpace, getDefaultBrowseName, getNodeId, getNodeManager, getNodeSetExtensions, getReference, getReferenceList, getReferences, getSupportedAttributes, getTargetNodes, getUaNodeId, hashCode, isAddNotifierReferencesToServerObject, isFalseOrNull, isMandatory, isMonitoredForEvents, isTrueOrNull, isType, referenceTypeInherits, removeComponent, removeDataChangeListener, removeEventListener, setAddNotifierReferencesToServerObject, setNodeSetExtensions, setReferences, supportsAttribute, translateBrowsePathToNodeIds, validateHasEventSourceChain, validateHasEventSourceChain

Methods inherited from class com.prosysopc.ua.nodes.AbstractUaNode

getForwardReferences, getInverseReferences, getReferences, getReferences, getUserData, referenceTypeInherits, setUserData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getSuperTypeId, inheritsFromAny, inheritsFromAny

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, 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

Constructor Detail

UaTypeNode

protected UaTypeNode(NodeManagerUaNode nodeManager,
                     NodeId nodeId,
                     QualifiedName browseName,
                     LocalizedText displayName)

UaTypeNode

protected UaTypeNode(NodeManagerUaNode nodeManager,
                     NodeId nodeId,
                     String name,
                     Locale locale)

Create a new node with name to be used for browseName and displayName.

UaTypeNode

protected UaTypeNode(UaNode.Parameters parameters)

Method Detail

addSubType

public void addSubType(UaType node)

Description copied from interface: UaType

Add a new sub type for the type.

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

Specified by:

addSubType in interface UaType

Parameters:

node - the node to add.

getComponent

public UaNode getComponent(QualifiedName componentName)

Description copied from interface: UaNode

Get the component, which has the specified name. The method goes through all references of type HasComponent and returns the node with the matching BrowseName.

Specified by:

getComponent in interface UaNode

Overrides:

getComponent in class BaseNode

Parameters:

componentName - the BrowseName of the component to get

Returns:

the component node or null, if no matching component is found.

getInstanceDeclarationHierarchy

public UaTypeInstanceDeclarationHierarchy getInstanceDeclarationHierarchy()

Equivalent to UaTypeInstanceDeclarationHierarchy.fromUaType(UaTypeNode) using this UaTypeNode, but the result is cached within this type.

getIsAbstract

public Boolean getIsAbstract()

Description copied from interface: UaType

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

Specified by:

getIsAbstract in interface UaType

getSuperType

public UaType getSuperType()

Description copied from interface: UaType

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)

Specified by:

getSuperType in interface UaType

See Also:

UaType.hasSuperType()

hasSuperType

public boolean hasSuperType()

Description copied from interface: UaType

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

Specified by:

hasSuperType in interface UaType

inheritsFrom

public boolean inheritsFrom(NodeId typeId)

Description copied from interface: UaType

Check if the type inherits from the specified type.

Specified by:

inheritsFrom in interface UaType

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:

UaType.getSuperType()

inheritsFrom

public boolean inheritsFrom(UaType type)

Description copied from interface: UaType

Check if the type inherits from the specified type.

Specified by:

inheritsFrom in interface UaType

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:

UaType.getSuperType()

resetInstanceDeclarationHierarchy

public void resetInstanceDeclarationHierarchy()

setIsAbstract

public void setIsAbstract(Boolean isAbstract)

Description copied from interface: UaType

Sets the IsAbstract Attribute value.

Specified by:

setIsAbstract in interface UaType

See Also:

UaType.getIsAbstract()

setSuperType

public void setSuperType(UaType superType)

Description copied from interface: UaType

Set the ModelParent reference.

Specified by:

setSuperType in interface UaType

Parameters:

superType - the super type to set.

toString

public String toString()

Overrides:

toString in class BaseNode

afterAddReference

protected void afterAddReference(UaReference reference)

Overrides:

afterAddReference in class ServerNode

beforeAddReference

protected boolean beforeAddReference(UaReference reference)

Overrides:

beforeAddReference in class ServerNode

Returns:

initSupportedAttributes

protected void initSupportedAttributes(List<UnsignedInteger> list)

Overrides:

initSupportedAttributes in class ServerNode

readAttributeValue

protected void readAttributeValue(UnsignedInteger attributeId,
                                  DataValue dataValue)
                           throws StatusException

Description copied from class: BaseNode

Read the value of an attribute.

Overrides:

readAttributeValue in class BaseNode

Parameters:

attributeId - the ID of the attribute to read.

dataValue - the DataValue structure in which the value is set.

Throws:

StatusException - if the attributeId is not valid for this (base) node implementation.

writeAttributeValue

protected void writeAttributeValue(UnsignedInteger attributeId,
                                   Object value,
                                   StatusCode statusCode,
                                   DateTime sourceTime,
                                   UnsignedShort sourcePicoseconds)
                            throws StatusException

Overrides:

writeAttributeValue in class BaseNode

Throws:

StatusException