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

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

Class MultiStateDiscreteTypeNode

java.lang.Object

org.eclipse.milo.opcua.sdk.client.nodes.UaNode

org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

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

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

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

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

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

All Implemented Interfaces:

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

public class MultiStateDiscreteTypeNode
extends DiscreteItemTypeNode
implements MultiStateDiscreteType

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

client

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.DataItemType

DEFINITION, VALUE_PRECISION

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.MultiStateDiscreteType

ENUM_STRINGS

Constructor Summary

Constructors

Constructor

Description

MultiStateDiscreteTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]	getEnumStrings()	Get the local value of the EnumStrings Node.
PropertyTypeNode	getEnumStringsNode()	Get the EnumStrings PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getEnumStringsNodeAsync()	Asynchronous implementation of MultiStateDiscreteType.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 MultiStateDiscreteType.readEnumStrings().
void	setEnumStrings(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)	Set the local value of the EnumStrings Node.
void	writeEnumStrings(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)	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 MultiStateDiscreteType.writeEnumStrings(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.variables.DataItemTypeNode

getDefinition, getDefinitionNode, getDefinitionNodeAsync, getValuePrecision, getValuePrecisionNode, getValuePrecisionNodeAsync, readDefinition, readDefinitionAsync, readValuePrecision, readValuePrecisionAsync, setDefinition, setValuePrecision, writeDefinition, writeDefinitionAsync, writeValuePrecision, writeValuePrecisionAsync

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

getAccessLevel, getAccessLevelEx, getArrayDimensions, getAttributeValue, getDataType, getHistorizing, getMinimumSamplingInterval, getTypeDefinition, getTypeDefinitionAsync, getUserAccessLevel, getValue, getValueRank, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readAccessLevel, readAccessLevelEx, readAllowNullsAsync, readArrayDimensions, readDataType, readDataTypeVersionAsync, readDictionaryFragmentAsync, readEngineeringUnitsAsync, readHistorizing, readLocalTimeAsync, readMaxArrayLengthAsync, readMaxStringLengthAsync, readMinimumSamplingInterval, readNodeVersionAsync, readUserAccessLevel, readValue, readValueAsTextAsync, readValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setAttributeValue, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValue, setValueRank, writeAccessLevel, writeAccessLevelEx, writeAllowNullsAsync, writeArrayDimensions, writeDataType, writeDataTypeVersionAsync, writeDictionaryFragmentAsync, writeEngineeringUnitsAsync, writeHistorizing, writeLocalTimeAsync, writeMaxArrayLengthAsync, writeMaxStringLengthAsync, writeMinimumSamplingInterval, writeNodeVersionAsync, writeUserAccessLevel, writeValue, writeValue, writeValueAsTextAsync, writeValueRank

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, writeUserWriteMask, writeWriteMask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.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.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

Constructor Details

MultiStateDiscreteTypeNode

public MultiStateDiscreteTypeNode(OpcUaClient client,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
 org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass,
 org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions,
 org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType,
 Integer valueRank,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel,
 Double minimumSamplingInterval,
 Boolean historizing,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Details

getEnumStrings

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

Description copied from interface: MultiStateDiscreteType

Get the local value of the EnumStrings Node.

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

Specified by:

getEnumStrings in interface MultiStateDiscreteType

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

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

Description copied from interface: MultiStateDiscreteType

Set the local value of the EnumStrings Node.

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

Specified by:

setEnumStrings in interface MultiStateDiscreteType

Parameters:

value - 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

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

Description copied from interface: MultiStateDiscreteType

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

Specified by:

readEnumStrings in interface MultiStateDiscreteType

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

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

Description copied from interface: MultiStateDiscreteType

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

Specified by:

writeEnumStrings in interface MultiStateDiscreteType

Parameters:

value - 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

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

Description copied from interface: MultiStateDiscreteType

An asynchronous implementation of MultiStateDiscreteType.readEnumStrings().

Specified by:

readEnumStringsAsync in interface MultiStateDiscreteType

Returns:

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

writeEnumStringsAsync

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

Description copied from interface: MultiStateDiscreteType

An asynchronous implementation of MultiStateDiscreteType.writeEnumStrings(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]).

Specified by:

writeEnumStringsAsync in interface MultiStateDiscreteType

Returns:

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

getEnumStringsNode

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

Description copied from interface: MultiStateDiscreteType

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

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

Specified by:

getEnumStringsNode in interface MultiStateDiscreteType

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

public CompletableFuture<? extends PropertyTypeNode> getEnumStringsNodeAsync()

Description copied from interface: MultiStateDiscreteType

Asynchronous implementation of MultiStateDiscreteType.getEnumStringsNode().

Specified by:

getEnumStringsNodeAsync in interface MultiStateDiscreteType

Returns:

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