org.eclipse.milo.opcua.sdk.client.nodes

Class UaVariableNode

java.lang.Object

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

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

All Implemented Interfaces:

Node, VariableNode

Direct Known Subclasses:

BaseVariableTypeNode

public class UaVariableNode
extends UaNode
implements VariableNode

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

client

Constructor Summary

Constructors

Constructor and Description

UaVariableNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing)

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	getAccessLevel()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[]	getArrayDimensions()
protected org.eclipse.milo.opcua.stack.core.types.builtin.DataValue	getAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId)
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getDataType()
Boolean	getHistorizing()
Double	getMinimumSamplingInterval()
UaVariableTypeNode	getTypeDefinition()
CompletableFuture<? extends UaVariableTypeNode>	getTypeDefinitionAsync()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	getUserAccessLevel()
org.eclipse.milo.opcua.stack.core.types.builtin.DataValue	getValue()
Integer	getValueRank()
UaVariableNode	getVariableComponent(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) Get the UaVariableNode referenced by a HasComponent reference type with a browse name of name, if it exists.
UaVariableNode	getVariableComponent(String name) Get the UaVariableNode referenced by a HasComponent reference type with a browse name of name, if it exists.
UaVariableNode	getVariableComponent(String namespaceUri, String name) Get the UaVariableNode referenced by a HasComponent reference type with a browse name of name, if it exists.
CompletableFuture<? extends UaVariableNode>	getVariableComponentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName)
CompletableFuture<? extends UaVariableNode>	getVariableComponentAsync(String name)
CompletableFuture<? extends UaVariableNode>	getVariableComponentAsync(String namespaceUri, String name)
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	readAccessLevel() Read the AccessLevel attribute for this Node from the server and update the local attribute if the operation succeeds.
CompletableFuture<? extends Boolean>	readAllowNullsAsync() Get the value of the AllowNulls Property, if it exists.
@Nullable org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[]	readArrayDimensions() Read the ArrayDimensions attribute for this Node from the server and update the local attribute if the operation succeeds.
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readDataType() Read the DataType attribute for this Node from the server and update the local attribute if the operation succeeds.
CompletableFuture<? extends String>	readDataTypeVersionAsync() Get the value of the VariableNodeProperties.DataTypeVersion Property, if it exists.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>	readDictionaryFragmentAsync() Get the value of the VariableNodeProperties.DictionaryFragment Property, if it exists.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation>	readEngineeringUnitsAsync() Get the value of the VariableNodeProperties.EngineeringUnits Property, if it exists.
Boolean	readHistorizing() Read the Historizing attribute for this Node from the server and update the local attribute if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType>	readLocalTimeAsync() Get the value of the VariableNodeProperties.LocalTime Property, if it exists.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readMaxArrayLengthAsync() Get the value of the VariableNodeProperties.MaxArrayLength Property, if it exists.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readMaxStringLengthAsync() Get the value of the VariableNodeProperties.MaxStringLength Property, if it exists.
@Nullable Double	readMinimumSamplingInterval() Read the MinimumSamplingInterval attribute for this Node from the server and update the local attribute if the operation succeeds.
CompletableFuture<? extends String>	readNodeVersionAsync() Get the value of the VariableNodeProperties.NodeVersion Property, if it exists.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	readUserAccessLevel() Read the UserAccessLevel attribute for this Node from the server and update the local attribute if the operation succeeds.
org.eclipse.milo.opcua.stack.core.types.builtin.DataValue	readValue() Read the Value attribute for this Node from the server and update the local attribute.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readValueAsTextAsync() Get the value of the VariableNodeProperties.ValueAsText Property, if it exists.
Integer	readValueRank() Read the ValueRank attribute for this Node from the server and update the local attribute if the operation succeeds.
void	setAccessLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel)
void	setArrayDimensions(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions)
protected void	setAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)
void	setDataType(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType)
void	setHistorizing(Boolean historizing)
void	setMinimumSamplingInterval(Double minimumSamplingInterval)
void	setUserAccessLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel)
void	setValue(org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)
void	setValue(org.eclipse.milo.opcua.stack.core.types.builtin.Variant variant) Set the local Value attribute to a DataValue containing variant with no StatusCode or timestamp values.
void	setValueRank(Integer valueRank)
void	writeAccessLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel) Write a new AccessLevel attribute for this Node to the server and update the local attribute if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeAllowNullsAsync(Boolean allowNulls) Set the value of the VariableNodeProperties.AllowNulls Property, if it exists.
void	writeArrayDimensions(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions) Write a new ArrayDimensions attribute for this Node to the server and update the local attribute if the operation succeeds.
void	writeDataType(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType) Write a new DataType attribute for this Node to the server and update the local attribute if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDataTypeVersionAsync(String dataTypeVersion) Set the value of the VariableNodeProperties.DataTypeVersion Property, if it exists.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDictionaryFragmentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString dictionaryFragment) Set the value of the VariableNodeProperties.DictionaryFragment Property, if it exists.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEngineeringUnitsAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation engineeringUnits) Set the value of the VariableNodeProperties.EngineeringUnits Property, if it exists.
void	writeHistorizing(Boolean historizing) Write a new Historizing attribute for this Node to the server and update the local attribute if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLocalTimeAsync(org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType localTime) Set the value of the VariableNodeProperties.LocalTime Property, if it exists.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMaxArrayLengthAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxArrayLength) Set the value of the VariableNodeProperties.MaxArrayLength Property, if it exists.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMaxStringLengthAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxStringLength) Set the value of the VariableNodeProperties.MaxStringLength Property, if it exists.
void	writeMinimumSamplingInterval(Double minimumSamplingInterval) Write a new MinimumSamplingInterval attribute for this Node to the server and update the local attribute if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNodeVersionAsync(String nodeVersion) Set the value of the VariableNodeProperties.NodeVersion Property, if it exists.
void	writeUserAccessLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel) Write a new UserAccessLevel attribute for this Node to the server and update the local attribute if the operation succeeds.
void	writeValue(org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value) Write a new Value attribute for this Node to the server and update the local attribute if the operation succeeds.
void	writeValue(org.eclipse.milo.opcua.stack.core.types.builtin.Variant variant) Write a new Value attribute for this Node to the server and update the local attribute if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeValueAsTextAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText valueAsText) Set the value of the VariableNodeProperties.ValueAsText Property, if it exists.
void	writeValueRank(Integer valueRank) Write a new ValueRank attribute for this Node to the server and update the local attribute if the operation succeeds.

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

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getUserWriteMask, getWriteMask, invalidate, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readUserWriteMask, readWriteMask, refresh, refreshAsync, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeUserWriteMask, writeWriteMask

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

Constructor Detail

UaVariableNode

public UaVariableNode(OpcUaClient client,
                      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
                      org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass,
                      org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName,
                      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName,
                      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description,
                      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask,
                      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask,
                      org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value,
                      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType,
                      Integer valueRank,
                      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions,
                      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel,
                      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel,
                      Double minimumSamplingInterval,
                      Boolean historizing)

Method Detail

getValue

public org.eclipse.milo.opcua.stack.core.types.builtin.DataValue getValue()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getValue in interface VariableNode

See Also:

readValue()

getDataType

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getDataType()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getDataType in interface VariableNode

See Also:

readDataType()

getValueRank

public Integer getValueRank()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getValueRank in interface VariableNode

See Also:

readValueRank()

getArrayDimensions

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] getArrayDimensions()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getArrayDimensions in interface VariableNode

See Also:

readArrayDimensions()

getAccessLevel

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte getAccessLevel()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getAccessLevel in interface VariableNode

See Also:

readAccessLevel()

getUserAccessLevel

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte getUserAccessLevel()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getUserAccessLevel in interface VariableNode

See Also:

readUserAccessLevel()

getMinimumSamplingInterval

public Double getMinimumSamplingInterval()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getMinimumSamplingInterval in interface VariableNode

See Also:

readMinimumSamplingInterval()

getHistorizing

public Boolean getHistorizing()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getHistorizing in interface VariableNode

See Also:

readHistorizing()

setValue

public void setValue(org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)

The attribute is only updated locally; it is not written to the server.

Specified by:

setValue in interface VariableNode

See Also:

writeValue(DataValue)

setValue

public void setValue(org.eclipse.milo.opcua.stack.core.types.builtin.Variant variant)

Set the local Value attribute to a DataValue containing variant with no StatusCode or timestamp values.

Parameters:

variant - the Variant to set.

See Also:

setValue(DataValue)

setDataType

public void setDataType(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType)

The attribute is only updated locally; it is not written to the server.

Specified by:

setDataType in interface VariableNode

See Also:

writeDataType(NodeId)

setValueRank

public void setValueRank(Integer valueRank)

The attribute is only updated locally; it is not written to the server.

Specified by:

setValueRank in interface VariableNode

See Also:

writeValueRank(Integer)

setArrayDimensions

public void setArrayDimensions(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions)

The attribute is only updated locally; it is not written to the server.

Specified by:

setArrayDimensions in interface VariableNode

See Also:

writeArrayDimensions(UInteger[])

setAccessLevel

public void setAccessLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel)

The attribute is only updated locally; it is not written to the server.

Specified by:

setAccessLevel in interface VariableNode

See Also:

writeAccessLevel(UByte)

setUserAccessLevel

public void setUserAccessLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel)

The attribute is only updated locally; it is not written to the server.

Specified by:

setUserAccessLevel in interface VariableNode

See Also:

writeUserAccessLevel(UByte)

setMinimumSamplingInterval

public void setMinimumSamplingInterval(Double minimumSamplingInterval)

The attribute is only updated locally; it is not written to the server.

Specified by:

setMinimumSamplingInterval in interface VariableNode

See Also:

writeMinimumSamplingInterval(Double)

setHistorizing

public void setHistorizing(Boolean historizing)

The attribute is only updated locally; it is not written to the server.

Specified by:

setHistorizing in interface VariableNode

See Also:

writeHistorizing(Boolean)

readValue

public org.eclipse.milo.opcua.stack.core.types.builtin.DataValue readValue()
                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Read the Value attribute for this Node from the server and update the local attribute.

Unlike reads for other attributes this call does not fail if the resulting DataValue is not good quality and the local attribute value is updated without regard for status.

Returns:

the DataValue read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service-level error occurs.

readDataType

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readDataType()
                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Read the DataType attribute for this Node from the server and update the local attribute if the operation succeeds.

Returns:

the NodeId read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readValueRank

public Integer readValueRank()
                      throws org.eclipse.milo.opcua.stack.core.UaException

Read the ValueRank attribute for this Node from the server and update the local attribute if the operation succeeds.

Returns:

the Integer read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readArrayDimensions

@Nullable
public @Nullable org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] readArrayDimensions()
                                                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Read the ArrayDimensions attribute for this Node from the server and update the local attribute if the operation succeeds.

ArrayDimensions is an optional attribute. If the operation fails with StatusCodes.Bad_AttributeIdInvalid a null value is returned instead.

Note that null is an expected value for the ArrayDimensions attribute in some cases and this call does not distinguish between the attribute existing with a null value and the attribute not existing.

Returns:

the UInteger array read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readAccessLevel

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte readAccessLevel()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Read the AccessLevel attribute for this Node from the server and update the local attribute if the operation succeeds.

Returns:

the UByte read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

See Also:

AccessLevel.fromValue(UByte)

readUserAccessLevel

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte readUserAccessLevel()
                                                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Read the UserAccessLevel attribute for this Node from the server and update the local attribute if the operation succeeds.

Returns:

the UByte read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

See Also:

AccessLevel.fromValue(UByte)

readMinimumSamplingInterval

@Nullable
public @Nullable Double readMinimumSamplingInterval()
                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Read the MinimumSamplingInterval attribute for this Node from the server and update the local attribute if the operation succeeds.

MinimumSamplingInterval is an optional attribute. If the operation fails with StatusCodes.Bad_AttributeIdInvalid a null value is returned instead.

Returns:

the Double read from the server, or null if the attribute does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readHistorizing

public Boolean readHistorizing()
                        throws org.eclipse.milo.opcua.stack.core.UaException

Read the Historizing attribute for this Node from the server and update the local attribute if the operation succeeds.

Returns:

the Boolean read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeValue

public void writeValue(org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)
                throws org.eclipse.milo.opcua.stack.core.UaException

Write a new Value attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

value - the DataValue to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeValue

public void writeValue(org.eclipse.milo.opcua.stack.core.types.builtin.Variant variant)
                throws org.eclipse.milo.opcua.stack.core.UaException

Write a new Value attribute for this Node to the server and update the local attribute if the operation succeeds.

This overload creates a DataValue with no StatusCode or timestamp values.

Parameters:

variant - the Variant to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeDataType

public void writeDataType(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Write a new DataType attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

dataType - the NodeId to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeValueRank

public void writeValueRank(Integer valueRank)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Write a new ValueRank attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

valueRank - the Integer to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeArrayDimensions

public void writeArrayDimensions(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Write a new ArrayDimensions attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

arrayDimensions - the UInteger array to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeAccessLevel

public void writeAccessLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Write a new AccessLevel attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

accessLevel - the UByte to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeUserAccessLevel

public void writeUserAccessLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Write a new UserAccessLevel attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

userAccessLevel - the UByte to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeMinimumSamplingInterval

public void writeMinimumSamplingInterval(Double minimumSamplingInterval)
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Write a new MinimumSamplingInterval attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

minimumSamplingInterval - the Double to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeHistorizing

public void writeHistorizing(Boolean historizing)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Write a new Historizing attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

historizing - the Boolean to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

getVariableComponent

public UaVariableNode getVariableComponent(String name)
                                    throws org.eclipse.milo.opcua.stack.core.UaException

Get the UaVariableNode referenced by a HasComponent reference type with a browse name of name, if it exists.

Parameters:

name - the browse name of the UaVariableNode component.

Returns:

the UaVariableNode component, if it exists.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if the node could not be found or an operation- or service-level error occurs.

getVariableComponent

public UaVariableNode getVariableComponent(String namespaceUri,
                                           String name)
                                    throws org.eclipse.milo.opcua.stack.core.UaException

Get the UaVariableNode referenced by a HasComponent reference type with a browse name of name, if it exists.

Parameters:

namespaceUri - the namespace URI the browse name belongs to.

name - the browse name of the UaVariableNode component.

Returns:

the UaVariableNode component, if it exists.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if the node could not be found or an operation- or service-level error occurs.

getVariableComponent

public UaVariableNode getVariableComponent(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName)
                                    throws org.eclipse.milo.opcua.stack.core.UaException

Get the UaVariableNode referenced by a HasComponent reference type with a browse name of name, if it exists.

Parameters:

browseName - the browse name of the UaVariableNode component.

Returns:

the UaVariableNode component, if it exists.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if the node could not be found or an operation- or service-level error occurs.

getVariableComponentAsync

public CompletableFuture<? extends UaVariableNode> getVariableComponentAsync(String name)

getVariableComponentAsync

public CompletableFuture<? extends UaVariableNode> getVariableComponentAsync(String namespaceUri,
                                                                             String name)

getVariableComponentAsync

public CompletableFuture<? extends UaVariableNode> getVariableComponentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName)

getTypeDefinition

public UaVariableTypeNode getTypeDefinition()
                                     throws org.eclipse.milo.opcua.stack.core.UaException

Throws:

org.eclipse.milo.opcua.stack.core.UaException

getTypeDefinitionAsync

public CompletableFuture<? extends UaVariableTypeNode> getTypeDefinitionAsync()

readNodeVersionAsync

public CompletableFuture<? extends String> readNodeVersionAsync()

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

Returns:

the value of the NodeVersion Property, if it exists.

See Also:

VariableNodeProperties

readLocalTimeAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType> readLocalTimeAsync()

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

Returns:

the value of the LocalTime Property, if it exists.

See Also:

VariableNodeProperties

readDataTypeVersionAsync

public CompletableFuture<? extends String> readDataTypeVersionAsync()

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

Returns:

the value of the DataTypeVersion Property, if it exists.

See Also:

VariableNodeProperties

readDictionaryFragmentAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> readDictionaryFragmentAsync()

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

Returns:

the value of the DictionaryFragment Property, if it exists.

See Also:

VariableNodeProperties

readAllowNullsAsync

public CompletableFuture<? extends Boolean> readAllowNullsAsync()

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

Returns:

the value of the AllowNulls Property, if it exists.

See Also:

VariableNodeProperties.AllowNulls

readValueAsTextAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readValueAsTextAsync()

Get the value of the VariableNodeProperties.ValueAsText Property, if it exists.

Returns:

the value of the ValueAsText Property, if it exists.

See Also:

VariableNodeProperties

readMaxStringLengthAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readMaxStringLengthAsync()

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

Returns:

the value of the MaxStringLength Property, if it exists.

See Also:

VariableNodeProperties

readMaxArrayLengthAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readMaxArrayLengthAsync()

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

Returns:

the value of the MaxArrayLength Property, if it exists.

See Also:

VariableNodeProperties

readEngineeringUnitsAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation> readEngineeringUnitsAsync()

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

Returns:

the value of the EngineeringUnits Property, if it exists.

See Also:

VariableNodeProperties

writeNodeVersionAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNodeVersionAsync(String nodeVersion)

Set the value of the VariableNodeProperties.NodeVersion Property, if it exists.

Parameters:

nodeVersion - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

VariableNodeProperties

writeLocalTimeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLocalTimeAsync(org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType localTime)

Set the value of the VariableNodeProperties.LocalTime Property, if it exists.

Parameters:

localTime - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

VariableNodeProperties

writeDataTypeVersionAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDataTypeVersionAsync(String dataTypeVersion)

Set the value of the VariableNodeProperties.DataTypeVersion Property, if it exists.

Parameters:

dataTypeVersion - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

VariableNodeProperties

writeDictionaryFragmentAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDictionaryFragmentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString dictionaryFragment)

Set the value of the VariableNodeProperties.DictionaryFragment Property, if it exists.

Parameters:

dictionaryFragment - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

VariableNodeProperties

writeAllowNullsAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeAllowNullsAsync(Boolean allowNulls)

Set the value of the VariableNodeProperties.AllowNulls Property, if it exists.

Parameters:

allowNulls - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

VariableNodeProperties

writeValueAsTextAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeValueAsTextAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText valueAsText)

Set the value of the VariableNodeProperties.ValueAsText Property, if it exists.

Parameters:

valueAsText - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

VariableNodeProperties

writeMaxStringLengthAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMaxStringLengthAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxStringLength)

Set the value of the VariableNodeProperties.MaxStringLength Property, if it exists.

Parameters:

maxStringLength - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

VariableNodeProperties

writeMaxArrayLengthAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMaxArrayLengthAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxArrayLength)

Set the value of the VariableNodeProperties.MaxArrayLength Property, if it exists.

Parameters:

maxArrayLength - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

VariableNodeProperties

writeEngineeringUnitsAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEngineeringUnitsAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation engineeringUnits)

Set the value of the VariableNodeProperties.EngineeringUnits Property, if it exists.

Parameters:

engineeringUnits - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

VariableNodeProperties

getAttributeValue

protected org.eclipse.milo.opcua.stack.core.types.builtin.DataValue getAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId)

Overrides:

getAttributeValue in class UaNode

setAttributeValue

protected void setAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId,
                                 org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)

Overrides:

setAttributeValue in class UaNode