com.prosysopc.ua.client.nodes

Class UaTypeImpl

java.lang.Object

com.prosysopc.ua.nodes.AbstractUaNode

com.prosysopc.ua.client.nodes.UaNodeImpl

com.prosysopc.ua.client.nodes.UaTypeImpl

All Implemented Interfaces:

UaNode, UaType

Direct Known Subclasses:

UaDataTypeImpl, UaObjectTypeImpl, UaReferenceTypeImpl, UaVariableTypeImpl

public abstract class UaTypeImpl
extends UaNodeImpl
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.client.nodes.UaNodeImpl

addressSpace, logger, references, supportedAttributesMap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UaTypeImpl(AddressSpace addressSpace, NodeId nodeId, QualifiedName browseName, LocalizedText displayName)
protected	UaTypeImpl(AddressSpace addressSpace, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, LocalizedText description, AttributeWriteMask writeMask, AttributeWriteMask userWriteMask, UaClientReference[] references, UaProperty[] properties, Boolean isAbstract)
	UaTypeImpl(AddressSpace addressSpace, NodeId nodeId, String name, Locale locale) Create a new node with name to be used for browseName and displayName.
protected	UaTypeImpl(UaNode.Parameters parameters)

Method Summary

Modifier and Type	Method and Description
void	addSubType(UaType node) 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.
NodeId	getSuperTypeId() Returns the same as UaNode.getNodeId() of UaType.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.
protected void	initSupportedAttributes(List<UnsignedInteger> l)
protected void	readAttributeValue(UnsignedInteger attributeId, DataValue dataValue) Read the value of an attribute.
void	setIsAbstract(Boolean isAbstract) Sets the IsAbstract Attribute value.
void	setSuperType(UaType parent) 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.client.nodes.UaNodeImpl

addComponent, addProperties, addProperty, addReference, addReference, addReference, addReference, afterAddReference, afterDeleteReference, assertTypeSupport, assertTypeSupport, beforeAddReference, deleteReference, deleteReference, deleteReference, deleteReference, deleteReferences, doAddProperty, equals, findPlaceholders, getAddressSpace, getAttributes, getAttributesMap, getAttributesMap, getBrowseName, getComponent, getComponents, getDescription, getDescription, getDisplayName, getDisplayName, getMethod, getNodeClass, getNodeId, getNodeVersion, getNodeVersionNode, getProperties, getProperty, getPropertyValue, getReference, getReferenceList, getReferences, getSupportedAttributes, getUaNodeId, getUserWriteMask, getWriteMask, hashCode, hasProperty, hasTypeDefinition, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, referenceTypeInherits, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setNodeVersion, setPropertyValue, setReferences, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute

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

getForwardReferences, getInverseReferences, getReferences, getReferences, getReferencesAsList, 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

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

Constructor Detail

UaTypeImpl

public UaTypeImpl(AddressSpace addressSpace,
                  NodeId nodeId,
                  String name,
                  Locale locale)

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

Parameters:

nodeId -

name -

locale -

UaTypeImpl

protected UaTypeImpl(AddressSpace addressSpace,
                     NodeId nodeId,
                     QualifiedName browseName,
                     LocalizedText displayName)

UaTypeImpl

protected UaTypeImpl(AddressSpace addressSpace,
                     NodeId nodeId,
                     QualifiedName browseName,
                     LocalizedText displayName,
                     LocalizedText description,
                     AttributeWriteMask writeMask,
                     AttributeWriteMask userWriteMask,
                     UaClientReference[] references,
                     UaProperty[] properties,
                     Boolean isAbstract)

UaTypeImpl

protected UaTypeImpl(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.

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()

getSuperTypeId

public NodeId getSuperTypeId()

Description copied from interface: UaType

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

Specified by:

getSuperTypeId in interface UaType

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()

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 parent)

Description copied from interface: UaType

Set the ModelParent reference.

Specified by:

setSuperType in interface UaType

Parameters:

parent - the super type to set.

toString

public String toString()

Overrides:

toString in class UaNodeImpl

initSupportedAttributes

protected void initSupportedAttributes(List<UnsignedInteger> l)

Overrides:

initSupportedAttributes in class UaNodeImpl

readAttributeValue

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

Description copied from class: UaNodeImpl

Read the value of an attribute.

Overrides:

readAttributeValue in class UaNodeImpl

Parameters:

attributeId - the ID of the attribute to read.

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

Throws:

StatusException - on failure

writeAttributeValue

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

Overrides:

writeAttributeValue in class UaNodeImpl

Throws:

StatusException