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

Interface CubeItemType

All Superinterfaces:

ArrayItemType, BaseDataVariableType, BaseVariableType, DataItemType, Node, VariableNode

All Known Implementing Classes:

CubeItemTypeNode

public interface CubeItemType
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
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation>	Y_AXIS_DEFINITION
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation>	Z_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	getYAxisDefinition() Get the local value of the YAxisDefinition Node.
PropertyType	getYAxisDefinitionNode() Get the YAxisDefinition PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getYAxisDefinitionNodeAsync() Asynchronous implementation of getYAxisDefinitionNode().
org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation	getZAxisDefinition() Get the local value of the ZAxisDefinition Node.
PropertyType	getZAxisDefinitionNode() Get the ZAxisDefinition PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getZAxisDefinitionNodeAsync() Asynchronous implementation of getZAxisDefinitionNode().
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().
org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation	readYAxisDefinition() Read the value of the YAxisDefinition Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation>	readYAxisDefinitionAsync() An asynchronous implementation of readYAxisDefinition().
org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation	readZAxisDefinition() Read the value of the ZAxisDefinition Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation>	readZAxisDefinitionAsync() An asynchronous implementation of readZAxisDefinition().
void	setXAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation xAxisDefinition) Set the local value of the XAxisDefinition Node.
void	setYAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation yAxisDefinition) Set the local value of the YAxisDefinition Node.
void	setZAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation zAxisDefinition) Set the local value of the ZAxisDefinition 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).
void	writeYAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation yAxisDefinition) Write a new value for the YAxisDefinition Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeYAxisDefinitionAsync(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation yAxisDefinition) An asynchronous implementation of writeYAxisDefinition(AxisInformation).
void	writeZAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation zAxisDefinition) Write a new value for the ZAxisDefinition Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeZAxisDefinitionAsync(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation zAxisDefinition) An asynchronous implementation of writeZAxisDefinition(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

Y_AXIS_DEFINITION

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

Z_AXIS_DEFINITION

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation> Z_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.

getYAxisDefinition

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

Get the local value of the YAxisDefinition Node.

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

Returns:

the local value of the YAxisDefinition Node.

Throws:

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

setYAxisDefinition

void setYAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation yAxisDefinition)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the YAxisDefinition Node.

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

Parameters:

yAxisDefinition - the local value to set for the YAxisDefinition Node.

Throws:

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

readYAxisDefinition

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

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

writeYAxisDefinition

void writeYAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation yAxisDefinition)
                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

yAxisDefinition - the AxisInformation value to write to the server.

Throws:

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

readYAxisDefinitionAsync

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

An asynchronous implementation of readYAxisDefinition().

Returns:

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

writeYAxisDefinitionAsync

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

An asynchronous implementation of writeYAxisDefinition(AxisInformation).

Returns:

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

getYAxisDefinitionNode

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

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

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

Returns:

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

getYAxisDefinitionNodeAsync

CompletableFuture<? extends PropertyType> getYAxisDefinitionNodeAsync()

Asynchronous implementation of getYAxisDefinitionNode().

Returns:

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

getZAxisDefinition

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

Get the local value of the ZAxisDefinition Node.

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

Returns:

the local value of the ZAxisDefinition Node.

Throws:

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

setZAxisDefinition

void setZAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation zAxisDefinition)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ZAxisDefinition Node.

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

Parameters:

zAxisDefinition - the local value to set for the ZAxisDefinition Node.

Throws:

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

readZAxisDefinition

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

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

writeZAxisDefinition

void writeZAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation zAxisDefinition)
                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

zAxisDefinition - the AxisInformation value to write to the server.

Throws:

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

readZAxisDefinitionAsync

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

An asynchronous implementation of readZAxisDefinition().

Returns:

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

writeZAxisDefinitionAsync

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

An asynchronous implementation of writeZAxisDefinition(AxisInformation).

Returns:

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

getZAxisDefinitionNode

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

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

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

Returns:

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

getZAxisDefinitionNodeAsync

CompletableFuture<? extends PropertyType> getZAxisDefinitionNodeAsync()

Asynchronous implementation of getZAxisDefinitionNode().

Returns:

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