Module org.eclipse.milo.opcua.sdk.client

Package org.eclipse.milo.opcua.sdk.client.model.variables

Class ReferenceDescriptionVariableTypeNode

java.lang.Object

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

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

org.eclipse.milo.opcua.sdk.client.model.variables.BaseVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.variables.BaseDataVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.variables.ReferenceDescriptionVariableTypeNode

All Implemented Interfaces:

BaseDataVariableType, BaseVariableType, ReferenceDescriptionVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

public class ReferenceDescriptionVariableTypeNode
extends BaseDataVariableTypeNode
implements ReferenceDescriptionVariableType

Field Summary

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

client

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.ReferenceDescriptionVariableType

REFERENCE_REFINEMENT

Constructor Summary

Constructors

Constructor

Description

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

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[]	getReferenceRefinement()	Get the local value of the ReferenceRefinement Node.
PropertyTypeNode	getReferenceRefinementNode()	Get the ReferenceRefinement PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getReferenceRefinementNodeAsync()	Asynchronous implementation of ReferenceDescriptionVariableType.getReferenceRefinementNode().
org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[]	readReferenceRefinement()	Read the value of the ReferenceRefinement Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[]>	readReferenceRefinementAsync()	An asynchronous implementation of ReferenceDescriptionVariableType.readReferenceRefinement().
void	setReferenceRefinement(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] value)	Set the local value of the ReferenceRefinement Node.
void	writeReferenceRefinement(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] value)	Write a new value for the ReferenceRefinement Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeReferenceRefinementAsync(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] referenceRefinement)	An asynchronous implementation of ReferenceDescriptionVariableType.writeReferenceRefinement(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[]).

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

getAccessLevel, getAccessLevelEx, getArrayDimensions, getAttributeValue, getDataType, getHistorizing, getMinimumSamplingInterval, getTypeDefinition, getTypeDefinitionAsync, getUserAccessLevel, getValue, getValueRank, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readAccessLevel, readAccessLevelEx, readAllowNullsAsync, readArrayDimensions, readDataType, readDataTypeVersionAsync, readDictionaryFragmentAsync, readEngineeringUnitsAsync, readHistorizing, readLocalTimeAsync, readMaxArrayLengthAsync, readMaxStringLengthAsync, readMinimumSamplingInterval, readNodeVersionAsync, readUserAccessLevel, readValue, readValueAsTextAsync, readValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setAttributeValue, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValue, setValueRank, writeAccessLevel, writeAccessLevelEx, writeAllowNullsAsync, writeArrayDimensions, writeDataType, writeDataTypeVersionAsync, writeDictionaryFragmentAsync, writeEngineeringUnitsAsync, writeHistorizing, writeLocalTimeAsync, writeMaxArrayLengthAsync, writeMaxStringLengthAsync, writeMinimumSamplingInterval, writeNodeVersionAsync, writeUserAccessLevel, writeValue, writeValue, writeValueAsTextAsync, writeValueRank

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

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

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

getAccessLevel, getAccessLevelEx, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

Constructor Details

ReferenceDescriptionVariableTypeNode

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

Method Details

getReferenceRefinement

public org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] getReferenceRefinement()
                                                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ReferenceDescriptionVariableType

Get the local value of the ReferenceRefinement Node.

The returned value is the last seen; it is not read live from the server.

Specified by:

getReferenceRefinement in interface ReferenceDescriptionVariableType

Returns:

the local value of the ReferenceRefinement Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ReferenceRefinement Node.

setReferenceRefinement

public void setReferenceRefinement(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] value)
                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ReferenceDescriptionVariableType

Set the local value of the ReferenceRefinement Node.

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

Specified by:

setReferenceRefinement in interface ReferenceDescriptionVariableType

Parameters:

value - the local value to set for the ReferenceRefinement Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ReferenceRefinement Node.

readReferenceRefinement

public org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] readReferenceRefinement()
                                                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ReferenceDescriptionVariableType

Read the value of the ReferenceRefinement Node from the server and update the local value if the operation succeeds.

Specified by:

readReferenceRefinement in interface ReferenceDescriptionVariableType

Returns:

the ReferenceListEntryDataType value read from the server.

Throws:

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

writeReferenceRefinement

public void writeReferenceRefinement(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] value)
                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ReferenceDescriptionVariableType

Write a new value for the ReferenceRefinement Node to the server and update the local value if the operation succeeds.

Specified by:

writeReferenceRefinement in interface ReferenceDescriptionVariableType

Parameters:

value - the ReferenceListEntryDataType value to write to the server.

Throws:

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

readReferenceRefinementAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[]> readReferenceRefinementAsync()

Description copied from interface: ReferenceDescriptionVariableType

An asynchronous implementation of ReferenceDescriptionVariableType.readReferenceRefinement().

Specified by:

readReferenceRefinementAsync in interface ReferenceDescriptionVariableType

Returns:

a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

writeReferenceRefinementAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeReferenceRefinementAsync(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[] referenceRefinement)

Description copied from interface: ReferenceDescriptionVariableType

An asynchronous implementation of ReferenceDescriptionVariableType.writeReferenceRefinement(org.eclipse.milo.opcua.stack.core.types.structured.ReferenceListEntryDataType[]).

Specified by:

writeReferenceRefinementAsync in interface ReferenceDescriptionVariableType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getReferenceRefinementNode

public PropertyTypeNode getReferenceRefinementNode()
                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ReferenceDescriptionVariableType

Get the ReferenceRefinement PropertyType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Specified by:

getReferenceRefinementNode in interface ReferenceDescriptionVariableType

Returns:

the ReferenceRefinement PropertyType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getReferenceRefinementNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getReferenceRefinementNodeAsync()

Description copied from interface: ReferenceDescriptionVariableType

Asynchronous implementation of ReferenceDescriptionVariableType.getReferenceRefinementNode().

Specified by:

getReferenceRefinementNodeAsync in interface ReferenceDescriptionVariableType

Returns:

a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.