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

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

Class CartesianCoordinatesTypeNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ThreeDCartesianCoordinatesTypeNode

public class CartesianCoordinatesTypeNode
extends BaseDataVariableTypeNode
implements CartesianCoordinatesType

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

LENGTH_UNIT

Constructor Summary

Constructors

Constructor

Description

CartesianCoordinatesTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.structured.EUInformation	getLengthUnit()	Get the local value of the LengthUnit Node.
PropertyTypeNode	getLengthUnitNode()	Get the LengthUnit PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getLengthUnitNodeAsync()	Asynchronous implementation of CartesianCoordinatesType.getLengthUnitNode().
org.eclipse.milo.opcua.stack.core.types.structured.EUInformation	readLengthUnit()	Read the value of the LengthUnit Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation>	readLengthUnitAsync()	An asynchronous implementation of CartesianCoordinatesType.readLengthUnit().
void	setLengthUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)	Set the local value of the LengthUnit Node.
void	writeLengthUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)	Write a new value for the LengthUnit Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLengthUnitAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation lengthUnit)	An asynchronous implementation of CartesianCoordinatesType.writeLengthUnit(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

getAccessLevel, getAccessLevelEx, getArrayDimensions, getAttributeValue, getDataType, getHistorizing, getMinimumSamplingInterval, getTypeDefinition, getTypeDefinitionAsync, getUserAccessLevel, getValue, getValueRank, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readAccessLevel, readAccessLevelEx, readAllowNullsAsync, readArrayDimensions, readDataType, readDataTypeVersionAsync, readDictionaryFragmentAsync, readEngineeringUnitsAsync, readHistorizing, readLocalTimeAsync, readMaxArrayLengthAsync, readMaxStringLengthAsync, readMinimumSamplingInterval, readNodeVersionAsync, readUserAccessLevel, readValue, readValueAsTextAsync, readValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setAttributeValue, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValue, setValueRank, writeAccessLevel, writeAccessLevelEx, writeAllowNullsAsync, writeArrayDimensions, writeDataType, writeDataTypeVersionAsync, writeDictionaryFragmentAsync, writeEngineeringUnitsAsync, writeHistorizing, writeLocalTimeAsync, writeMaxArrayLengthAsync, writeMaxStringLengthAsync, writeMinimumSamplingInterval, writeNodeVersionAsync, writeUserAccessLevel, writeValue, writeValue, writeValueAsTextAsync, writeValueRank

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, writeUserWriteMask, writeWriteMask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

getAccessLevel, getAccessLevelEx, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

Constructor Details

CartesianCoordinatesTypeNode

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

getLengthUnit

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

Description copied from interface: CartesianCoordinatesType

Get the local value of the LengthUnit Node.

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

Specified by:

getLengthUnit in interface CartesianCoordinatesType

Returns:

the local value of the LengthUnit Node.

Throws:

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

setLengthUnit

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

Description copied from interface: CartesianCoordinatesType

Set the local value of the LengthUnit Node.

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

Specified by:

setLengthUnit in interface CartesianCoordinatesType

Parameters:

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

Throws:

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

readLengthUnit

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

Description copied from interface: CartesianCoordinatesType

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

Specified by:

readLengthUnit in interface CartesianCoordinatesType

Returns:

the EUInformation value read from the server.

Throws:

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

writeLengthUnit

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

Description copied from interface: CartesianCoordinatesType

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

Specified by:

writeLengthUnit in interface CartesianCoordinatesType

Parameters:

value - the EUInformation value to write to the server.

Throws:

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

readLengthUnitAsync

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

Description copied from interface: CartesianCoordinatesType

An asynchronous implementation of CartesianCoordinatesType.readLengthUnit().

Specified by:

readLengthUnitAsync in interface CartesianCoordinatesType

Returns:

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

writeLengthUnitAsync

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

Description copied from interface: CartesianCoordinatesType

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

Specified by:

writeLengthUnitAsync in interface CartesianCoordinatesType

Returns:

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

getLengthUnitNode

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

Description copied from interface: CartesianCoordinatesType

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

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

Specified by:

getLengthUnitNode in interface CartesianCoordinatesType

Returns:

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

getLengthUnitNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getLengthUnitNodeAsync()

Description copied from interface: CartesianCoordinatesType

Asynchronous implementation of CartesianCoordinatesType.getLengthUnitNode().

Specified by:

getLengthUnitNodeAsync in interface CartesianCoordinatesType

Returns:

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