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

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

Class NDimensionArrayItemTypeNode

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

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

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

All Implemented Interfaces:

ArrayItemType, BaseDataVariableType, BaseVariableType, DataItemType, NDimensionArrayItemType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

public class NDimensionArrayItemTypeNode
extends ArrayItemTypeNode
implements NDimensionArrayItemType

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

AXIS_SCALE_TYPE, ENGINEERING_UNITS, EU_RANGE, INSTRUMENT_RANGE, TITLE

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.DataItemType

DEFINITION, VALUE_PRECISION

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.NDimensionArrayItemType

AXIS_DEFINITION

Constructor Summary

Constructors

Constructor

Description

NDimensionArrayItemTypeNode(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.AxisInformation[]	getAxisDefinition()	Get the local value of the AxisDefinition Node.
PropertyTypeNode	getAxisDefinitionNode()	Get the AxisDefinition PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getAxisDefinitionNodeAsync()	Asynchronous implementation of NDimensionArrayItemType.getAxisDefinitionNode().
org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[]	readAxisDefinition()	Read the value of the AxisDefinition Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[]>	readAxisDefinitionAsync()	An asynchronous implementation of NDimensionArrayItemType.readAxisDefinition().
void	setAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[] value)	Set the local value of the AxisDefinition Node.
void	writeAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[] value)	Write a new value for the AxisDefinition Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeAxisDefinitionAsync(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[] axisDefinition)	An asynchronous implementation of NDimensionArrayItemType.writeAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[]).

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

getAxisScaleType, getAxisScaleTypeNode, getAxisScaleTypeNodeAsync, getEngineeringUnits, getEngineeringUnitsNode, getEngineeringUnitsNodeAsync, getEuRange, getEuRangeNode, getEuRangeNodeAsync, getInstrumentRange, getInstrumentRangeNode, getInstrumentRangeNodeAsync, getTitle, getTitleNode, getTitleNodeAsync, readAxisScaleType, readAxisScaleTypeAsync, readEngineeringUnits, readEngineeringUnitsAsync, readEuRange, readEuRangeAsync, readInstrumentRange, readInstrumentRangeAsync, readTitle, readTitleAsync, setAxisScaleType, setEngineeringUnits, setEuRange, setInstrumentRange, setTitle, writeAxisScaleType, writeAxisScaleTypeAsync, writeEngineeringUnits, writeEngineeringUnitsAsync, writeEuRange, writeEuRangeAsync, writeInstrumentRange, writeInstrumentRangeAsync, writeTitle, writeTitleAsync

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

getDefinition, getDefinitionNode, getDefinitionNodeAsync, getValuePrecision, getValuePrecisionNode, getValuePrecisionNodeAsync, readDefinition, readDefinitionAsync, readValuePrecision, readValuePrecisionAsync, setDefinition, setValuePrecision, writeDefinition, writeDefinitionAsync, writeValuePrecision, writeValuePrecisionAsync

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, 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, 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.ArrayItemType

getAxisScaleType, getAxisScaleTypeNode, getAxisScaleTypeNodeAsync, getEngineeringUnits, getEngineeringUnitsNode, getEngineeringUnitsNodeAsync, getEuRange, getEuRangeNode, getEuRangeNodeAsync, getInstrumentRange, getInstrumentRangeNode, getInstrumentRangeNodeAsync, getTitle, getTitleNode, getTitleNodeAsync, readAxisScaleType, readAxisScaleTypeAsync, readEngineeringUnits, readEngineeringUnitsAsync, readEuRange, readEuRangeAsync, readInstrumentRange, readInstrumentRangeAsync, readTitle, readTitleAsync, setAxisScaleType, setEngineeringUnits, setEuRange, setInstrumentRange, setTitle, writeAxisScaleType, writeAxisScaleTypeAsync, writeEngineeringUnits, writeEngineeringUnitsAsync, writeEuRange, writeEuRangeAsync, writeInstrumentRange, writeInstrumentRangeAsync, writeTitle, writeTitleAsync

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

getDefinition, getDefinitionNode, getDefinitionNodeAsync, getValuePrecision, getValuePrecisionNode, getValuePrecisionNodeAsync, readDefinition, readDefinitionAsync, readValuePrecision, readValuePrecisionAsync, setDefinition, setValuePrecision, writeDefinition, writeDefinitionAsync, writeValuePrecision, writeValuePrecisionAsync

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

NDimensionArrayItemTypeNode

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

getAxisDefinition

public org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[] getAxisDefinition()
                                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NDimensionArrayItemType

Get the local value of the AxisDefinition Node.

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

Specified by:

getAxisDefinition in interface NDimensionArrayItemType

Returns:

the local value of the AxisDefinition Node.

Throws:

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

setAxisDefinition

public void setAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[] value)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NDimensionArrayItemType

Set the local value of the AxisDefinition Node.

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

Specified by:

setAxisDefinition in interface NDimensionArrayItemType

Parameters:

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

Throws:

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

readAxisDefinition

public org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[] readAxisDefinition()
                                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NDimensionArrayItemType

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

Specified by:

readAxisDefinition in interface NDimensionArrayItemType

Returns:

the AxisInformation value read from the server.

Throws:

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

writeAxisDefinition

public void writeAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[] value)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: NDimensionArrayItemType

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

Specified by:

writeAxisDefinition in interface NDimensionArrayItemType

Parameters:

value - the AxisInformation value to write to the server.

Throws:

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

readAxisDefinitionAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[]> readAxisDefinitionAsync()

Description copied from interface: NDimensionArrayItemType

An asynchronous implementation of NDimensionArrayItemType.readAxisDefinition().

Specified by:

readAxisDefinitionAsync in interface NDimensionArrayItemType

Returns:

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

writeAxisDefinitionAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeAxisDefinitionAsync(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[] axisDefinition)

Description copied from interface: NDimensionArrayItemType

An asynchronous implementation of NDimensionArrayItemType.writeAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[]).

Specified by:

writeAxisDefinitionAsync in interface NDimensionArrayItemType

Returns:

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

getAxisDefinitionNode

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

Description copied from interface: NDimensionArrayItemType

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

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

Specified by:

getAxisDefinitionNode in interface NDimensionArrayItemType

Returns:

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

getAxisDefinitionNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getAxisDefinitionNodeAsync()

Description copied from interface: NDimensionArrayItemType

Asynchronous implementation of NDimensionArrayItemType.getAxisDefinitionNode().

Specified by:

getAxisDefinitionNodeAsync in interface NDimensionArrayItemType

Returns:

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