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

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

Class ThreeDOrientationTypeNode

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

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

All Implemented Interfaces:

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

public class ThreeDOrientationTypeNode
extends OrientationTypeNode
implements ThreeDOrientationType

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

ANGLE_UNIT

Constructor Summary

Constructors

Constructor

Description

ThreeDOrientationTypeNode(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	getA()	Get the local value of the A Node.
BaseDataVariableTypeNode	getANode()	Get the A BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getANodeAsync()	Asynchronous implementation of ThreeDOrientationType.getANode().
Double	getB()	Get the local value of the B Node.
BaseDataVariableTypeNode	getBNode()	Get the B BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getBNodeAsync()	Asynchronous implementation of ThreeDOrientationType.getBNode().
Double	getC()	Get the local value of the C Node.
BaseDataVariableTypeNode	getCNode()	Get the C BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getCNodeAsync()	Asynchronous implementation of ThreeDOrientationType.getCNode().
Double	readA()	Read the value of the A Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readAAsync()	An asynchronous implementation of ThreeDOrientationType.readA().
Double	readB()	Read the value of the B Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readBAsync()	An asynchronous implementation of ThreeDOrientationType.readB().
Double	readC()	Read the value of the C Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readCAsync()	An asynchronous implementation of ThreeDOrientationType.readC().
void	setA(Double value)	Set the local value of the A Node.
void	setB(Double value)	Set the local value of the B Node.
void	setC(Double value)	Set the local value of the C Node.
void	writeA(Double value)	Write a new value for the A Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeAAsync(Double a)	An asynchronous implementation of ThreeDOrientationType.writeA(java.lang.Double).
void	writeB(Double value)	Write a new value for the B Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeBAsync(Double b)	An asynchronous implementation of ThreeDOrientationType.writeB(java.lang.Double).
void	writeC(Double value)	Write a new value for the C Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCAsync(Double c)	An asynchronous implementation of ThreeDOrientationType.writeC(java.lang.Double).

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

getAngleUnit, getAngleUnitNode, getAngleUnitNodeAsync, readAngleUnit, readAngleUnitAsync, setAngleUnit, writeAngleUnit, writeAngleUnitAsync

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

getAngleUnit, getAngleUnitNode, getAngleUnitNodeAsync, readAngleUnit, readAngleUnitAsync, setAngleUnit, writeAngleUnit, writeAngleUnitAsync

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

ThreeDOrientationTypeNode

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

getA

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

Description copied from interface: ThreeDOrientationType

Get the local value of the A Node.

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

Specified by:

getA in interface ThreeDOrientationType

Returns:

the local value of the A Node.

Throws:

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

setA

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

Description copied from interface: ThreeDOrientationType

Set the local value of the A Node.

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

Specified by:

setA in interface ThreeDOrientationType

Parameters:

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

Throws:

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

readA

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

Description copied from interface: ThreeDOrientationType

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

Specified by:

readA in interface ThreeDOrientationType

Returns:

the Double value read from the server.

Throws:

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

writeA

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

Description copied from interface: ThreeDOrientationType

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

Specified by:

writeA in interface ThreeDOrientationType

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.

readAAsync

public CompletableFuture<? extends Double> readAAsync()

Description copied from interface: ThreeDOrientationType

An asynchronous implementation of ThreeDOrientationType.readA().

Specified by:

readAAsync in interface ThreeDOrientationType

Returns:

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

writeAAsync

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

Description copied from interface: ThreeDOrientationType

An asynchronous implementation of ThreeDOrientationType.writeA(java.lang.Double).

Specified by:

writeAAsync in interface ThreeDOrientationType

Returns:

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

getANode

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

Description copied from interface: ThreeDOrientationType

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

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

Specified by:

getANode in interface ThreeDOrientationType

Returns:

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

getANodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getANodeAsync()

Description copied from interface: ThreeDOrientationType

Asynchronous implementation of ThreeDOrientationType.getANode().

Specified by:

getANodeAsync in interface ThreeDOrientationType

Returns:

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

getB

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

Description copied from interface: ThreeDOrientationType

Get the local value of the B Node.

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

Specified by:

getB in interface ThreeDOrientationType

Returns:

the local value of the B Node.

Throws:

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

setB

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

Description copied from interface: ThreeDOrientationType

Set the local value of the B Node.

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

Specified by:

setB in interface ThreeDOrientationType

Parameters:

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

Throws:

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

readB

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

Description copied from interface: ThreeDOrientationType

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

Specified by:

readB in interface ThreeDOrientationType

Returns:

the Double value read from the server.

Throws:

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

writeB

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

Description copied from interface: ThreeDOrientationType

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

Specified by:

writeB in interface ThreeDOrientationType

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.

readBAsync

public CompletableFuture<? extends Double> readBAsync()

Description copied from interface: ThreeDOrientationType

An asynchronous implementation of ThreeDOrientationType.readB().

Specified by:

readBAsync in interface ThreeDOrientationType

Returns:

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

writeBAsync

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

Description copied from interface: ThreeDOrientationType

An asynchronous implementation of ThreeDOrientationType.writeB(java.lang.Double).

Specified by:

writeBAsync in interface ThreeDOrientationType

Returns:

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

getBNode

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

Description copied from interface: ThreeDOrientationType

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

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

Specified by:

getBNode in interface ThreeDOrientationType

Returns:

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

getBNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getBNodeAsync()

Description copied from interface: ThreeDOrientationType

Asynchronous implementation of ThreeDOrientationType.getBNode().

Specified by:

getBNodeAsync in interface ThreeDOrientationType

Returns:

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

getC

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

Description copied from interface: ThreeDOrientationType

Get the local value of the C Node.

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

Specified by:

getC in interface ThreeDOrientationType

Returns:

the local value of the C Node.

Throws:

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

setC

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

Description copied from interface: ThreeDOrientationType

Set the local value of the C Node.

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

Specified by:

setC in interface ThreeDOrientationType

Parameters:

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

Throws:

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

readC

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

Description copied from interface: ThreeDOrientationType

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

Specified by:

readC in interface ThreeDOrientationType

Returns:

the Double value read from the server.

Throws:

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

writeC

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

Description copied from interface: ThreeDOrientationType

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

Specified by:

writeC in interface ThreeDOrientationType

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.

readCAsync

public CompletableFuture<? extends Double> readCAsync()

Description copied from interface: ThreeDOrientationType

An asynchronous implementation of ThreeDOrientationType.readC().

Specified by:

readCAsync in interface ThreeDOrientationType

Returns:

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

writeCAsync

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

Description copied from interface: ThreeDOrientationType

An asynchronous implementation of ThreeDOrientationType.writeC(java.lang.Double).

Specified by:

writeCAsync in interface ThreeDOrientationType

Returns:

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

getCNode

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

Description copied from interface: ThreeDOrientationType

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

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

Specified by:

getCNode in interface ThreeDOrientationType

Returns:

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

getCNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getCNodeAsync()

Description copied from interface: ThreeDOrientationType

Asynchronous implementation of ThreeDOrientationType.getCNode().

Specified by:

getCNodeAsync in interface ThreeDOrientationType

Returns:

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