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

Interface OptionSetType

All Superinterfaces:

BaseDataVariableType, BaseVariableType, Node, VariableNode

All Known Implementing Classes:

OptionSetTypeNode

public interface OptionSetType
extends BaseDataVariableType

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
Boolean[]	getBitMask() Get the local value of the BitMask Node.
PropertyType	getBitMaskNode() Get the BitMask PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getBitMaskNodeAsync() Asynchronous implementation of getBitMaskNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]	getOptionSetValues() Get the local value of the OptionSetValues Node.
PropertyType	getOptionSetValuesNode() Get the OptionSetValues PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getOptionSetValuesNodeAsync() Asynchronous implementation of getOptionSetValuesNode().
Boolean[]	readBitMask() Read the value of the BitMask Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean[]>	readBitMaskAsync() An asynchronous implementation of readBitMask().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]	readOptionSetValues() Read the value of the OptionSetValues Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]>	readOptionSetValuesAsync() An asynchronous implementation of readOptionSetValues().
void	setBitMask(Boolean[] bitMask) Set the local value of the BitMask Node.
void	setOptionSetValues(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] optionSetValues) Set the local value of the OptionSetValues Node.
void	writeBitMask(Boolean[] bitMask) Write a new value for the BitMask Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeBitMaskAsync(Boolean[] bitMask) An asynchronous implementation of writeBitMask(Boolean[]).
void	writeOptionSetValues(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] optionSetValues) Write a new value for the OptionSetValues Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeOptionSetValuesAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] optionSetValues) An asynchronous implementation of writeOptionSetValues(LocalizedText[]).

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

OPTION_SET_VALUES

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

BIT_MASK

static final QualifiedProperty<Boolean[]> BIT_MASK

Method Detail

getOptionSetValues

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

Get the local value of the OptionSetValues Node.

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

Returns:

the local value of the OptionSetValues Node.

Throws:

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

setOptionSetValues

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

Set the local value of the OptionSetValues Node.

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

Parameters:

optionSetValues - the local value to set for the OptionSetValues Node.

Throws:

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

readOptionSetValues

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

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

writeOptionSetValues

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

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

Parameters:

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

Throws:

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

readOptionSetValuesAsync

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

An asynchronous implementation of readOptionSetValues().

Returns:

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

writeOptionSetValuesAsync

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

An asynchronous implementation of writeOptionSetValues(LocalizedText[]).

Returns:

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

getOptionSetValuesNode

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

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

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

Returns:

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

getOptionSetValuesNodeAsync

CompletableFuture<? extends PropertyType> getOptionSetValuesNodeAsync()

Asynchronous implementation of getOptionSetValuesNode().

Returns:

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

getBitMask

Boolean[] getBitMask()
              throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the BitMask Node.

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

Returns:

the local value of the BitMask Node.

Throws:

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

setBitMask

void setBitMask(Boolean[] bitMask)
         throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the BitMask Node.

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

Parameters:

bitMask - the local value to set for the BitMask Node.

Throws:

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

readBitMask

Boolean[] readBitMask()
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Boolean[] value read from the server.

Throws:

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

writeBitMask

void writeBitMask(Boolean[] bitMask)
           throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

bitMask - the Boolean[] value to write to the server.

Throws:

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

readBitMaskAsync

CompletableFuture<? extends Boolean[]> readBitMaskAsync()

An asynchronous implementation of readBitMask().

Returns:

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

writeBitMaskAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeBitMaskAsync(Boolean[] bitMask)

An asynchronous implementation of writeBitMask(Boolean[]).

Returns:

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

getBitMaskNode

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

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

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

Returns:

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

getBitMaskNodeAsync

CompletableFuture<? extends PropertyType> getBitMaskNodeAsync()

Asynchronous implementation of getBitMaskNode().

Returns:

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