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

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

Class VectorTypeNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ThreeDVectorTypeNode

public class VectorTypeNode
extends BaseDataVariableTypeNode
implements VectorType

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

VECTOR_UNIT

Constructor Summary

Constructors

Constructor

Description

VectorTypeNode(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.EUInformation	getVectorUnit()	Get the local value of the VectorUnit Node.
PropertyTypeNode	getVectorUnitNode()	Get the VectorUnit PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getVectorUnitNodeAsync()	Asynchronous implementation of VectorType.getVectorUnitNode().
org.eclipse.milo.opcua.stack.core.types.structured.EUInformation	readVectorUnit()	Read the value of the VectorUnit Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation>	readVectorUnitAsync()	An asynchronous implementation of VectorType.readVectorUnit().
void	setVectorUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)	Set the local value of the VectorUnit Node.
void	writeVectorUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)	Write a new value for the VectorUnit Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeVectorUnitAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation vectorUnit)	An asynchronous implementation of VectorType.writeVectorUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation).

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

VectorTypeNode

public VectorTypeNode(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

getVectorUnit

public org.eclipse.milo.opcua.stack.core.types.structured.EUInformation getVectorUnit()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: VectorType

Get the local value of the VectorUnit Node.

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

Specified by:

getVectorUnit in interface VectorType

Returns:

the local value of the VectorUnit Node.

Throws:

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

setVectorUnit

public void setVectorUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: VectorType

Set the local value of the VectorUnit Node.

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

Specified by:

setVectorUnit in interface VectorType

Parameters:

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

Throws:

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

readVectorUnit

public org.eclipse.milo.opcua.stack.core.types.structured.EUInformation readVectorUnit()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: VectorType

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

Specified by:

readVectorUnit in interface VectorType

Returns:

the EUInformation value read from the server.

Throws:

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

writeVectorUnit

public void writeVectorUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: VectorType

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

Specified by:

writeVectorUnit in interface VectorType

Parameters:

value - the EUInformation value to write to the server.

Throws:

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

readVectorUnitAsync

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

Description copied from interface: VectorType

An asynchronous implementation of VectorType.readVectorUnit().

Specified by:

readVectorUnitAsync in interface VectorType

Returns:

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

writeVectorUnitAsync

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

Description copied from interface: VectorType

An asynchronous implementation of VectorType.writeVectorUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation).

Specified by:

writeVectorUnitAsync in interface VectorType

Returns:

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

getVectorUnitNode

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

Description copied from interface: VectorType

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

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

Specified by:

getVectorUnitNode in interface VectorType

Returns:

the VectorUnit 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.

getVectorUnitNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getVectorUnitNodeAsync()

Description copied from interface: VectorType

Asynchronous implementation of VectorType.getVectorUnitNode().

Specified by:

getVectorUnitNodeAsync in interface VectorType

Returns:

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