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

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

Class FiniteStateVariableTypeNode

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

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

All Implemented Interfaces:

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

public class FiniteStateVariableTypeNode
extends StateVariableTypeNode
implements FiniteStateVariableType

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

ID

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

EFFECTIVE_DISPLAY_NAME, ID, NAME, NUMBER

Constructor Summary

Constructors

Constructor

Description

FiniteStateVariableTypeNode(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.NodeId	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.NodeId	readId()	Read the value of the Id Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readIdAsync()	An asynchronous implementation of StateVariableType.readId().
void	setId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)	Set the local value of the Id Node.
void	writeId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId 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(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id)	An asynchronous implementation of FiniteStateVariableType.writeId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).

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

getEffectiveDisplayName, getEffectiveDisplayNameNode, getEffectiveDisplayNameNodeAsync, getName, getNameNode, getNameNodeAsync, getNumber, getNumberNode, getNumberNodeAsync, readEffectiveDisplayName, readEffectiveDisplayNameAsync, readName, readNameAsync, readNumber, readNumberAsync, setEffectiveDisplayName, setId, setName, setNumber, writeEffectiveDisplayName, writeEffectiveDisplayNameAsync, writeId, writeIdAsync, writeName, writeNameAsync, writeNumber, writeNumberAsync

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.client.model.variables.StateVariableType

getEffectiveDisplayName, getEffectiveDisplayNameNode, getEffectiveDisplayNameNodeAsync, getName, getNameNode, getNameNodeAsync, getNumber, getNumberNode, getNumberNodeAsync, readEffectiveDisplayName, readEffectiveDisplayNameAsync, readName, readNameAsync, readNumber, readNumberAsync, setEffectiveDisplayName, setId, setName, setNumber, writeEffectiveDisplayName, writeEffectiveDisplayNameAsync, writeId, writeIdAsync, writeName, writeNameAsync, writeNumber, writeNumberAsync

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

FiniteStateVariableTypeNode

public FiniteStateVariableTypeNode(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 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId 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 FiniteStateVariableType

Specified by:

getId in interface StateVariableType

Overrides:

getId in class StateVariableTypeNode

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(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FiniteStateVariableType

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 FiniteStateVariableType

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 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId 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 FiniteStateVariableType

Specified by:

readId in interface StateVariableType

Overrides:

readId in class StateVariableTypeNode

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(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FiniteStateVariableType

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 FiniteStateVariableType

Parameters:

value - the NodeId 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<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> readIdAsync()

Description copied from interface: StateVariableType

An asynchronous implementation of StateVariableType.readId().

Specified by:

readIdAsync in interface FiniteStateVariableType

Specified by:

readIdAsync in interface StateVariableType

Overrides:

readIdAsync in class StateVariableTypeNode

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(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id)

Description copied from interface: FiniteStateVariableType

An asynchronous implementation of FiniteStateVariableType.writeId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).

Specified by:

writeIdAsync in interface FiniteStateVariableType

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 FiniteStateVariableType

Specified by:

getIdNode in interface StateVariableType

Overrides:

getIdNode in class StateVariableTypeNode

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 FiniteStateVariableType

Specified by:

getIdNodeAsync in interface StateVariableType

Overrides:

getIdNodeAsync in class StateVariableTypeNode

Returns:

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