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

Interface MultiStateDiscreteType

All Superinterfaces:

BaseDataVariableType, BaseVariableType, DataItemType, DiscreteItemType, Node, VariableNode

All Known Implementing Classes:

MultiStateDiscreteTypeNode

public interface MultiStateDiscreteType
extends DiscreteItemType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]>	ENUM_STRINGS

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.builtin.LocalizedText[]	getEnumStrings() Get the local value of the EnumStrings Node.
PropertyType	getEnumStringsNode() Get the EnumStrings PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getEnumStringsNodeAsync() Asynchronous implementation of getEnumStringsNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]	readEnumStrings() Read the value of the EnumStrings Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]>	readEnumStringsAsync() An asynchronous implementation of readEnumStrings().
void	setEnumStrings(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] enumStrings) Set the local value of the EnumStrings Node.
void	writeEnumStrings(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] enumStrings) Write a new value for the EnumStrings Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEnumStringsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] enumStrings) An asynchronous implementation of writeEnumStrings(LocalizedText[]).

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

ENUM_STRINGS

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]> ENUM_STRINGS

Method Detail

getEnumStrings

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] getEnumStrings()
                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the EnumStrings Node.

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

Returns:

the local value of the EnumStrings Node.

Throws:

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

setEnumStrings

void setEnumStrings(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] enumStrings)
             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the EnumStrings Node.

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

Parameters:

enumStrings - the local value to set for the EnumStrings Node.

Throws:

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

readEnumStrings

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] readEnumStrings()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the LocalizedText[] value read from the server.

Throws:

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

writeEnumStrings

void writeEnumStrings(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] enumStrings)
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

enumStrings - the LocalizedText[] value to write to the server.

Throws:

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

readEnumStringsAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]> readEnumStringsAsync()

An asynchronous implementation of readEnumStrings().

Returns:

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

writeEnumStringsAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEnumStringsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] enumStrings)

An asynchronous implementation of writeEnumStrings(LocalizedText[]).

Returns:

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

getEnumStringsNode

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

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

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

Returns:

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

getEnumStringsNodeAsync

CompletableFuture<? extends PropertyType> getEnumStringsNodeAsync()

Asynchronous implementation of getEnumStringsNode().

Returns:

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