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

Interface DataTypeDictionaryType

All Superinterfaces:

BaseDataVariableType, BaseVariableType, Node, VariableNode

All Known Implementing Classes:

DataTypeDictionaryTypeNode

public interface DataTypeDictionaryType
extends BaseDataVariableType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<String>	DATA_TYPE_VERSION
static QualifiedProperty<String>	NAMESPACE_URI

Method Summary

Modifier and Type	Method and Description
String	getDataTypeVersion() Get the local value of the DataTypeVersion Node.
PropertyType	getDataTypeVersionNode() Get the DataTypeVersion PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getDataTypeVersionNodeAsync() Asynchronous implementation of getDataTypeVersionNode().
String	getNamespaceUri() Get the local value of the NamespaceUri Node.
PropertyType	getNamespaceUriNode() Get the NamespaceUri PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getNamespaceUriNodeAsync() Asynchronous implementation of getNamespaceUriNode().
String	readDataTypeVersion() Read the value of the DataTypeVersion Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readDataTypeVersionAsync() An asynchronous implementation of readDataTypeVersion().
String	readNamespaceUri() Read the value of the NamespaceUri Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readNamespaceUriAsync() An asynchronous implementation of readNamespaceUri().
void	setDataTypeVersion(String dataTypeVersion) Set the local value of the DataTypeVersion Node.
void	setNamespaceUri(String namespaceUri) Set the local value of the NamespaceUri Node.
void	writeDataTypeVersion(String dataTypeVersion) Write a new value for the DataTypeVersion Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDataTypeVersionAsync(String dataTypeVersion) An asynchronous implementation of writeDataTypeVersion(String).
void	writeNamespaceUri(String namespaceUri) Write a new value for the NamespaceUri Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNamespaceUriAsync(String namespaceUri) An asynchronous implementation of writeNamespaceUri(String).

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

DATA_TYPE_VERSION

static final QualifiedProperty<String> DATA_TYPE_VERSION

NAMESPACE_URI

static final QualifiedProperty<String> NAMESPACE_URI

Method Detail

getDataTypeVersion

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

Get the local value of the DataTypeVersion Node.

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

Returns:

the local value of the DataTypeVersion Node.

Throws:

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

setDataTypeVersion

void setDataTypeVersion(String dataTypeVersion)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the DataTypeVersion Node.

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

Parameters:

dataTypeVersion - the local value to set for the DataTypeVersion Node.

Throws:

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

readDataTypeVersion

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

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

writeDataTypeVersion

void writeDataTypeVersion(String dataTypeVersion)
                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

dataTypeVersion - the String value to write to the server.

Throws:

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

readDataTypeVersionAsync

CompletableFuture<? extends String> readDataTypeVersionAsync()

An asynchronous implementation of readDataTypeVersion().

Returns:

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

writeDataTypeVersionAsync

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

An asynchronous implementation of writeDataTypeVersion(String).

Returns:

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

getDataTypeVersionNode

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

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

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

Returns:

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

getDataTypeVersionNodeAsync

CompletableFuture<? extends PropertyType> getDataTypeVersionNodeAsync()

Asynchronous implementation of getDataTypeVersionNode().

Returns:

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

getNamespaceUri

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

Get the local value of the NamespaceUri Node.

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

Returns:

the local value of the NamespaceUri Node.

Throws:

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

setNamespaceUri

void setNamespaceUri(String namespaceUri)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the NamespaceUri Node.

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

Parameters:

namespaceUri - the local value to set for the NamespaceUri Node.

Throws:

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

readNamespaceUri

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

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

writeNamespaceUri

void writeNamespaceUri(String namespaceUri)
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

namespaceUri - the String value to write to the server.

Throws:

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

readNamespaceUriAsync

CompletableFuture<? extends String> readNamespaceUriAsync()

An asynchronous implementation of readNamespaceUri().

Returns:

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

writeNamespaceUriAsync

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

An asynchronous implementation of writeNamespaceUri(String).

Returns:

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

getNamespaceUriNode

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

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

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

Returns:

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

getNamespaceUriNodeAsync

CompletableFuture<? extends PropertyType> getNamespaceUriNodeAsync()

Asynchronous implementation of getNamespaceUriNode().

Returns:

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