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

Interface XYArrayItemType

All Superinterfaces:

ArrayItemType, BaseDataVariableType, BaseVariableType, DataItemType, Node, VariableNode

All Known Implementing Classes:

XYArrayItemTypeNode

public interface XYArrayItemType
extends ArrayItemType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation>	X_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	getXAxisDefinition() Get the local value of the XAxisDefinition Node.
PropertyType	getXAxisDefinitionNode() Get the XAxisDefinition PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getXAxisDefinitionNodeAsync() Asynchronous implementation of getXAxisDefinitionNode().
org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation	readXAxisDefinition() Read the value of the XAxisDefinition Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation>	readXAxisDefinitionAsync() An asynchronous implementation of readXAxisDefinition().
void	setXAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation xAxisDefinition) Set the local value of the XAxisDefinition Node.
void	writeXAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation xAxisDefinition) Write a new value for the XAxisDefinition Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeXAxisDefinitionAsync(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation xAxisDefinition) An asynchronous implementation of writeXAxisDefinition(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

X_AXIS_DEFINITION

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation> X_AXIS_DEFINITION

Method Detail

getXAxisDefinition

org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation getXAxisDefinition()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the XAxisDefinition Node.

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

Returns:

the local value of the XAxisDefinition Node.

Throws:

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

setXAxisDefinition

void setXAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation xAxisDefinition)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the XAxisDefinition Node.

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

Parameters:

xAxisDefinition - the local value to set for the XAxisDefinition Node.

Throws:

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

readXAxisDefinition

org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation readXAxisDefinition()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the XAxisDefinition 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.

writeXAxisDefinition

void writeXAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation xAxisDefinition)
                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

xAxisDefinition - the AxisInformation value to write to the server.

Throws:

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

readXAxisDefinitionAsync

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

An asynchronous implementation of readXAxisDefinition().

Returns:

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

writeXAxisDefinitionAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeXAxisDefinitionAsync(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation xAxisDefinition)

An asynchronous implementation of writeXAxisDefinition(AxisInformation).

Returns:

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

getXAxisDefinitionNode

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

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

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

Returns:

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

getXAxisDefinitionNodeAsync

CompletableFuture<? extends PropertyType> getXAxisDefinitionNodeAsync()

Asynchronous implementation of getXAxisDefinitionNode().

Returns:

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