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

Interface NDimensionArrayItemType

All Superinterfaces:

ArrayItemType, BaseDataVariableType, BaseVariableType, DataItemType, Node, VariableNode

All Known Implementing Classes:

NDimensionArrayItemTypeNode

public interface NDimensionArrayItemType
extends ArrayItemType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[]>	AXIS_DEFINITION

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

AXIS_SCALE_TYPE, ENGINEERING_UNITS, EU_RANGE, INSTRUMENT_RANGE, TITLE

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

DEFINITION, VALUE_PRECISION

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[]	getAxisDefinition() Get the local value of the AxisDefinition Node.
PropertyType	getAxisDefinitionNode() Get the AxisDefinition PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getAxisDefinitionNodeAsync() Asynchronous implementation of 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 readAxisDefinition().
void	setAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[] axisDefinition) Set the local value of the AxisDefinition Node.
void	writeAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[] axisDefinition) 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 writeAxisDefinition(AxisInformation[]).

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.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.types.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.VariableNode

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

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

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Field Detail

AXIS_DEFINITION

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation[]> AXIS_DEFINITION

Method Detail

getAxisDefinition

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

Get the local value of the AxisDefinition Node.

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

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

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

Set the local value of the AxisDefinition Node.

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

Parameters:

axisDefinition - 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

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

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

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

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

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

Parameters:

axisDefinition - 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

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

An asynchronous implementation of readAxisDefinition().

Returns:

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

writeAxisDefinitionAsync

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 writeAxisDefinition(AxisInformation[]).

Returns:

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

getAxisDefinitionNode

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

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

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

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

CompletableFuture<? extends PropertyType> getAxisDefinitionNodeAsync()

Asynchronous implementation of getAxisDefinitionNode().

Returns:

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