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

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

Interface DataItemType

All Superinterfaces:

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

All Known Subinterfaces:

AnalogItemType, AnalogUnitRangeType, AnalogUnitType, ArrayItemType, BaseAnalogType, CubeItemType, DiscreteItemType, ImageItemType, MultiStateDictionaryEntryDiscreteBaseType, MultiStateDictionaryEntryDiscreteType, MultiStateDiscreteType, MultiStateValueDiscreteType, NDimensionArrayItemType, TwoStateDiscreteType, XYArrayItemType, YArrayItemType

All Known Implementing Classes:

AnalogItemTypeNode, AnalogUnitRangeTypeNode, AnalogUnitTypeNode, ArrayItemTypeNode, BaseAnalogTypeNode, CubeItemTypeNode, DataItemTypeNode, DiscreteItemTypeNode, ImageItemTypeNode, MultiStateDictionaryEntryDiscreteBaseTypeNode, MultiStateDictionaryEntryDiscreteTypeNode, MultiStateDiscreteTypeNode, MultiStateValueDiscreteTypeNode, NDimensionArrayItemTypeNode, TwoStateDiscreteTypeNode, XYArrayItemTypeNode, YArrayItemTypeNode

public interface DataItemType
extends BaseDataVariableType

See Also:

• https://reference.opcfoundation.org/v105/Core/docs/Part8/5.3.1

Field Summary

Fields

Modifier and Type	Field	Description
static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String>	DEFINITION
static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Double>	VALUE_PRECISION

Method Summary

Modifier and Type	Method	Description
String	getDefinition()	Get the local value of the Definition Node.
PropertyType	getDefinitionNode()	Get the Definition PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getDefinitionNodeAsync()	Asynchronous implementation of getDefinitionNode().
Double	getValuePrecision()	Get the local value of the ValuePrecision Node.
PropertyType	getValuePrecisionNode()	Get the ValuePrecision PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getValuePrecisionNodeAsync()	Asynchronous implementation of getValuePrecisionNode().
String	readDefinition()	Read the value of the Definition Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readDefinitionAsync()	An asynchronous implementation of readDefinition().
Double	readValuePrecision()	Read the value of the ValuePrecision Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readValuePrecisionAsync()	An asynchronous implementation of readValuePrecision().
void	setDefinition(String value)	Set the local value of the Definition Node.
void	setValuePrecision(Double value)	Set the local value of the ValuePrecision Node.
void	writeDefinition(String value)	Write a new value for the Definition Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDefinitionAsync(String value)	An asynchronous implementation of writeDefinition(java.lang.String).
void	writeValuePrecision(Double value)	Write a new value for the ValuePrecision Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeValuePrecisionAsync(Double value)	An asynchronous implementation of writeValuePrecision(java.lang.Double).

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

Field Details

DEFINITION

static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> DEFINITION

VALUE_PRECISION

static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Double> VALUE_PRECISION

Method Details

getDefinition

String getDefinition()
              throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the Definition Node.

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

Returns:

the local value of the Definition Node.

Throws:

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

setDefinition

void setDefinition(String value)
            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Definition Node.

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

Parameters:

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

Throws:

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

readDefinition

String readDefinition()
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the String value read from the server.

Throws:

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

writeDefinition

void writeDefinition(String value)
              throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

value - the String value to write to the server.

Throws:

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

readDefinitionAsync

CompletableFuture<? extends String> readDefinitionAsync()

An asynchronous implementation of readDefinition().

Returns:

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

writeDefinitionAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDefinitionAsync(String value)

An asynchronous implementation of writeDefinition(java.lang.String).

Returns:

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

getDefinitionNode

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

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

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

Returns:

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

getDefinitionNodeAsync

CompletableFuture<? extends PropertyType> getDefinitionNodeAsync()

Asynchronous implementation of getDefinitionNode().

Returns:

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

getValuePrecision

Double getValuePrecision()
                  throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ValuePrecision Node.

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

Returns:

the local value of the ValuePrecision Node.

Throws:

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

setValuePrecision

void setValuePrecision(Double value)
                throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ValuePrecision Node.

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

Parameters:

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

Throws:

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

readValuePrecision

Double readValuePrecision()
                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Double value read from the server.

Throws:

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

writeValuePrecision

void writeValuePrecision(Double value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

value - the Double value to write to the server.

Throws:

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

readValuePrecisionAsync

CompletableFuture<? extends Double> readValuePrecisionAsync()

An asynchronous implementation of readValuePrecision().

Returns:

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

writeValuePrecisionAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeValuePrecisionAsync(Double value)

An asynchronous implementation of writeValuePrecision(java.lang.Double).

Returns:

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

getValuePrecisionNode

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

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

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

Returns:

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

getValuePrecisionNodeAsync

CompletableFuture<? extends PropertyType> getValuePrecisionNodeAsync()

Asynchronous implementation of getValuePrecisionNode().

Returns:

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