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

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

Class ThreeDFrameTypeNode

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

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

All Implemented Interfaces:

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

public class ThreeDFrameTypeNode
extends FrameTypeNode
implements ThreeDFrameType

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

CONSTANT, FIXED_BASE

Constructor Summary

Constructors

Constructor

Description

ThreeDFrameTypeNode(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.ThreeDCartesianCoordinates	getCartesianCoordinates()	Get the local value of the CartesianCoordinates Node.
ThreeDCartesianCoordinatesTypeNode	getCartesianCoordinatesNode()	Get the CartesianCoordinates CartesianCoordinatesType Node, or null if it does not exist.
CompletableFuture<? extends ThreeDCartesianCoordinatesTypeNode>	getCartesianCoordinatesNodeAsync()	Asynchronous implementation of FrameType.getCartesianCoordinatesNode().
org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation	getOrientation()	Get the local value of the Orientation Node.
ThreeDOrientationTypeNode	getOrientationNode()	Get the Orientation OrientationType Node, or null if it does not exist.
CompletableFuture<? extends ThreeDOrientationTypeNode>	getOrientationNodeAsync()	Asynchronous implementation of FrameType.getOrientationNode().
org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates	readCartesianCoordinates()	Read the value of the CartesianCoordinates Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates>	readCartesianCoordinatesAsync()	An asynchronous implementation of FrameType.readCartesianCoordinates().
org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation	readOrientation()	Read the value of the Orientation Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation>	readOrientationAsync()	An asynchronous implementation of FrameType.readOrientation().
void	setCartesianCoordinates(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates value)	Set the local value of the CartesianCoordinates Node.
void	setOrientation(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation value)	Set the local value of the Orientation Node.
void	writeCartesianCoordinates(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates value)	Write a new value for the CartesianCoordinates Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCartesianCoordinatesAsync(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates cartesianCoordinates)	An asynchronous implementation of ThreeDFrameType.writeCartesianCoordinates(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates).
void	writeOrientation(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation value)	Write a new value for the Orientation Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeOrientationAsync(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation orientation)	An asynchronous implementation of ThreeDFrameType.writeOrientation(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation).

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

getBaseFrame, getBaseFrameNode, getBaseFrameNodeAsync, getConstant, getConstantNode, getConstantNodeAsync, getFixedBase, getFixedBaseNode, getFixedBaseNodeAsync, readBaseFrame, readBaseFrameAsync, readConstant, readConstantAsync, readFixedBase, readFixedBaseAsync, setBaseFrame, setCartesianCoordinates, setConstant, setFixedBase, setOrientation, writeBaseFrame, writeBaseFrameAsync, writeCartesianCoordinates, writeCartesianCoordinatesAsync, writeConstant, writeConstantAsync, writeFixedBase, writeFixedBaseAsync, writeOrientation, writeOrientationAsync

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.client.model.variables.FrameType

getBaseFrame, getBaseFrameNode, getBaseFrameNodeAsync, getConstant, getConstantNode, getConstantNodeAsync, getFixedBase, getFixedBaseNode, getFixedBaseNodeAsync, readBaseFrame, readBaseFrameAsync, readConstant, readConstantAsync, readFixedBase, readFixedBaseAsync, setBaseFrame, setCartesianCoordinates, setConstant, setFixedBase, setOrientation, writeBaseFrame, writeBaseFrameAsync, writeCartesianCoordinates, writeCartesianCoordinatesAsync, writeConstant, writeConstantAsync, writeFixedBase, writeFixedBaseAsync, writeOrientation, writeOrientationAsync

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

ThreeDFrameTypeNode

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

getCartesianCoordinates

public org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates getCartesianCoordinates()
                                                                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

Get the local value of the CartesianCoordinates Node.

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

Specified by:

getCartesianCoordinates in interface FrameType

Specified by:

getCartesianCoordinates in interface ThreeDFrameType

Overrides:

getCartesianCoordinates in class FrameTypeNode

Returns:

the local value of the CartesianCoordinates Node.

Throws:

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

setCartesianCoordinates

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

Description copied from interface: ThreeDFrameType

Set the local value of the CartesianCoordinates Node.

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

Specified by:

setCartesianCoordinates in interface ThreeDFrameType

Parameters:

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

Throws:

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

readCartesianCoordinates

public org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates readCartesianCoordinates()
                                                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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

Specified by:

readCartesianCoordinates in interface FrameType

Specified by:

readCartesianCoordinates in interface ThreeDFrameType

Overrides:

readCartesianCoordinates in class FrameTypeNode

Returns:

the CartesianCoordinates value read from the server.

Throws:

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

writeCartesianCoordinates

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

Description copied from interface: ThreeDFrameType

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

Specified by:

writeCartesianCoordinates in interface ThreeDFrameType

Parameters:

value - the ThreeDCartesianCoordinates value to write to the server.

Throws:

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

readCartesianCoordinatesAsync

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

Description copied from interface: FrameType

An asynchronous implementation of FrameType.readCartesianCoordinates().

Specified by:

readCartesianCoordinatesAsync in interface FrameType

Specified by:

readCartesianCoordinatesAsync in interface ThreeDFrameType

Overrides:

readCartesianCoordinatesAsync in class FrameTypeNode

Returns:

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

writeCartesianCoordinatesAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCartesianCoordinatesAsync(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates cartesianCoordinates)

Description copied from interface: ThreeDFrameType

An asynchronous implementation of ThreeDFrameType.writeCartesianCoordinates(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDCartesianCoordinates).

Specified by:

writeCartesianCoordinatesAsync in interface ThreeDFrameType

Returns:

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

getCartesianCoordinatesNode

public ThreeDCartesianCoordinatesTypeNode getCartesianCoordinatesNode()
                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

Get the CartesianCoordinates CartesianCoordinatesType Node, or null if it does not exist.

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

Specified by:

getCartesianCoordinatesNode in interface FrameType

Specified by:

getCartesianCoordinatesNode in interface ThreeDFrameType

Overrides:

getCartesianCoordinatesNode in class FrameTypeNode

Returns:

the CartesianCoordinates CartesianCoordinatesType 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.

getCartesianCoordinatesNodeAsync

public CompletableFuture<? extends ThreeDCartesianCoordinatesTypeNode> getCartesianCoordinatesNodeAsync()

Description copied from interface: FrameType

Asynchronous implementation of FrameType.getCartesianCoordinatesNode().

Specified by:

getCartesianCoordinatesNodeAsync in interface FrameType

Specified by:

getCartesianCoordinatesNodeAsync in interface ThreeDFrameType

Overrides:

getCartesianCoordinatesNodeAsync in class FrameTypeNode

Returns:

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

getOrientation

public org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation getOrientation()
                                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

Get the local value of the Orientation Node.

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

Specified by:

getOrientation in interface FrameType

Specified by:

getOrientation in interface ThreeDFrameType

Overrides:

getOrientation in class FrameTypeNode

Returns:

the local value of the Orientation Node.

Throws:

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

setOrientation

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

Description copied from interface: ThreeDFrameType

Set the local value of the Orientation Node.

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

Specified by:

setOrientation in interface ThreeDFrameType

Parameters:

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

Throws:

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

readOrientation

public org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation readOrientation()
                                                                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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

Specified by:

readOrientation in interface FrameType

Specified by:

readOrientation in interface ThreeDFrameType

Overrides:

readOrientation in class FrameTypeNode

Returns:

the Orientation value read from the server.

Throws:

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

writeOrientation

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

Description copied from interface: ThreeDFrameType

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

Specified by:

writeOrientation in interface ThreeDFrameType

Parameters:

value - the ThreeDOrientation value to write to the server.

Throws:

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

readOrientationAsync

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

Description copied from interface: FrameType

An asynchronous implementation of FrameType.readOrientation().

Specified by:

readOrientationAsync in interface FrameType

Specified by:

readOrientationAsync in interface ThreeDFrameType

Overrides:

readOrientationAsync in class FrameTypeNode

Returns:

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

writeOrientationAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeOrientationAsync(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation orientation)

Description copied from interface: ThreeDFrameType

An asynchronous implementation of ThreeDFrameType.writeOrientation(org.eclipse.milo.opcua.stack.core.types.structured.ThreeDOrientation).

Specified by:

writeOrientationAsync in interface ThreeDFrameType

Returns:

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

getOrientationNode

public ThreeDOrientationTypeNode getOrientationNode()
                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

Get the Orientation OrientationType Node, or null if it does not exist.

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

Specified by:

getOrientationNode in interface FrameType

Specified by:

getOrientationNode in interface ThreeDFrameType

Overrides:

getOrientationNode in class FrameTypeNode

Returns:

the Orientation OrientationType 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.

getOrientationNodeAsync

public CompletableFuture<? extends ThreeDOrientationTypeNode> getOrientationNodeAsync()

Description copied from interface: FrameType

Asynchronous implementation of FrameType.getOrientationNode().

Specified by:

getOrientationNodeAsync in interface FrameType

Specified by:

getOrientationNodeAsync in interface ThreeDFrameType

Overrides:

getOrientationNodeAsync in class FrameTypeNode

Returns:

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