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

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

Class StateVariableTypeNode

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

All Implemented Interfaces:

BaseDataVariableType, BaseVariableType, StateVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

Direct Known Subclasses:

FiniteStateVariableTypeNode, TwoStateVariableTypeNode

public class StateVariableTypeNode
extends BaseDataVariableTypeNode
implements StateVariableType

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

EFFECTIVE_DISPLAY_NAME, ID, NAME, NUMBER

Constructor Summary

Constructors

Constructor

Description

StateVariableTypeNode(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	getEffectiveDisplayName()	Get the local value of the EffectiveDisplayName Node.
PropertyTypeNode	getEffectiveDisplayNameNode()	Get the EffectiveDisplayName PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getEffectiveDisplayNameNodeAsync()	Asynchronous implementation of StateVariableType.getEffectiveDisplayNameNode().
Object	getId()	Get the local value of the Id Node.
PropertyTypeNode	getIdNode()	Get the Id PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getIdNodeAsync()	Asynchronous implementation of StateVariableType.getIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName	getName()	Get the local value of the Name Node.
PropertyTypeNode	getNameNode()	Get the Name PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getNameNodeAsync()	Asynchronous implementation of StateVariableType.getNameNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getNumber()	Get the local value of the Number Node.
PropertyTypeNode	getNumberNode()	Get the Number PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getNumberNodeAsync()	Asynchronous implementation of StateVariableType.getNumberNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readEffectiveDisplayName()	Read the value of the EffectiveDisplayName Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readEffectiveDisplayNameAsync()	An asynchronous implementation of StateVariableType.readEffectiveDisplayName().
Object	readId()	Read the value of the Id Node from the server and update the local value if the operation succeeds.
CompletableFuture<?>	readIdAsync()	An asynchronous implementation of StateVariableType.readId().
org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName	readName()	Read the value of the Name Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName>	readNameAsync()	An asynchronous implementation of StateVariableType.readName().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readNumber()	Read the value of the Number Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readNumberAsync()	An asynchronous implementation of StateVariableType.readNumber().
void	setEffectiveDisplayName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Set the local value of the EffectiveDisplayName Node.
void	setId(Object value)	Set the local value of the Id Node.
void	setName(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName value)	Set the local value of the Name Node.
void	setNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Set the local value of the Number Node.
void	writeEffectiveDisplayName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Write a new value for the EffectiveDisplayName Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEffectiveDisplayNameAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText effectiveDisplayName)	An asynchronous implementation of StateVariableType.writeEffectiveDisplayName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).
void	writeId(Object value)	Write a new value for the Id Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeIdAsync(Object id)	An asynchronous implementation of StateVariableType.writeId(java.lang.Object).
void	writeName(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName value)	Write a new value for the Name Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNameAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName name)	An asynchronous implementation of StateVariableType.writeName(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName).
void	writeNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Write a new value for the Number Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNumberAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger number)	An asynchronous implementation of StateVariableType.writeNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

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

StateVariableTypeNode

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

getId

public Object getId()
             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StateVariableType

Get the local value of the Id Node.

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

Specified by:

getId in interface StateVariableType

Returns:

the local value of the Id Node.

Throws:

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

setId

public void setId(Object value)
           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StateVariableType

Set the local value of the Id Node.

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

Specified by:

setId in interface StateVariableType

Parameters:

value - the local value to set for the Id Node.

Throws:

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

readId

public Object readId()
              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StateVariableType

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

Specified by:

readId in interface StateVariableType

Returns:

the Object value read from the server.

Throws:

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

writeId

public void writeId(Object value)
             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StateVariableType

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

Specified by:

writeId in interface StateVariableType

Parameters:

value - the Object value to write to the server.

Throws:

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

readIdAsync

public CompletableFuture<?> readIdAsync()

Description copied from interface: StateVariableType

An asynchronous implementation of StateVariableType.readId().

Specified by:

readIdAsync in interface StateVariableType

Returns:

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

writeIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIdAsync(Object id)

Description copied from interface: StateVariableType

An asynchronous implementation of StateVariableType.writeId(java.lang.Object).

Specified by:

writeIdAsync in interface StateVariableType

Returns:

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

getIdNode

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

Description copied from interface: StateVariableType

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

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

Specified by:

getIdNode in interface StateVariableType

Returns:

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

getIdNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getIdNodeAsync()

Description copied from interface: StateVariableType

Asynchronous implementation of StateVariableType.getIdNode().

Specified by:

getIdNodeAsync in interface StateVariableType

Returns:

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

getName

public org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName getName()
                                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StateVariableType

Get the local value of the Name Node.

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

Specified by:

getName in interface StateVariableType

Returns:

the local value of the Name Node.

Throws:

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

setName

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

Description copied from interface: StateVariableType

Set the local value of the Name Node.

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

Specified by:

setName in interface StateVariableType

Parameters:

value - the local value to set for the Name Node.

Throws:

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

readName

public org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName readName()
                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StateVariableType

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

Specified by:

readName in interface StateVariableType

Returns:

the QualifiedName value read from the server.

Throws:

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

writeName

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

Description copied from interface: StateVariableType

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

Specified by:

writeName in interface StateVariableType

Parameters:

value - the QualifiedName value to write to the server.

Throws:

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

readNameAsync

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

Description copied from interface: StateVariableType

An asynchronous implementation of StateVariableType.readName().

Specified by:

readNameAsync in interface StateVariableType

Returns:

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

writeNameAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNameAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName name)

Description copied from interface: StateVariableType

An asynchronous implementation of StateVariableType.writeName(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName).

Specified by:

writeNameAsync in interface StateVariableType

Returns:

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

getNameNode

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

Description copied from interface: StateVariableType

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

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

Specified by:

getNameNode in interface StateVariableType

Returns:

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

getNameNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getNameNodeAsync()

Description copied from interface: StateVariableType

Asynchronous implementation of StateVariableType.getNameNode().

Specified by:

getNameNodeAsync in interface StateVariableType

Returns:

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

getNumber

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getNumber()
                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StateVariableType

Get the local value of the Number Node.

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

Specified by:

getNumber in interface StateVariableType

Returns:

the local value of the Number Node.

Throws:

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

setNumber

public void setNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StateVariableType

Set the local value of the Number Node.

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

Specified by:

setNumber in interface StateVariableType

Parameters:

value - the local value to set for the Number Node.

Throws:

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

readNumber

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readNumber()
                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StateVariableType

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

Specified by:

readNumber in interface StateVariableType

Returns:

the UInteger value read from the server.

Throws:

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

writeNumber

public void writeNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StateVariableType

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

Specified by:

writeNumber in interface StateVariableType

Parameters:

value - the UInteger value to write to the server.

Throws:

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

readNumberAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readNumberAsync()

Description copied from interface: StateVariableType

An asynchronous implementation of StateVariableType.readNumber().

Specified by:

readNumberAsync in interface StateVariableType

Returns:

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

writeNumberAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNumberAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger number)

Description copied from interface: StateVariableType

An asynchronous implementation of StateVariableType.writeNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

Specified by:

writeNumberAsync in interface StateVariableType

Returns:

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

getNumberNode

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

Description copied from interface: StateVariableType

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

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

Specified by:

getNumberNode in interface StateVariableType

Returns:

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

getNumberNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getNumberNodeAsync()

Description copied from interface: StateVariableType

Asynchronous implementation of StateVariableType.getNumberNode().

Specified by:

getNumberNodeAsync in interface StateVariableType

Returns:

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

getEffectiveDisplayName

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

Description copied from interface: StateVariableType

Get the local value of the EffectiveDisplayName Node.

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

Specified by:

getEffectiveDisplayName in interface StateVariableType

Returns:

the local value of the EffectiveDisplayName Node.

Throws:

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

setEffectiveDisplayName

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

Description copied from interface: StateVariableType

Set the local value of the EffectiveDisplayName Node.

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

Specified by:

setEffectiveDisplayName in interface StateVariableType

Parameters:

value - the local value to set for the EffectiveDisplayName Node.

Throws:

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

readEffectiveDisplayName

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

Description copied from interface: StateVariableType

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

Specified by:

readEffectiveDisplayName in interface StateVariableType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeEffectiveDisplayName

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

Description copied from interface: StateVariableType

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

Specified by:

writeEffectiveDisplayName in interface StateVariableType

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.

readEffectiveDisplayNameAsync

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

Description copied from interface: StateVariableType

An asynchronous implementation of StateVariableType.readEffectiveDisplayName().

Specified by:

readEffectiveDisplayNameAsync in interface StateVariableType

Returns:

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

writeEffectiveDisplayNameAsync

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

Description copied from interface: StateVariableType

An asynchronous implementation of StateVariableType.writeEffectiveDisplayName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

Specified by:

writeEffectiveDisplayNameAsync in interface StateVariableType

Returns:

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

getEffectiveDisplayNameNode

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

Description copied from interface: StateVariableType

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

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

Specified by:

getEffectiveDisplayNameNode in interface StateVariableType

Returns:

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

getEffectiveDisplayNameNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getEffectiveDisplayNameNodeAsync()

Description copied from interface: StateVariableType

Asynchronous implementation of StateVariableType.getEffectiveDisplayNameNode().

Specified by:

getEffectiveDisplayNameNodeAsync in interface StateVariableType

Returns:

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