com.prosysopc.ua.server.nodes

Class UaVariableNode

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.UaInstanceNode

com.prosysopc.ua.server.nodes.UaVariableNode

All Implemented Interfaces:

UaInstance, UaNode, UaValueNode, UaVariable

Direct Known Subclasses:

CacheVariable, CallbackVariable, PlainVariable

public abstract class UaVariableNode
extends UaInstanceNode
implements UaVariable

Abstract base implementation of UaVariable for UA Server side.

It reserves fields for all variable specific attributes, except for the Value attribute. See CacheVariable for a base non-abstract implementation.

Nested Class Summary

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

UaNode.Parameters

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	synchronizeStructures This flag controls are structure values synchronized between parent and child nodes.

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
	UaVariableNode(NodeManagerUaNode nodeManager, NodeId nodeId, QualifiedName browseName, LocalizedText displayName) Create a new variable with dataTypeId initialized to BaseDataType.
	UaVariableNode(NodeManagerUaNode nodeManager, NodeId nodeId, String name, Locale locale) Create a new variable with a specific data type.
protected	UaVariableNode(UaNode.Parameters parameters)

Method Summary

Modifier and Type	Method and Description
UaReference	addProperty(UaProperty property) Add a new property node to the node.
protected ReflectiveVariable	addReflectiveVariable(Object reflectedObject, NodeId nodeId, String fieldName, int nameSpaceIndex, NodeId typeDefinitionId)
protected boolean	beforeAddReference(UaReference reference)
protected void	checkPropertyType(ExpandedNodeId typeDefinition)
protected void	checkPropertyType(NodeId nodeId)
protected DataValue	createDataValue(Object value)
protected abstract void	doSetValue(DataValue value) Perform the actual value set.
protected void	exposeStructureWithReflectiveVariables(Structure structure, int nameSpaceIndex, NodeId typeDefinitionId)
AccessLevelType	getAccessLevel() Defines the global read/write access of the Value attribute for all users.
UnsignedInteger[]	getArrayDimensions() This Attribute specifies the length of each dimension for an array value.
NodeAttributes	getAttributes() Returns the current attribute values of the node in a NodeAttributes structure.
protected VariableAttributes	getAttributes(VariableAttributes attributes)
protected void	getAttributesMap(Map<UnsignedInteger,Object> map)
UaDataType	getDataType()
NodeId	getDataTypeId()
protected ExpandedNodeId	getDefaultTypeDefinition()
Boolean	getHistorizing()
Double	getMinimumSamplingInterval()
NodeClass	getNodeClass() The NodeClass Attribute identifies the NodeClass of a Node.
UaProperty[]	getProperties() Returns all properties of the node or null if none defined.
StatusCode	getStatus()
AccessLevelType	getUserAccessLevel() Defines the user specific read/write access of the Value attribute.
Integer	getValueRank() This Attribute indicates whether the Value Attribute of the Variable is an array and how many dimensions the array has.
boolean	hasUserWriteAccess(UnsignedInteger attributeId) Overrides the default to check access to Value attribute from AccessLevel.
boolean	hasWriteAccess(UnsignedInteger attributeId) Overrides the default to check access to Value attribute from AccessLevel.
protected void	initSupportedAttributes(List<UnsignedInteger> l)
protected boolean	isPropertyType()
protected void	notifyValueChanging(DataValue newValue)
void	notifyValueChanging(Object newValue)
protected void	readAttributeValue(UnsignedInteger attributeId, DataValue dataValue) Read the value of an attribute.
protected void	semanticsChanged() Set the SemanticsChanged bit of statusCodeChangeBits (to be sent with the next notification) and add an entry to the SemanticChangeEvent.
void	setAccessLevel(AccessLevelType accessLevel)
void	setArrayDimensions(UnsignedInteger[] arrayDimensions) This Attribute specifies the length of each dimension for an array value.
void	setAttributes(NodeAttributes nodeAttributes) Sets the attributes of the node.
void	setDataType(UaDataType dataType) Set the Data Type node.
void	setDataTypeId(NodeId dataTypeId) Set the Data Type.
void	setHistorizing(Boolean historizing)
void	setMinimumSamplingInterval(Double minimumSamplingInterval)
void	setStatus(StatusCode status) Set the status of the variable.
void	setTypeDefinition(UaType type) Sets the type of the node.
void	setTypeDefinitionId(ExpandedNodeId typeDefinition) Sets the type definition to an ExpandedNodeId.
void	setUserAccessLevel(AccessLevelType userAccessLevel)
void	setValue(DataValue value) The default Value for instances of this type.
void	setValue(Object value) Set value.
void	setValueRank(int valueRank) This Attribute indicates whether the Value Attribute of the VariableType is an array and how many dimensions the array has.
protected void	structureChanged() Set the StructureChanged bit of statusCodeChangeBits (to be sent with the next notification).
String	toString()
void	updateValue(Object newValue) Update the current value and status.
protected void	updateValue(Object newValue, StatusCode status, DateTime sourceTime, UnsignedShort sourcePicoseconds) Update the current value and status.
protected void	writeAttributeValue(UnsignedInteger attributeId, Object value, StatusCode statusCode, DateTime sourceTime, UnsignedShort sourcePicoseconds)

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

addModellingRule, getTypeDefinition, getTypeDefinitionId, hasTypeDefinition, registerOverridePlainMethod, setTypeDefinitionId, supportsTypeDefinitionNode

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

addPlainProperty, addPlainVariable, assertTypeSupport, assertTypeSupport, createNodeId, createNodeId, createReflectiveInstanceProperty, createReflectiveInstanceProperty, deleteReference, deleteReference, doAddProperty, getAttributes, getAttributesMap, getBrowseName, getComponent, getComponents, getDescription, getDescription, getDisplayName, getDisplayName, getMethod, getNodeVersion, getNodeVersionNode, getProperty, getPropertyReference, getPropertyValue, getReferencesAsList, getStandardBrowseName, getStandardDisplayText, getUserWriteMask, getWriteMask, hasProperty, hasReference, incNodeVersion, initNodeVersion, isChildOfType, readAttribute, readAttribute, registerCallbackProperty, registerPlainInstanceProperty, registerPlainInstanceProperty, registerPlainProperty, registerPlainProperty, registerPlainVariable, registerPlainVariable, registerReflectiveInstanceProperty, registerReflectiveInstanceVariable, registerReflectiveProperty, registerReflectiveVariable, removeProperty, setAccessLevelRecursively, setAccessLevelRecursively, setAttribute, 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, addReference, addReference, addReference, addReference, addReference, addReference, afterAddReference, 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.UaVariable

addDataChangeListener, removeDataChangeListener

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

getTypeDefinition, getTypeDefinitionId, setTypeDefinitionId

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

getValue

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

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

Field Detail

synchronizeStructures

public static boolean synchronizeStructures

This flag controls are structure values synchronized between parent and child nodes. By default true. If set to false, the values written to parent and child are not synchronized to the other node. Note that this should only be done in debug scenarios.

Constructor Detail

UaVariableNode

public UaVariableNode(NodeManagerUaNode nodeManager,
                      NodeId nodeId,
                      QualifiedName browseName,
                      LocalizedText displayName)

Create a new variable with dataTypeId initialized to BaseDataType.

Parameters:

nodeId -

browseName -

displayName -

UaVariableNode

public UaVariableNode(NodeManagerUaNode nodeManager,
                      NodeId nodeId,
                      String name,
                      Locale locale)

Create a new variable with a specific data type.

Parameters:

nodeId - The variable ID.

name - The name used for browseName & displayName

locale - The locale of displayName

dataTypeId - The variable data type as a NodeId.

UaVariableNode

protected UaVariableNode(UaNode.Parameters parameters)

Method Detail

addProperty

public UaReference addProperty(UaProperty property)

Description copied from interface: UaNode

Add a new property node to the node. All other node types can have properties, except property nodes.

Adds a new forward HasProperty reference with target to the property node.

Specified by:

addProperty in interface UaNode

Overrides:

addProperty in class ServerNode

Parameters:

property - the property to add to the node

Returns:

the property reference that was added (or existed already) or null, if the reference type is not supported by the node (i.e. UaProperty may not have HasProperty references).

getAccessLevel

public AccessLevelType getAccessLevel()

Description copied from interface: UaVariable

Defines the global read/write access of the Value attribute for all users.

In contrast to the WriteAccess this attribute only applies to the Value attribute.

Specified by:

getAccessLevel in interface UaVariable

Returns:

the current global access rights

See Also:

UaVariable.getUserAccessLevel()

getArrayDimensions

public UnsignedInteger[] getArrayDimensions()

Description copied from interface: UaValueNode

This Attribute specifies the length of each dimension for an array value. The Attribute is intended to describe the capability of the Variable, not the current size.

The number of elements shall be equal to the value of the ValueRank Attribute. Shall be null if ValueRank <= 0.

A value of 0 for an individual dimension indicates that the dimension has a variable length.

For example, if a Variable is defined by the following C array: Int32 myArray[346];

then this Variable's DataType would point to an Int32, the Variable's ValueRank has the value 1 and the ArrayDimensions is an array with one entry having the value 346.

Specified by:

getArrayDimensions in interface UaValueNode

Returns:

the array dimensions of the variable type or null if this is not a specific array type, i.e. ValueRank <= 0

See Also:

UaValueNode.setArrayDimensions(com.prosysopc.ua.stack.builtintypes.UnsignedInteger[])

getAttributes

public NodeAttributes getAttributes()

Description copied from interface: UaNode

Returns the current attribute values of the node in a NodeAttributes structure.

Specified by:

getAttributes in interface UaNode

Specified by:

getAttributes in class BaseNode

getDataType

public UaDataType getDataType()

Specified by:

getDataType in interface UaValueNode

Returns:

the DataType node, if set.

See Also:

UaValueNode.getDataTypeId()

getDataTypeId

public NodeId getDataTypeId()

Specified by:

getDataTypeId in interface UaValueNode

Returns:

NodeId of the data type definition for instances of this type.

getHistorizing

public Boolean getHistorizing()

Specified by:

getHistorizing in interface UaVariable

Returns:

whether the variable has history

getMinimumSamplingInterval

public Double getMinimumSamplingInterval()

Specified by:

getMinimumSamplingInterval in interface UaVariable

Returns:

the minimum sampling interval that the server supports for the variable

getNodeClass

public final NodeClass getNodeClass()

Description copied from interface: UaNode

The NodeClass Attribute identifies the NodeClass of a Node.

Specified by:

getNodeClass in interface UaNode

Overrides:

getNodeClass in class BaseNode

Returns:

the Node Class of the node. This is hard-coded and cannot be changed.

getProperties

public UaProperty[] getProperties()

Description copied from interface: UaNode

Returns all properties of the node or null if none defined.

Specified by:

getProperties in interface UaNode

Overrides:

getProperties in class BaseNode

Returns:

all properties of the node or null

getStatus

public StatusCode getStatus()

Returns:

the current status of the variable value.

getUserAccessLevel

public AccessLevelType getUserAccessLevel()

Description copied from interface: UaVariable

Defines the user specific read/write access of the Value attribute.

In contrast to the UserWriteAccess this attribute only applies to the Value attribute.

Specified by:

getUserAccessLevel in interface UaVariable

Returns:

the current access rights for the user that requested it

See Also:

UaVariable.getAccessLevel()

getValueRank

public Integer getValueRank()

Description copied from interface: UaValueNode

This Attribute indicates whether the Value Attribute of the Variable is an array and how many dimensions the array has.

It may have the following values:

• n>1: the Value is an array with the specified number of dimensions.
• OneDimension (1): The value is an array with one dimension.
• OneOrMoreDimensions (0): The value is an array with one or more dimensions.
• Scalar (-1): The value is not an array.
• Any (-2): The value can be a scalar or an array with any number of dimensions.
• ScalarOrOneDimension (-3): The value can be a scalar or a one dimensional array.

Specified by:

getValueRank in interface UaValueNode

Returns:

the value rank

See Also:

UaValueNode.setValueRank(int)

hasUserWriteAccess

public boolean hasUserWriteAccess(UnsignedInteger attributeId)

Overrides the default to check access to Value attribute from AccessLevel.

Specified by:

hasUserWriteAccess in interface UaNode

Overrides:

hasUserWriteAccess in class BaseNode

Parameters:

attributeId -

Returns:

hasWriteAccess

public boolean hasWriteAccess(UnsignedInteger attributeId)

Overrides the default to check access to Value attribute from AccessLevel.

Specified by:

hasWriteAccess in interface UaNode

Overrides:

hasWriteAccess in class BaseNode

Parameters:

attributeId -

Returns:

notifyValueChanging

public void notifyValueChanging(Object newValue)

setAccessLevel

public void setAccessLevel(AccessLevelType accessLevel)

Specified by:

setAccessLevel in interface UaVariable

Parameters:

accessLevel - the access level to set

See Also:

UaVariable.getAccessLevel()

setArrayDimensions

public void setArrayDimensions(UnsignedInteger[] arrayDimensions)

Description copied from interface: UaValueNode

This Attribute specifies the length of each dimension for an array value. The Attribute is intended to describe the capability of the VariableType, not the current size.

The number of elements shall be equal to the value of the ValueRank Attribute. Shall be null if ValueRank <= 0.

A value of 0 for an individual dimension indicates that the dimension has a variable length.

For example, if a VariableType is defined by the following array:

Integer[] myArray = new Integer[346];

then this VariableType's DataType would point to the Int32 data type node, the VariableType's ValueRank has the value 1 and the ArrayDimensions is an array with one entry having the value 346.

Specified by:

setArrayDimensions in interface UaValueNode

setAttributes

public void setAttributes(NodeAttributes nodeAttributes)

Description copied from interface: UaNode

Sets the attributes of the node.

Specified by:

setAttributes in interface UaNode

Overrides:

setAttributes in class BaseNode

setDataType

public void setDataType(UaDataType dataType)

Description copied from interface: UaValueNode

Set the Data Type node.

Specified by:

setDataType in interface UaValueNode

See Also:

UaValueNode.setDataTypeId(NodeId)

setDataTypeId

public void setDataTypeId(NodeId dataTypeId)

Description copied from interface: UaValueNode

Set the Data Type.

Specified by:

setDataTypeId in interface UaValueNode

See Also:

UaValueNode.setDataTypeId(NodeId)

setHistorizing

public void setHistorizing(Boolean historizing)

Specified by:

setHistorizing in interface UaVariable

Parameters:

historizing - define that the variable has history - or not

setMinimumSamplingInterval

public void setMinimumSamplingInterval(Double minimumSamplingInterval)

Specified by:

setMinimumSamplingInterval in interface UaVariable

Parameters:

minimumSamplingInterval - define the minimum sampling interval

setStatus

public void setStatus(StatusCode status)

Set the status of the variable. If Status is a Bad status, Value is set to null.

The sourceTimestamp is set to null, and serverTimestamp is set to the current time.

Parameters:

status - the status to set

setTypeDefinition

public void setTypeDefinition(UaType type)

Description copied from class: UaInstanceNode

Sets the type of the node. Also sets typeDefinition, if type is not null. Type definitions are only available for the NodeClasses Object and Variable.

Specified by:

setTypeDefinition in interface UaInstance

Overrides:

setTypeDefinition in class UaInstanceNode

Parameters:

type - The type to set

See Also:

UaInstance.getTypeDefinitionId(), UaInstance.getTypeDefinition(), UaInstance.setTypeDefinitionId(ExpandedNodeId), UaInstance.setTypeDefinitionId(NodeId)

setTypeDefinitionId

public void setTypeDefinitionId(ExpandedNodeId typeDefinition)

Description copied from interface: UaInstance

Sets the type definition to an ExpandedNodeId.

Specified by:

setTypeDefinitionId in interface UaInstance

Overrides:

setTypeDefinitionId in class UaInstanceNode

Parameters:

typeDefinition - the type definition Id to set

See Also:

UaInstance.getTypeDefinitionId(), UaInstance.getTypeDefinition(), UaInstance.setTypeDefinition(UaType), UaInstance.setTypeDefinitionId(NodeId)

setUserAccessLevel

public void setUserAccessLevel(AccessLevelType userAccessLevel)

Specified by:

setUserAccessLevel in interface UaVariable

Parameters:

userAccessLevel - the user access level to set

See Also:

UaVariable.getUserAccessLevel()

setValue

public void setValue(DataValue value)
              throws StatusException

Description copied from interface: UaValueNode

The default Value for instances of this type.

Specified by:

setValue in interface UaValueNode

Parameters:

value - the default value to set

Throws:

StatusException

setValue

public void setValue(Object value)
              throws StatusException

Set value.

Specified by:

setValue in interface UaValueNode

Parameters:

value - a new value

Throws:

StatusException - if the value is invalid for the Value attribute

setValueRank

public void setValueRank(int valueRank)

Description copied from interface: UaValueNode

This Attribute indicates whether the Value Attribute of the VariableType is an array and how many dimensions the array has.

It may have the following values:

• n>1: the Value is an array with the specified number of dimensions.
• OneDimension (1): The value is an array with one dimension.
• OneOrMoreDimensions (0): The value is an array with one or more dimensions.
• Scalar (-1): The value is not an array.
• Any (-2): The value can be a scalar or an array with any number of dimensions.
• ScalarOrOneDimension (-3): The value can be a scalar or a one dimensional array.

Specified by:

setValueRank in interface UaValueNode

Parameters:

valueRank - the value rank to set

toString

public String toString()

Overrides:

toString in class UaInstanceNode

updateValue

public void updateValue(Object newValue)
                 throws StatusException

Update the current value and status. Server & source timestamp are set to the current time. The status will be set to StatusCode.GOOD, unless the value is null or is a Variant which contains null.

Parameters:

newValue - The new value for the variable. This should be of the correct DataType or a Variant. Or it can be a DataValue, in which case, it is copied to value with a new timestamp.

Throws:

StatusException - if newValue is not valid for the variable

addReflectiveVariable

protected ReflectiveVariable addReflectiveVariable(Object reflectedObject,
                                                   NodeId nodeId,
                                                   String fieldName,
                                                   int nameSpaceIndex,
                                                   NodeId typeDefinitionId)
                                            throws SecurityException,
                                                   NoSuchMethodException

Parameters:

reflectedObject -

nodeId -

fieldName -

nameSpaceIndex -

typeDefinitionId -

Returns:

Throws:

NoSuchMethodException

SecurityException

beforeAddReference

protected boolean beforeAddReference(UaReference reference)

Overrides:

beforeAddReference in class UaInstanceNode

Returns:

checkPropertyType

protected void checkPropertyType(ExpandedNodeId typeDefinition)

checkPropertyType

protected void checkPropertyType(NodeId nodeId)

Parameters:

nodeId -

Throws:

IllegalArgumentException

createDataValue

protected DataValue createDataValue(Object value)

doSetValue

protected abstract void doSetValue(DataValue value)
                            throws StatusException

Perform the actual value set.

Parameters:

value -

Throws:

StatusException

exposeStructureWithReflectiveVariables

protected void exposeStructureWithReflectiveVariables(Structure structure,
                                                      int nameSpaceIndex,
                                                      NodeId typeDefinitionId)

Parameters:

structure - a Structure type, auto-generated to the stack. It must define fields with capitalized names, e.g. "FieldName"

typeDefinitionId -

Throws:

SecurityException

RuntimeException

getAttributes

protected VariableAttributes getAttributes(VariableAttributes attributes)

getAttributesMap

protected void getAttributesMap(Map<UnsignedInteger,Object> map)

Overrides:

getAttributesMap in class BaseNode

getDefaultTypeDefinition

protected ExpandedNodeId getDefaultTypeDefinition()

Specified by:

getDefaultTypeDefinition in class UaInstanceNode

Returns:

initSupportedAttributes

protected void initSupportedAttributes(List<UnsignedInteger> l)

Overrides:

initSupportedAttributes in class ServerNode

isPropertyType

protected boolean isPropertyType()

Returns:

notifyValueChanging

protected void notifyValueChanging(DataValue newValue)

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.

semanticsChanged

protected void semanticsChanged()

Set the SemanticsChanged bit of statusCodeChangeBits (to be sent with the next notification) and add an entry to the SemanticChangeEvent.

structureChanged

protected void structureChanged()

Set the StructureChanged bit of statusCodeChangeBits (to be sent with the next notification).

updateValue

protected void updateValue(Object newValue,
                           StatusCode status,
                           DateTime sourceTime,
                           UnsignedShort sourcePicoseconds)
                    throws StatusException

Update the current value and status. Server timestamp is set to the current time.

Parameters:

newValue - The new value for the variable. This should be of the correct DataType or a Variant. Or it can be a DataValue, in which case, it is copied to value with a new timestamp.

status - The new status for the variable.

sourceTimestamp - source timestamp, if null current time is used

Throws:

StatusException - if newValue is not valid for the variable

writeAttributeValue

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

Overrides:

writeAttributeValue in class BaseNode

Throws:

StatusException