Class UaVariableNode
- All Implemented Interfaces:
org.eclipse.milo.opcua.sdk.core.nodes.Node,org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
- Direct Known Subclasses:
BaseVariableTypeNode
-
Field Summary
-
Constructor Summary
ConstructorsConstructorDescriptionUaVariableNode(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) Construct aUaVariableNodeusing only attributes defined prior to OPC UA 1.04.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.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, 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, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx) Construct aUaVariableNodeusing all attributes, including those defined by OPC UA 1.04. -
Method Summary
Modifier and TypeMethodDescriptionorg.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte@Nullable org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExTypeorg.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[]protected org.eclipse.milo.opcua.stack.core.types.builtin.DataValuegetAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId) org.eclipse.milo.opcua.stack.core.types.builtin.NodeId@Nullable DoubleCompletableFuture<? extends UaVariableTypeNode>org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByteorg.eclipse.milo.opcua.stack.core.types.builtin.DataValuegetValue()getVariableComponent(String name) Get theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.getVariableComponent(String namespaceUri, String name) Get theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.getVariableComponent(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) Get theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.CompletableFuture<? extends UaVariableNode>CompletableFuture<? extends UaVariableNode>getVariableComponentAsync(String namespaceUri, String name) CompletableFuture<? extends UaVariableNode>getVariableComponentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByteRead the AccessLevel attribute for this Node from the server and update the local attribute if the operation succeeds.@Nullable org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExTypeRead the AccessLevelEx attribute for this Node from the server and update the local attribute if the operation succeeds.CompletableFuture<? extends Boolean>Get the value of the AllowNulls Property, if it exists.@Nullable org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[]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.NodeIdRead the DataType attribute for this Node from the server and update the local attribute if the operation succeeds.CompletableFuture<? extends String>Get the value of theVariableNodeProperties.DataTypeVersionProperty, if it exists.CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>Get the value of theVariableNodeProperties.DictionaryFragmentProperty, if it exists.CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation>Get the value of theVariableNodeProperties.EngineeringUnitsProperty, if it exists.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>Get the value of theVariableNodeProperties.LocalTimeProperty, if it exists.CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>Get the value of theVariableNodeProperties.MaxArrayLengthProperty, if it exists.CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>Get the value of theVariableNodeProperties.MaxStringLengthProperty, if it exists.@Nullable DoubleRead the MinimumSamplingInterval attribute for this Node from the server and update the local attribute if the operation succeeds.CompletableFuture<? extends String>Get the value of theVariableNodeProperties.NodeVersionProperty, if it exists.org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByteRead 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.DataValueRead 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>Get the value of theVariableNodeProperties.ValueAsTextProperty, if it exists.Read the ValueRank attribute for this Node from the server and update the local attribute if the operation succeeds.voidsetAccessLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel) voidsetAccessLevelEx(org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx) voidsetArrayDimensions(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions) protected voidsetAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value) voidsetDataType(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType) voidsetHistorizing(Boolean historizing) voidsetMinimumSamplingInterval(Double minimumSamplingInterval) voidsetUserAccessLevel(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel) voidsetValue(org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value) voidsetValue(org.eclipse.milo.opcua.stack.core.types.builtin.Variant variant) Set the local Value attribute to aDataValuecontainingvariantwith no StatusCode or timestamp values.voidsetValueRank(Integer valueRank) voidwriteAccessLevel(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.voidwriteAccessLevelEx(org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx) Write a new AccessLevelEx 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 theVariableNodeProperties.AllowNullsProperty, if it exists.voidwriteArrayDimensions(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.voidwriteDataType(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 theVariableNodeProperties.DataTypeVersionProperty, 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 theVariableNodeProperties.DictionaryFragmentProperty, 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 theVariableNodeProperties.EngineeringUnitsProperty, if it exists.voidwriteHistorizing(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 theVariableNodeProperties.LocalTimeProperty, 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 theVariableNodeProperties.MaxArrayLengthProperty, 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 theVariableNodeProperties.MaxStringLengthProperty, if it exists.voidwriteMinimumSamplingInterval(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 theVariableNodeProperties.NodeVersionProperty, if it exists.voidwriteUserAccessLevel(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.voidwriteValue(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.voidwriteValue(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 theVariableNodeProperties.ValueAsTextProperty, if it exists.voidwriteValueRank(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, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, writeUserWriteMask, writeWriteMaskMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node
getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask
-
Constructor Details
-
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) Construct aUaVariableNodeusing only attributes defined prior to OPC UA 1.04. -
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.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, 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, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx) Construct aUaVariableNodeusing all attributes, including those defined by OPC UA 1.04.
-
-
Method Details
-
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:
getValuein interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
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:
getDataTypein interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
getValueRank
The returned attribute is the most recently seen value; it is not read live from the server.
- Specified by:
getValueRankin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
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:
getArrayDimensionsin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
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:
getAccessLevelin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
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:
getUserAccessLevelin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
getMinimumSamplingInterval
The returned attribute is the most recently seen value; it is not read live from the server.
- Specified by:
getMinimumSamplingIntervalin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
getHistorizing
The returned attribute is the most recently seen value; it is not read live from the server.
- Specified by:
getHistorizingin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
getAccessLevelEx
public @Nullable org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType getAccessLevelEx()The returned attribute is the most recently seen value; it is not read live from the server.
- Specified by:
getAccessLevelExin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
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:
setValuein interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
setValue
public void setValue(org.eclipse.milo.opcua.stack.core.types.builtin.Variant variant) Set the local Value attribute to aDataValuecontainingvariantwith no StatusCode or timestamp values.- Parameters:
variant- theVariantto set.- See Also:
-
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:
setDataTypein interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
setValueRank
The attribute is only updated locally; it is not written to the server.
- Specified by:
setValueRankin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
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:
setArrayDimensionsin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
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:
setAccessLevelin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
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:
setUserAccessLevelin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
setMinimumSamplingInterval
The attribute is only updated locally; it is not written to the server.
- Specified by:
setMinimumSamplingIntervalin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
setHistorizing
The attribute is only updated locally; it is not written to the server.
- Specified by:
setHistorizingin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
setAccessLevelEx
public void setAccessLevelEx(org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx) The attribute is only updated locally; it is not written to the server.
- Specified by:
setAccessLevelExin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.VariableNode- See Also:
-
readValue
public org.eclipse.milo.opcua.stack.core.types.builtin.DataValue readValue() throws org.eclipse.milo.opcua.stack.core.UaExceptionRead 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
DataValueis not good quality and the local attribute value is updated without regard for status.- Returns:
- the
DataValueread 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.UaExceptionRead the DataType attribute for this Node from the server and update the local attribute if the operation succeeds.- Returns:
- the
NodeIdread from the server. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
readValueRank
Read the ValueRank attribute for this Node from the server and update the local attribute if the operation succeeds.- Returns:
- the
Integerread from the server. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
readArrayDimensions
public @Nullable org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] readArrayDimensions() throws org.eclipse.milo.opcua.stack.core.UaExceptionRead 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
StatusCodes0.Bad_AttributeIdInvalidanullvalue is returned instead.Note that
nullis 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
UIntegerarray 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.UaExceptionRead the AccessLevel attribute for this Node from the server and update the local attribute if the operation succeeds.- Returns:
- the
UByteread 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.UaExceptionRead the UserAccessLevel attribute for this Node from the server and update the local attribute if the operation succeeds.- Returns:
- the
UByteread 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
public @Nullable Double readMinimumSamplingInterval() throws org.eclipse.milo.opcua.stack.core.UaExceptionRead 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
StatusCodes0.Bad_AttributeIdInvalidanullvalue is returned instead.- Returns:
- the
Doubleread from the server, ornullif the attribute does not exist. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
readHistorizing
Read the Historizing attribute for this Node from the server and update the local attribute if the operation succeeds.- Returns:
- the
Booleanread from the server. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
readAccessLevelEx
public @Nullable org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType readAccessLevelEx() throws org.eclipse.milo.opcua.stack.core.UaExceptionRead the AccessLevelEx attribute for this Node from the server and update the local attribute if the operation succeeds.- Returns:
- the
AccessLevelExTyperead 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- theDataValueto 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
DataValuewith no StatusCode or timestamp values.- Parameters:
variant- theVariantto 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- theNodeIdto write to the server.- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
writeValueRank
Write a new ValueRank attribute for this Node to the server and update the local attribute if the operation succeeds.- Parameters:
valueRank- theIntegerto 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- theUIntegerarray 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- theUByteto 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- theUByteto 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- theDoubleto 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- theBooleanto write to the server.- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
writeAccessLevelEx
public void writeAccessLevelEx(org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx) throws org.eclipse.milo.opcua.stack.core.UaException Write a new AccessLevelEx attribute for this Node to the server and update the local attribute if the operation succeeds.- Parameters:
accessLevelEx- theAccessLevelExTypeto 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 theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.- Parameters:
name- the browse name of theUaVariableNodecomponent.- Returns:
- the
UaVariableNodecomponent, 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 theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.- Parameters:
namespaceUri- the namespace URI the browse name belongs to.name- the browse name of theUaVariableNodecomponent.- Returns:
- the
UaVariableNodecomponent, 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 theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.- Parameters:
browseName- the browse name of theUaVariableNodecomponent.- Returns:
- the
UaVariableNodecomponent, 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
-
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
- Throws:
org.eclipse.milo.opcua.stack.core.UaException
-
getTypeDefinitionAsync
-
readNodeVersionAsync
Get the value of theVariableNodeProperties.NodeVersionProperty, 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 theVariableNodeProperties.LocalTimeProperty, if it exists.- Returns:
- the value of the LocalTime Property, if it exists.
- See Also:
-
VariableNodeProperties
-
readDataTypeVersionAsync
Get the value of theVariableNodeProperties.DataTypeVersionProperty, 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 theVariableNodeProperties.DictionaryFragmentProperty, if it exists.- Returns:
- the value of the DictionaryFragment Property, if it exists.
- See Also:
-
VariableNodeProperties
-
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 theVariableNodeProperties.ValueAsTextProperty, 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 theVariableNodeProperties.MaxStringLengthProperty, 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 theVariableNodeProperties.MaxArrayLengthProperty, 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 theVariableNodeProperties.EngineeringUnitsProperty, 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 theVariableNodeProperties.NodeVersionProperty, if it exists.- Parameters:
nodeVersion- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof 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 theVariableNodeProperties.LocalTimeProperty, if it exists.- Parameters:
localTime- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof 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 theVariableNodeProperties.DataTypeVersionProperty, if it exists.- Parameters:
dataTypeVersion- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof 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 theVariableNodeProperties.DictionaryFragmentProperty, if it exists.- Parameters:
dictionaryFragment- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof 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 theVariableNodeProperties.AllowNullsProperty, if it exists.- Parameters:
allowNulls- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof 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 theVariableNodeProperties.ValueAsTextProperty, if it exists.- Parameters:
valueAsText- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof 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 theVariableNodeProperties.MaxStringLengthProperty, if it exists.- Parameters:
maxStringLength- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof 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 theVariableNodeProperties.MaxArrayLengthProperty, if it exists.- Parameters:
maxArrayLength- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof 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 theVariableNodeProperties.EngineeringUnitsProperty, if it exists.- Parameters:
engineeringUnits- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof 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:
getAttributeValuein classUaNode
-
setAttributeValue
protected void setAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value) - Overrides:
setAttributeValuein classUaNode
-