org.eclipse.milo.opcua.sdk.server.nodes

Class UaVariableNode

java.lang.Object

org.eclipse.milo.opcua.sdk.server.nodes.UaNode

org.eclipse.milo.opcua.sdk.server.nodes.UaVariableNode

All Implemented Interfaces:

Node, VariableNode, UaServerNode

Direct Known Subclasses:

BaseVariableTypeNode, UaPropertyNode

public class UaVariableNode
extends UaNode
implements VariableNode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UaVariableNode.UaVariableNodeBuilder

Constructor Summary

Constructors

Constructor and Description
UaVariableNode(UaNodeContext context, NodeId nodeId, QualifiedName browseName, LocalizedText displayName)
UaVariableNode(UaNodeContext context, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, LocalizedText description, UInteger writeMask, UInteger userWriteMask)
UaVariableNode(UaNodeContext context, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, LocalizedText description, UInteger writeMask, UInteger userWriteMask, DataValue value, NodeId dataType, Integer valueRank, UInteger[] arrayDimensions, UByte accessLevel, UByte userAccessLevel, Double minimumSamplingInterval, boolean historizing)
UaVariableNode(UaNodeContext context, NodeId nodeId, VariableTypeNode variableTypeNode)

Method Summary

Modifier and Type	Method and Description
void	addComponent(UaNode node) Add a 'HasComponent' reference from this Object to node and an inverse 'ComponentOf' reference from node back to this Object.
static UaVariableNode	build(UaNodeContext context, Function<UaVariableNode.UaVariableNodeBuilder,UaVariableNode> build) Build a UaVariableNode using the UaVariableNode.UaVariableNodeBuilder supplied to the build function.
static UaVariableNode.UaVariableNodeBuilder	builder(UaNodeContext context) Deprecated. use UaVariableNodeBuilder#UaVariableNodeBuilder(UaNodeContext) or build(UaNodeContext, Function).
UByte	getAccessLevel()
@Nullable Boolean	getAllowNulls() Get the value of the AllowNulls Property, if it exists.
UInteger[]	getArrayDimensions()
Object	getAttribute(AttributeId attributeId) Direct read access to the field for attributeId, bypassing the AttributeFilterChain.
List<Node>	getComponentNodes()
NodeId	getDataType()
@Nullable String	getDataTypeVersion() Get the value of the DataTypeVersion Property, if it exists.
@Nullable ByteString	getDictionaryFragment() Get the value of the DictionaryFragment Property, if it exists.
@Nullable EUInformation	getEngineeringUnits() Get the value of the EngineeringUnits Property, if it exists.
Boolean	getHistorizing()
@Nullable TimeZoneDataType	getLocalTime() Get the value of the LocalTime Property, if it exists.
@Nullable UInteger	getMaxArrayLength() Get the value of the MaxArrayLength Property, if it exists.
@Nullable UInteger	getMaxStringLength() Get the value of the MaxStringLength Property, if it exists.
Double	getMinimumSamplingInterval()
Optional<ObjectNode>	getModellingRuleNode()
@Nullable String	getNodeVersion() Get the value of the NodeVersion Property, if it exists.
List<Node>	getPropertyNodes()
VariableTypeNode	getTypeDefinitionNode()
UByte	getUserAccessLevel()
DataValue	getValue()
Integer	getValueRank()
void	removeComponent(UaNode node) Remove the 'HasComponent' reference from this Object to node and the inverse 'ComponentOf' reference from node back to this Object.
void	setAccessLevel(UByte accessLevel)
void	setAllowNulls(Boolean allowNulls) Set the value of the AllowNulls Property.
void	setArrayDimensions(UInteger[] arrayDimensions)
void	setAttribute(AttributeId attributeId, Object value) Direct write access to the field for attributeId, bypassing the AttributeFilterChain.
void	setDataType(NodeId dataType)
void	setDataTypeVersion(String dataTypeVersion) Set the value of the DataTypeVersion Property.
void	setDictionaryFragment(ByteString dictionaryFragment) Set the value of the DictionaryFragment Property.
void	setEngineeringUnits(EUInformation engineeringUnits) Set the value of the EngineeringUnits Property.
void	setHistorizing(Boolean historizing)
void	setLocalTime(TimeZoneDataType localTime) Set the value of the LocalTime Property.
void	setMaxArrayLength(UInteger maxArrayLength) Set the value of the MaxArrayLength Property.
void	setMaxStringLength(UInteger maxStringLength) Set the value of the MaxStringLength Property.
void	setMinimumSamplingInterval(Double minimumSamplingInterval)
void	setNodeVersion(String nodeVersion) Set the value of the NodeVersion Property.
void	setUserAccessLevel(UByte userAccessLevel)
void	setValue(DataValue value)
void	setValueRank(Integer valueRank)

Methods inherited from class org.eclipse.milo.opcua.sdk.server.nodes.UaNode

addAttributeObserver, addReference, delete, findNode, findNode, findNode, findNode, fireAttributeChanged, getAttribute, getAttributeDelegate, getBrowseName, getDescription, getDisplayName, getFilterChain, getManagedNode, getManagedNode, getNodeClass, getNodeContext, getNodeId, getNodeManager, getObjectComponent, getObjectComponent, getObjectComponent, getProperty, getProperty, getPropertyNode, getPropertyNode, getPropertyNode, getReferences, getUserWriteMask, getVariableComponent, getVariableComponent, getVariableComponent, getWriteMask, removeAttributeObserver, removeReference, setAttribute, setAttributeDelegate, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setUserWriteMask, setWriteMask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.nodes.UaServerNode

readAttribute, readAttribute, readAttribute, writeAttribute, writeAttribute

Constructor Detail

UaVariableNode

public UaVariableNode(UaNodeContext context,
                      NodeId nodeId,
                      VariableTypeNode variableTypeNode)

UaVariableNode

public UaVariableNode(UaNodeContext context,
                      NodeId nodeId,
                      QualifiedName browseName,
                      LocalizedText displayName)

UaVariableNode

public UaVariableNode(UaNodeContext context,
                      NodeId nodeId,
                      QualifiedName browseName,
                      LocalizedText displayName,
                      LocalizedText description,
                      UInteger writeMask,
                      UInteger userWriteMask)

UaVariableNode

public UaVariableNode(UaNodeContext context,
                      NodeId nodeId,
                      QualifiedName browseName,
                      LocalizedText displayName,
                      LocalizedText description,
                      UInteger writeMask,
                      UInteger userWriteMask,
                      DataValue value,
                      NodeId dataType,
                      Integer valueRank,
                      UInteger[] arrayDimensions,
                      UByte accessLevel,
                      UByte userAccessLevel,
                      Double minimumSamplingInterval,
                      boolean historizing)

Method Detail

getValue

public DataValue getValue()

Specified by:

getValue in interface VariableNode

getDataType

public NodeId getDataType()

Specified by:

getDataType in interface VariableNode

getValueRank

public Integer getValueRank()

Specified by:

getValueRank in interface VariableNode

getArrayDimensions

public UInteger[] getArrayDimensions()

Specified by:

getArrayDimensions in interface VariableNode

getAccessLevel

public UByte getAccessLevel()

Specified by:

getAccessLevel in interface VariableNode

getUserAccessLevel

public UByte getUserAccessLevel()

Specified by:

getUserAccessLevel in interface VariableNode

getMinimumSamplingInterval

public Double getMinimumSamplingInterval()

Specified by:

getMinimumSamplingInterval in interface VariableNode

getHistorizing

public Boolean getHistorizing()

Specified by:

getHistorizing in interface VariableNode

setValue

public void setValue(DataValue value)

Specified by:

setValue in interface VariableNode

setDataType

public void setDataType(NodeId dataType)

Specified by:

setDataType in interface VariableNode

setValueRank

public void setValueRank(Integer valueRank)

Specified by:

setValueRank in interface VariableNode

setArrayDimensions

public void setArrayDimensions(UInteger[] arrayDimensions)

Specified by:

setArrayDimensions in interface VariableNode

setAccessLevel

public void setAccessLevel(UByte accessLevel)

Specified by:

setAccessLevel in interface VariableNode

setUserAccessLevel

public void setUserAccessLevel(UByte userAccessLevel)

Specified by:

setUserAccessLevel in interface VariableNode

setMinimumSamplingInterval

public void setMinimumSamplingInterval(Double minimumSamplingInterval)

Specified by:

setMinimumSamplingInterval in interface VariableNode

setHistorizing

public void setHistorizing(Boolean historizing)

Specified by:

setHistorizing in interface VariableNode

getAttribute

public Object getAttribute(AttributeId attributeId)

Description copied from class: UaNode

Direct read access to the field for attributeId, bypassing the AttributeFilterChain.

Overrides:

getAttribute in class UaNode

Parameters:

attributeId - the AttributeId to get the value for.

Returns:

the value for attributeId.

setAttribute

public void setAttribute(AttributeId attributeId,
                         Object value)

Description copied from class: UaNode

Direct write access to the field for attributeId, bypassing the AttributeFilterChain.

Setting an attribute value invokes UaNode.fireAttributeChanged(AttributeId, Object), notifying any registered AttributeObservers of the change.

Overrides:

setAttribute in class UaNode

Parameters:

attributeId - the AttributeId to set the value for.

value - the value to set.

getModellingRuleNode

public Optional<ObjectNode> getModellingRuleNode()

getPropertyNodes

public List<Node> getPropertyNodes()

getComponentNodes

public List<Node> getComponentNodes()

getTypeDefinitionNode

public VariableTypeNode getTypeDefinitionNode()

addComponent

public void addComponent(UaNode node)

Add a 'HasComponent' reference from this Object to node and an inverse 'ComponentOf' reference from node back to this Object.

Parameters:

node - the node to add as a component of this Object.

removeComponent

public void removeComponent(UaNode node)

Remove the 'HasComponent' reference from this Object to node and the inverse 'ComponentOf' reference from node back to this Object.

Parameters:

node - the node to remove as a component of this Object.

getNodeVersion

@Nullable
public @Nullable String getNodeVersion()

Get the value of the NodeVersion Property, if it exists.

Returns:

the value of the NodeVersion Property, if it exists.

See Also:

VariableNodeProperties.NodeVersion

getLocalTime

@Nullable
public @Nullable TimeZoneDataType getLocalTime()

Get the value of the LocalTime Property, if it exists.

Returns:

the value of the LocalTime Property, if it exists.

See Also:

VariableNodeProperties.LocalTime

getDataTypeVersion

@Nullable
public @Nullable String getDataTypeVersion()

Get the value of the DataTypeVersion Property, if it exists.

Returns:

the value of the DataTypeVersion Property, if it exists.

See Also:

VariableNodeProperties.DataTypeVersion

getDictionaryFragment

@Nullable
public @Nullable ByteString getDictionaryFragment()

Get the value of the DictionaryFragment Property, if it exists.

Returns:

the value of the DictionaryFragment Property, if it exists.

See Also:

VariableNodeProperties.DictionaryFragment

getAllowNulls

@Nullable
public @Nullable Boolean getAllowNulls()

Get the value of the AllowNulls Property, if it exists.

Returns:

the value of the AllowNulls Property, if it exists.

See Also:

VariableNodeProperties.AllowNulls

getMaxStringLength

@Nullable
public @Nullable UInteger getMaxStringLength()

Get the value of the MaxStringLength Property, if it exists.

Returns:

the value of the MaxStringLength Property, if it exists.

See Also:

VariableNodeProperties.MaxStringLength

getMaxArrayLength

@Nullable
public @Nullable UInteger getMaxArrayLength()

Get the value of the MaxArrayLength Property, if it exists.

Returns:

the value of the MaxArrayLength Property, if it exists.

See Also:

VariableNodeProperties.MaxArrayLength

getEngineeringUnits

@Nullable
public @Nullable EUInformation getEngineeringUnits()

Get the value of the EngineeringUnits Property, if it exists.

Returns:

the value of the EngineeringUnits Property, if it exists.

See Also:

VariableNodeProperties.EngineeringUnits

setNodeVersion

public void setNodeVersion(String nodeVersion)

Set the value of the NodeVersion Property.

A PropertyNode will be created if it does not already exist.

Parameters:

nodeVersion - the value to set.

See Also:

VariableNodeProperties.NodeVersion

setLocalTime

public void setLocalTime(TimeZoneDataType localTime)

Set the value of the LocalTime Property.

A PropertyNode will be created if it does not already exist.

Parameters:

localTime - the value to set.

See Also:

VariableNodeProperties.LocalTime

setDataTypeVersion

public void setDataTypeVersion(String dataTypeVersion)

Set the value of the DataTypeVersion Property.

A PropertyNode will be created if it does not already exist.

Parameters:

dataTypeVersion - the value to set.

See Also:

VariableNodeProperties.DataTypeVersion

setDictionaryFragment

public void setDictionaryFragment(ByteString dictionaryFragment)

Set the value of the DictionaryFragment Property.

A PropertyNode will be created if it does not already exist.

Parameters:

dictionaryFragment - the value to set.

See Also:

VariableNodeProperties.DictionaryFragment

setAllowNulls

public void setAllowNulls(Boolean allowNulls)

Set the value of the AllowNulls Property.

A PropertyNode will be created if it does not already exist.

Parameters:

allowNulls - the value to set.

See Also:

VariableNodeProperties.AllowNulls

setMaxStringLength

public void setMaxStringLength(UInteger maxStringLength)

Set the value of the MaxStringLength Property.

A PropertyNode will be created if it does not already exist.

Parameters:

maxStringLength - the value to set.

See Also:

VariableNodeProperties.MaxStringLength

setMaxArrayLength

public void setMaxArrayLength(UInteger maxArrayLength)

Set the value of the MaxArrayLength Property.

A PropertyNode will be created if it does not already exist.

Parameters:

maxArrayLength - the value to set.

See Also:

VariableNodeProperties.MaxArrayLength

setEngineeringUnits

public void setEngineeringUnits(EUInformation engineeringUnits)

Set the value of the EngineeringUnits Property.

A PropertyNode will be created if it does not already exist.

Parameters:

engineeringUnits - the value to set.

See Also:

VariableNodeProperties.EngineeringUnits

builder

@Deprecated
public static UaVariableNode.UaVariableNodeBuilder builder(UaNodeContext context)

Deprecated. use UaVariableNodeBuilder#UaVariableNodeBuilder(UaNodeContext) or build(UaNodeContext, Function).

build

public static UaVariableNode build(UaNodeContext context,
                                   Function<UaVariableNode.UaVariableNodeBuilder,UaVariableNode> build)

Build a UaVariableNode using the UaVariableNode.UaVariableNodeBuilder supplied to the build function.

Parameters:

context - a UaNodeContext.

build - a function that accepts a UaVariableNode.UaVariableNodeBuilder and uses it to build and return a UaVariableNode.

Returns:

a UaVariableNode built using the supplied UaVariableNode.UaVariableNodeBuilder.