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

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

Class ThreeDVectorTypeNode

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

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

All Implemented Interfaces:

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

public class ThreeDVectorTypeNode
extends VectorTypeNode
implements ThreeDVectorType

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

ThreeDVectorTypeNode(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
Double	getX()	Get the local value of the X Node.
BaseDataVariableTypeNode	getXNode()	Get the X BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getXNodeAsync()	Asynchronous implementation of ThreeDVectorType.getXNode().
Double	getY()	Get the local value of the Y Node.
BaseDataVariableTypeNode	getYNode()	Get the Y BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getYNodeAsync()	Asynchronous implementation of ThreeDVectorType.getYNode().
Double	getZ()	Get the local value of the Z Node.
BaseDataVariableTypeNode	getZNode()	Get the Z BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getZNodeAsync()	Asynchronous implementation of ThreeDVectorType.getZNode().
Double	readX()	Read the value of the X Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readXAsync()	An asynchronous implementation of ThreeDVectorType.readX().
Double	readY()	Read the value of the Y Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readYAsync()	An asynchronous implementation of ThreeDVectorType.readY().
Double	readZ()	Read the value of the Z Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readZAsync()	An asynchronous implementation of ThreeDVectorType.readZ().
void	setX(Double value)	Set the local value of the X Node.
void	setY(Double value)	Set the local value of the Y Node.
void	setZ(Double value)	Set the local value of the Z Node.
void	writeX(Double value)	Write a new value for the X Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeXAsync(Double x)	An asynchronous implementation of ThreeDVectorType.writeX(java.lang.Double).
void	writeY(Double value)	Write a new value for the Y Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeYAsync(Double y)	An asynchronous implementation of ThreeDVectorType.writeY(java.lang.Double).
void	writeZ(Double value)	Write a new value for the Z Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeZAsync(Double z)	An asynchronous implementation of ThreeDVectorType.writeZ(java.lang.Double).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.variables.VectorTypeNode

getVectorUnit, getVectorUnitNode, getVectorUnitNodeAsync, readVectorUnit, readVectorUnitAsync, setVectorUnit, writeVectorUnit, writeVectorUnitAsync

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

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.VectorType

getVectorUnit, getVectorUnitNode, getVectorUnitNodeAsync, readVectorUnit, readVectorUnitAsync, setVectorUnit, writeVectorUnit, writeVectorUnitAsync

Constructor Details

ThreeDVectorTypeNode

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

getX

public Double getX()
            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

Get the local value of the X Node.

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

Specified by:

getX in interface ThreeDVectorType

Returns:

the local value of the X Node.

Throws:

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

setX

public void setX(Double value)
          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

Set the local value of the X Node.

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

Specified by:

setX in interface ThreeDVectorType

Parameters:

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

Throws:

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

readX

public Double readX()
             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

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

Specified by:

readX in interface ThreeDVectorType

Returns:

the Double value read from the server.

Throws:

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

writeX

public void writeX(Double value)
            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

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

Specified by:

writeX in interface ThreeDVectorType

Parameters:

value - the Double value to write to the server.

Throws:

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

readXAsync

public CompletableFuture<? extends Double> readXAsync()

Description copied from interface: ThreeDVectorType

An asynchronous implementation of ThreeDVectorType.readX().

Specified by:

readXAsync in interface ThreeDVectorType

Returns:

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

writeXAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeXAsync(Double x)

Description copied from interface: ThreeDVectorType

An asynchronous implementation of ThreeDVectorType.writeX(java.lang.Double).

Specified by:

writeXAsync in interface ThreeDVectorType

Returns:

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

getXNode

public BaseDataVariableTypeNode getXNode()
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

Get the X BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getXNode in interface ThreeDVectorType

Returns:

the X BaseDataVariableType 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.

getXNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getXNodeAsync()

Description copied from interface: ThreeDVectorType

Asynchronous implementation of ThreeDVectorType.getXNode().

Specified by:

getXNodeAsync in interface ThreeDVectorType

Returns:

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

getY

public Double getY()
            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

Get the local value of the Y Node.

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

Specified by:

getY in interface ThreeDVectorType

Returns:

the local value of the Y Node.

Throws:

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

setY

public void setY(Double value)
          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

Set the local value of the Y Node.

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

Specified by:

setY in interface ThreeDVectorType

Parameters:

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

Throws:

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

readY

public Double readY()
             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

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

Specified by:

readY in interface ThreeDVectorType

Returns:

the Double value read from the server.

Throws:

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

writeY

public void writeY(Double value)
            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

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

Specified by:

writeY in interface ThreeDVectorType

Parameters:

value - the Double value to write to the server.

Throws:

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

readYAsync

public CompletableFuture<? extends Double> readYAsync()

Description copied from interface: ThreeDVectorType

An asynchronous implementation of ThreeDVectorType.readY().

Specified by:

readYAsync in interface ThreeDVectorType

Returns:

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

writeYAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeYAsync(Double y)

Description copied from interface: ThreeDVectorType

An asynchronous implementation of ThreeDVectorType.writeY(java.lang.Double).

Specified by:

writeYAsync in interface ThreeDVectorType

Returns:

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

getYNode

public BaseDataVariableTypeNode getYNode()
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

Get the Y BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getYNode in interface ThreeDVectorType

Returns:

the Y BaseDataVariableType 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.

getYNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getYNodeAsync()

Description copied from interface: ThreeDVectorType

Asynchronous implementation of ThreeDVectorType.getYNode().

Specified by:

getYNodeAsync in interface ThreeDVectorType

Returns:

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

getZ

public Double getZ()
            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

Get the local value of the Z Node.

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

Specified by:

getZ in interface ThreeDVectorType

Returns:

the local value of the Z Node.

Throws:

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

setZ

public void setZ(Double value)
          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

Set the local value of the Z Node.

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

Specified by:

setZ in interface ThreeDVectorType

Parameters:

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

Throws:

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

readZ

public Double readZ()
             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

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

Specified by:

readZ in interface ThreeDVectorType

Returns:

the Double value read from the server.

Throws:

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

writeZ

public void writeZ(Double value)
            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

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

Specified by:

writeZ in interface ThreeDVectorType

Parameters:

value - the Double value to write to the server.

Throws:

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

readZAsync

public CompletableFuture<? extends Double> readZAsync()

Description copied from interface: ThreeDVectorType

An asynchronous implementation of ThreeDVectorType.readZ().

Specified by:

readZAsync in interface ThreeDVectorType

Returns:

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

writeZAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeZAsync(Double z)

Description copied from interface: ThreeDVectorType

An asynchronous implementation of ThreeDVectorType.writeZ(java.lang.Double).

Specified by:

writeZAsync in interface ThreeDVectorType

Returns:

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

getZNode

public BaseDataVariableTypeNode getZNode()
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ThreeDVectorType

Get the Z BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getZNode in interface ThreeDVectorType

Returns:

the Z BaseDataVariableType 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.

getZNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getZNodeAsync()

Description copied from interface: ThreeDVectorType

Asynchronous implementation of ThreeDVectorType.getZNode().

Specified by:

getZNodeAsync in interface ThreeDVectorType

Returns:

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