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

Interface MultiStateValueDiscreteType

All Superinterfaces:

BaseDataVariableType, BaseVariableType, DataItemType, DiscreteItemType, Node, VariableNode

All Known Implementing Classes:

MultiStateValueDiscreteTypeNode

public interface MultiStateValueDiscreteType
extends DiscreteItemType

Field Summary

Fields

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

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.EnumValueType[]	getEnumValues() Get the local value of the EnumValues Node.
PropertyType	getEnumValuesNode() Get the EnumValues PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getEnumValuesNodeAsync() Asynchronous implementation of getEnumValuesNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getValueAsText() Get the local value of the ValueAsText Node.
PropertyType	getValueAsTextNode() Get the ValueAsText PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getValueAsTextNodeAsync() Asynchronous implementation of getValueAsTextNode().
org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[]	readEnumValues() Read the value of the EnumValues Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[]>	readEnumValuesAsync() An asynchronous implementation of readEnumValues().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readValueAsText() Read the value of the ValueAsText Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readValueAsTextAsync() An asynchronous implementation of readValueAsText().
void	setEnumValues(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] enumValues) Set the local value of the EnumValues Node.
void	setValueAsText(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText valueAsText) Set the local value of the ValueAsText Node.
void	writeEnumValues(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] enumValues) Write a new value for the EnumValues Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEnumValuesAsync(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] enumValues) An asynchronous implementation of writeEnumValues(EnumValueType[]).
void	writeValueAsText(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText valueAsText) Write a new value for the ValueAsText Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeValueAsTextAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText valueAsText) An asynchronous implementation of writeValueAsText(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_VALUES

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[]> ENUM_VALUES

VALUE_AS_TEXT

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> VALUE_AS_TEXT

Method Detail

getEnumValues

org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] getEnumValues()
                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the EnumValues Node.

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

Returns:

the local value of the EnumValues Node.

Throws:

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

setEnumValues

void setEnumValues(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] enumValues)
            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the EnumValues Node.

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

Parameters:

enumValues - the local value to set for the EnumValues Node.

Throws:

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

readEnumValues

org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] readEnumValues()
                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the EnumValueType[] value read from the server.

Throws:

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

writeEnumValues

void writeEnumValues(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] enumValues)
              throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

enumValues - the EnumValueType[] value to write to the server.

Throws:

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

readEnumValuesAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[]> readEnumValuesAsync()

An asynchronous implementation of readEnumValues().

Returns:

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

writeEnumValuesAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEnumValuesAsync(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] enumValues)

An asynchronous implementation of writeEnumValues(EnumValueType[]).

Returns:

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

getEnumValuesNode

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

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

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

Returns:

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

getEnumValuesNodeAsync

CompletableFuture<? extends PropertyType> getEnumValuesNodeAsync()

Asynchronous implementation of getEnumValuesNode().

Returns:

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

getValueAsText

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getValueAsText()
                                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ValueAsText Node.

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

Returns:

the local value of the ValueAsText Node.

Throws:

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

setValueAsText

void setValueAsText(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText valueAsText)
             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ValueAsText Node.

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

Parameters:

valueAsText - the local value to set for the ValueAsText Node.

Throws:

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

readValueAsText

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readValueAsText()
                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

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

writeValueAsText

void writeValueAsText(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText valueAsText)
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

valueAsText - the LocalizedText value to write to the server.

Throws:

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

readValueAsTextAsync

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

An asynchronous implementation of readValueAsText().

Returns:

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

writeValueAsTextAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeValueAsTextAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText valueAsText)

An asynchronous implementation of writeValueAsText(LocalizedText).

Returns:

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

getValueAsTextNode

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

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

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

Returns:

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

getValueAsTextNodeAsync

CompletableFuture<? extends PropertyType> getValueAsTextNodeAsync()

Asynchronous implementation of getValueAsTextNode().

Returns:

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