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

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

Class ImageItemTypeNode

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

All Implemented Interfaces:

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

public class ImageItemTypeNode
extends ArrayItemTypeNode
implements ImageItemType

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

X_AXIS_DEFINITION, Y_AXIS_DEFINITION

Constructor Summary

Constructors

Constructor

Description

ImageItemTypeNode(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	getXAxisDefinition()	Get the local value of the XAxisDefinition Node.
PropertyTypeNode	getXAxisDefinitionNode()	Get the XAxisDefinition PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getXAxisDefinitionNodeAsync()	Asynchronous implementation of ImageItemType.getXAxisDefinitionNode().
org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation	getYAxisDefinition()	Get the local value of the YAxisDefinition Node.
PropertyTypeNode	getYAxisDefinitionNode()	Get the YAxisDefinition PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getYAxisDefinitionNodeAsync()	Asynchronous implementation of ImageItemType.getYAxisDefinitionNode().
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 ImageItemType.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 ImageItemType.readYAxisDefinition().
void	setXAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation value)	Set the local value of the XAxisDefinition Node.
void	setYAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation value)	Set the local value of the YAxisDefinition Node.
void	writeXAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation value)	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 ImageItemType.writeXAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation).
void	writeYAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation value)	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 ImageItemType.writeYAxisDefinition(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

ImageItemTypeNode

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

getXAxisDefinition

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

Description copied from interface: ImageItemType

Get the local value of the XAxisDefinition Node.

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

Specified by:

getXAxisDefinition in interface ImageItemType

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

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

Description copied from interface: ImageItemType

Set the local value of the XAxisDefinition Node.

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

Specified by:

setXAxisDefinition in interface ImageItemType

Parameters:

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

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

Description copied from interface: ImageItemType

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

Specified by:

readXAxisDefinition in interface ImageItemType

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

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

Description copied from interface: ImageItemType

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

Specified by:

writeXAxisDefinition in interface ImageItemType

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.

readXAxisDefinitionAsync

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

Description copied from interface: ImageItemType

An asynchronous implementation of ImageItemType.readXAxisDefinition().

Specified by:

readXAxisDefinitionAsync in interface ImageItemType

Returns:

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

writeXAxisDefinitionAsync

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

Description copied from interface: ImageItemType

An asynchronous implementation of ImageItemType.writeXAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation).

Specified by:

writeXAxisDefinitionAsync in interface ImageItemType

Returns:

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

getXAxisDefinitionNode

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

Description copied from interface: ImageItemType

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

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

Specified by:

getXAxisDefinitionNode in interface ImageItemType

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

public CompletableFuture<? extends PropertyTypeNode> getXAxisDefinitionNodeAsync()

Description copied from interface: ImageItemType

Asynchronous implementation of ImageItemType.getXAxisDefinitionNode().

Specified by:

getXAxisDefinitionNodeAsync in interface ImageItemType

Returns:

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

getYAxisDefinition

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

Description copied from interface: ImageItemType

Get the local value of the YAxisDefinition Node.

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

Specified by:

getYAxisDefinition in interface ImageItemType

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

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

Description copied from interface: ImageItemType

Set the local value of the YAxisDefinition Node.

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

Specified by:

setYAxisDefinition in interface ImageItemType

Parameters:

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

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

Description copied from interface: ImageItemType

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

Specified by:

readYAxisDefinition in interface ImageItemType

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

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

Description copied from interface: ImageItemType

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

Specified by:

writeYAxisDefinition in interface ImageItemType

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.

readYAxisDefinitionAsync

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

Description copied from interface: ImageItemType

An asynchronous implementation of ImageItemType.readYAxisDefinition().

Specified by:

readYAxisDefinitionAsync in interface ImageItemType

Returns:

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

writeYAxisDefinitionAsync

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

Description copied from interface: ImageItemType

An asynchronous implementation of ImageItemType.writeYAxisDefinition(org.eclipse.milo.opcua.stack.core.types.structured.AxisInformation).

Specified by:

writeYAxisDefinitionAsync in interface ImageItemType

Returns:

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

getYAxisDefinitionNode

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

Description copied from interface: ImageItemType

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

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

Specified by:

getYAxisDefinitionNode in interface ImageItemType

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

public CompletableFuture<? extends PropertyTypeNode> getYAxisDefinitionNodeAsync()

Description copied from interface: ImageItemType

Asynchronous implementation of ImageItemType.getYAxisDefinitionNode().

Specified by:

getYAxisDefinitionNodeAsync in interface ImageItemType

Returns:

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