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

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

Class MultiStateValueDiscreteTypeNode

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.MultiStateValueDiscreteTypeNode

All Implemented Interfaces:

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

Direct Known Subclasses:

MultiStateDictionaryEntryDiscreteBaseTypeNode

public class MultiStateValueDiscreteTypeNode
extends DiscreteItemTypeNode
implements MultiStateValueDiscreteType

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.MultiStateValueDiscreteType

ENUM_VALUES, VALUE_AS_TEXT

Constructor Summary

Constructors

Constructor

Description

MultiStateValueDiscreteTypeNode(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.structured.EnumValueType[]	getEnumValues()	Get the local value of the EnumValues Node.
PropertyTypeNode	getEnumValuesNode()	Get the EnumValues PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getEnumValuesNodeAsync()	Asynchronous implementation of MultiStateValueDiscreteType.getEnumValuesNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getValueAsText()	Get the local value of the ValueAsText Node.
PropertyTypeNode	getValueAsTextNode()	Get the ValueAsText PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getValueAsTextNodeAsync()	Asynchronous implementation of MultiStateValueDiscreteType.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 MultiStateValueDiscreteType.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()	Get the value of the VariableNodeProperties.ValueAsText Property, if it exists.
void	setEnumValues(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] value)	Set the local value of the EnumValues Node.
void	setValueAsText(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Set the local value of the ValueAsText Node.
void	writeEnumValues(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] value)	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 MultiStateValueDiscreteType.writeEnumValues(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[]).
void	writeValueAsText(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	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)	Set the value of the VariableNodeProperties.ValueAsText Property, if it exists.

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

MultiStateValueDiscreteTypeNode

public MultiStateValueDiscreteTypeNode(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

getEnumValues

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

Description copied from interface: MultiStateValueDiscreteType

Get the local value of the EnumValues Node.

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

Specified by:

getEnumValues in interface MultiStateValueDiscreteType

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

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

Description copied from interface: MultiStateValueDiscreteType

Set the local value of the EnumValues Node.

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

Specified by:

setEnumValues in interface MultiStateValueDiscreteType

Parameters:

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

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

Description copied from interface: MultiStateValueDiscreteType

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

Specified by:

readEnumValues in interface MultiStateValueDiscreteType

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

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

Description copied from interface: MultiStateValueDiscreteType

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

Specified by:

writeEnumValues in interface MultiStateValueDiscreteType

Parameters:

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

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

Description copied from interface: MultiStateValueDiscreteType

An asynchronous implementation of MultiStateValueDiscreteType.readEnumValues().

Specified by:

readEnumValuesAsync in interface MultiStateValueDiscreteType

Returns:

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

writeEnumValuesAsync

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

Description copied from interface: MultiStateValueDiscreteType

An asynchronous implementation of MultiStateValueDiscreteType.writeEnumValues(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[]).

Specified by:

writeEnumValuesAsync in interface MultiStateValueDiscreteType

Returns:

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

getEnumValuesNode

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

Description copied from interface: MultiStateValueDiscreteType

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

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

Specified by:

getEnumValuesNode in interface MultiStateValueDiscreteType

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

public CompletableFuture<? extends PropertyTypeNode> getEnumValuesNodeAsync()

Description copied from interface: MultiStateValueDiscreteType

Asynchronous implementation of MultiStateValueDiscreteType.getEnumValuesNode().

Specified by:

getEnumValuesNodeAsync in interface MultiStateValueDiscreteType

Returns:

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

getValueAsText

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

Description copied from interface: MultiStateValueDiscreteType

Get the local value of the ValueAsText Node.

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

Specified by:

getValueAsText in interface MultiStateValueDiscreteType

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

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

Description copied from interface: MultiStateValueDiscreteType

Set the local value of the ValueAsText Node.

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

Specified by:

setValueAsText in interface MultiStateValueDiscreteType

Parameters:

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

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

Description copied from interface: MultiStateValueDiscreteType

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

Specified by:

readValueAsText in interface MultiStateValueDiscreteType

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

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

Description copied from interface: MultiStateValueDiscreteType

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

Specified by:

writeValueAsText in interface MultiStateValueDiscreteType

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.

readValueAsTextAsync

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

Description copied from class: UaVariableNode

Get the value of the VariableNodeProperties.ValueAsText Property, if it exists.

Specified by:

readValueAsTextAsync in interface MultiStateValueDiscreteType

Overrides:

readValueAsTextAsync in class UaVariableNode

Returns:

the value of the ValueAsText Property, if it exists.

See Also:

• VariableNodeProperties

writeValueAsTextAsync

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

Description copied from class: UaVariableNode

Set the value of the VariableNodeProperties.ValueAsText Property, if it exists.

Specified by:

writeValueAsTextAsync in interface MultiStateValueDiscreteType

Overrides:

writeValueAsTextAsync in class UaVariableNode

Parameters:

valueAsText - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

• VariableNodeProperties

getValueAsTextNode

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

Description copied from interface: MultiStateValueDiscreteType

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

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

Specified by:

getValueAsTextNode in interface MultiStateValueDiscreteType

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

public CompletableFuture<? extends PropertyTypeNode> getValueAsTextNodeAsync()

Description copied from interface: MultiStateValueDiscreteType

Asynchronous implementation of MultiStateValueDiscreteType.getValueAsTextNode().

Specified by:

getValueAsTextNodeAsync in interface MultiStateValueDiscreteType

Returns:

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