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

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

Class FrameTypeNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ThreeDFrameTypeNode

public class FrameTypeNode
extends BaseDataVariableTypeNode
implements FrameType

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

FrameTypeNode(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.builtin.NodeId	getBaseFrame()	Get the local value of the BaseFrame Node.
BaseDataVariableTypeNode	getBaseFrameNode()	Get the BaseFrame BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getBaseFrameNodeAsync()	Asynchronous implementation of FrameType.getBaseFrameNode().
org.eclipse.milo.opcua.stack.core.types.structured.CartesianCoordinates	getCartesianCoordinates()	Get the local value of the CartesianCoordinates Node.
CartesianCoordinatesTypeNode	getCartesianCoordinatesNode()	Get the CartesianCoordinates CartesianCoordinatesType Node, or null if it does not exist.
CompletableFuture<? extends CartesianCoordinatesTypeNode>	getCartesianCoordinatesNodeAsync()	Asynchronous implementation of FrameType.getCartesianCoordinatesNode().
Boolean	getConstant()	Get the local value of the Constant Node.
PropertyTypeNode	getConstantNode()	Get the Constant PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getConstantNodeAsync()	Asynchronous implementation of FrameType.getConstantNode().
Boolean	getFixedBase()	Get the local value of the FixedBase Node.
PropertyTypeNode	getFixedBaseNode()	Get the FixedBase PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getFixedBaseNodeAsync()	Asynchronous implementation of FrameType.getFixedBaseNode().
org.eclipse.milo.opcua.stack.core.types.structured.Orientation	getOrientation()	Get the local value of the Orientation Node.
OrientationTypeNode	getOrientationNode()	Get the Orientation OrientationType Node, or null if it does not exist.
CompletableFuture<? extends OrientationTypeNode>	getOrientationNodeAsync()	Asynchronous implementation of FrameType.getOrientationNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readBaseFrame()	Read the value of the BaseFrame Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readBaseFrameAsync()	An asynchronous implementation of FrameType.readBaseFrame().
org.eclipse.milo.opcua.stack.core.types.structured.CartesianCoordinates	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.CartesianCoordinates>	readCartesianCoordinatesAsync()	An asynchronous implementation of FrameType.readCartesianCoordinates().
Boolean	readConstant()	Read the value of the Constant Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readConstantAsync()	An asynchronous implementation of FrameType.readConstant().
Boolean	readFixedBase()	Read the value of the FixedBase Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readFixedBaseAsync()	An asynchronous implementation of FrameType.readFixedBase().
org.eclipse.milo.opcua.stack.core.types.structured.Orientation	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.Orientation>	readOrientationAsync()	An asynchronous implementation of FrameType.readOrientation().
void	setBaseFrame(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)	Set the local value of the BaseFrame Node.
void	setCartesianCoordinates(org.eclipse.milo.opcua.stack.core.types.structured.CartesianCoordinates value)	Set the local value of the CartesianCoordinates Node.
void	setConstant(Boolean value)	Set the local value of the Constant Node.
void	setFixedBase(Boolean value)	Set the local value of the FixedBase Node.
void	setOrientation(org.eclipse.milo.opcua.stack.core.types.structured.Orientation value)	Set the local value of the Orientation Node.
void	writeBaseFrame(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)	Write a new value for the BaseFrame Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeBaseFrameAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId baseFrame)	An asynchronous implementation of FrameType.writeBaseFrame(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).
void	writeCartesianCoordinates(org.eclipse.milo.opcua.stack.core.types.structured.CartesianCoordinates 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.CartesianCoordinates cartesianCoordinates)	An asynchronous implementation of FrameType.writeCartesianCoordinates(org.eclipse.milo.opcua.stack.core.types.structured.CartesianCoordinates).
void	writeConstant(Boolean value)	Write a new value for the Constant Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConstantAsync(Boolean constant)	An asynchronous implementation of FrameType.writeConstant(java.lang.Boolean).
void	writeFixedBase(Boolean value)	Write a new value for the FixedBase Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeFixedBaseAsync(Boolean fixedBase)	An asynchronous implementation of FrameType.writeFixedBase(java.lang.Boolean).
void	writeOrientation(org.eclipse.milo.opcua.stack.core.types.structured.Orientation 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.Orientation orientation)	An asynchronous implementation of FrameType.writeOrientation(org.eclipse.milo.opcua.stack.core.types.structured.Orientation).

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

FrameTypeNode

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

getConstant

public Boolean getConstant()
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

Get the local value of the Constant Node.

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

Specified by:

getConstant in interface FrameType

Returns:

the local value of the Constant Node.

Throws:

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

setConstant

public void setConstant(Boolean value)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

Set the local value of the Constant Node.

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

Specified by:

setConstant in interface FrameType

Parameters:

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

Throws:

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

readConstant

public Boolean readConstant()
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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

Specified by:

readConstant in interface FrameType

Returns:

the Boolean value read from the server.

Throws:

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

writeConstant

public void writeConstant(Boolean value)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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

Specified by:

writeConstant in interface FrameType

Parameters:

value - the Boolean value to write to the server.

Throws:

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

readConstantAsync

public CompletableFuture<? extends Boolean> readConstantAsync()

Description copied from interface: FrameType

An asynchronous implementation of FrameType.readConstant().

Specified by:

readConstantAsync in interface FrameType

Returns:

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

writeConstantAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConstantAsync(Boolean constant)

Description copied from interface: FrameType

An asynchronous implementation of FrameType.writeConstant(java.lang.Boolean).

Specified by:

writeConstantAsync in interface FrameType

Returns:

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

getConstantNode

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

Description copied from interface: FrameType

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

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

Specified by:

getConstantNode in interface FrameType

Returns:

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

getConstantNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getConstantNodeAsync()

Description copied from interface: FrameType

Asynchronous implementation of FrameType.getConstantNode().

Specified by:

getConstantNodeAsync in interface FrameType

Returns:

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

getFixedBase

public Boolean getFixedBase()
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

Get the local value of the FixedBase Node.

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

Specified by:

getFixedBase in interface FrameType

Returns:

the local value of the FixedBase Node.

Throws:

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

setFixedBase

public void setFixedBase(Boolean value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

Set the local value of the FixedBase Node.

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

Specified by:

setFixedBase in interface FrameType

Parameters:

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

Throws:

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

readFixedBase

public Boolean readFixedBase()
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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

Specified by:

readFixedBase in interface FrameType

Returns:

the Boolean value read from the server.

Throws:

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

writeFixedBase

public void writeFixedBase(Boolean value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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

Specified by:

writeFixedBase in interface FrameType

Parameters:

value - the Boolean value to write to the server.

Throws:

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

readFixedBaseAsync

public CompletableFuture<? extends Boolean> readFixedBaseAsync()

Description copied from interface: FrameType

An asynchronous implementation of FrameType.readFixedBase().

Specified by:

readFixedBaseAsync in interface FrameType

Returns:

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

writeFixedBaseAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeFixedBaseAsync(Boolean fixedBase)

Description copied from interface: FrameType

An asynchronous implementation of FrameType.writeFixedBase(java.lang.Boolean).

Specified by:

writeFixedBaseAsync in interface FrameType

Returns:

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

getFixedBaseNode

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

Description copied from interface: FrameType

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

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

Specified by:

getFixedBaseNode in interface FrameType

Returns:

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

getFixedBaseNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getFixedBaseNodeAsync()

Description copied from interface: FrameType

Asynchronous implementation of FrameType.getFixedBaseNode().

Specified by:

getFixedBaseNodeAsync in interface FrameType

Returns:

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

getCartesianCoordinates

public org.eclipse.milo.opcua.stack.core.types.structured.CartesianCoordinates 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

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.CartesianCoordinates value)
                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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 FrameType

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

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.CartesianCoordinates value)
                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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 FrameType

Parameters:

value - the CartesianCoordinates 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.CartesianCoordinates> readCartesianCoordinatesAsync()

Description copied from interface: FrameType

An asynchronous implementation of FrameType.readCartesianCoordinates().

Specified by:

readCartesianCoordinatesAsync in interface FrameType

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.CartesianCoordinates cartesianCoordinates)

Description copied from interface: FrameType

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

Specified by:

writeCartesianCoordinatesAsync in interface FrameType

Returns:

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

getCartesianCoordinatesNode

public CartesianCoordinatesTypeNode 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

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 CartesianCoordinatesTypeNode> getCartesianCoordinatesNodeAsync()

Description copied from interface: FrameType

Asynchronous implementation of FrameType.getCartesianCoordinatesNode().

Specified by:

getCartesianCoordinatesNodeAsync in interface FrameType

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

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.Orientation value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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 FrameType

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

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.Orientation value)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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 FrameType

Parameters:

value - the Orientation 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.Orientation> readOrientationAsync()

Description copied from interface: FrameType

An asynchronous implementation of FrameType.readOrientation().

Specified by:

readOrientationAsync in interface FrameType

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.Orientation orientation)

Description copied from interface: FrameType

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

Specified by:

writeOrientationAsync in interface FrameType

Returns:

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

getOrientationNode

public OrientationTypeNode 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

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 OrientationTypeNode> getOrientationNodeAsync()

Description copied from interface: FrameType

Asynchronous implementation of FrameType.getOrientationNode().

Specified by:

getOrientationNodeAsync in interface FrameType

Returns:

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

getBaseFrame

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getBaseFrame()
                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

Get the local value of the BaseFrame Node.

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

Specified by:

getBaseFrame in interface FrameType

Returns:

the local value of the BaseFrame Node.

Throws:

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

setBaseFrame

public void setBaseFrame(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

Set the local value of the BaseFrame Node.

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

Specified by:

setBaseFrame in interface FrameType

Parameters:

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

Throws:

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

readBaseFrame

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readBaseFrame()
                                                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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

Specified by:

readBaseFrame in interface FrameType

Returns:

the NodeId value read from the server.

Throws:

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

writeBaseFrame

public void writeBaseFrame(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FrameType

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

Specified by:

writeBaseFrame in interface FrameType

Parameters:

value - the NodeId value to write to the server.

Throws:

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

readBaseFrameAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> readBaseFrameAsync()

Description copied from interface: FrameType

An asynchronous implementation of FrameType.readBaseFrame().

Specified by:

readBaseFrameAsync in interface FrameType

Returns:

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

writeBaseFrameAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeBaseFrameAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId baseFrame)

Description copied from interface: FrameType

An asynchronous implementation of FrameType.writeBaseFrame(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).

Specified by:

writeBaseFrameAsync in interface FrameType

Returns:

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

getBaseFrameNode

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

Description copied from interface: FrameType

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

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

Specified by:

getBaseFrameNode in interface FrameType

Returns:

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

getBaseFrameNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getBaseFrameNodeAsync()

Description copied from interface: FrameType

Asynchronous implementation of FrameType.getBaseFrameNode().

Specified by:

getBaseFrameNodeAsync in interface FrameType

Returns:

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