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

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

Interface FiniteTransitionVariableType

All Superinterfaces:

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

All Known Implementing Classes:

FiniteTransitionVariableTypeNode

public interface FiniteTransitionVariableType
extends TransitionVariableType

See Also:

• https://reference.opcfoundation.org/v105/Core/docs/Part16/4.4.7

Field Summary

Fields

Modifier and Type	Field	Description
static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	ID

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

EFFECTIVE_TRANSITION_TIME, NAME, NUMBER, TRANSITION_TIME

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.
PropertyType	getIdNode()	Get the Id PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getIdNodeAsync()	Asynchronous implementation of 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 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 value)	An asynchronous implementation of writeId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).

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

getEffectiveTransitionTime, getEffectiveTransitionTimeNode, getEffectiveTransitionTimeNodeAsync, getName, getNameNode, getNameNodeAsync, getNumber, getNumberNode, getNumberNodeAsync, getTransitionTime, getTransitionTimeNode, getTransitionTimeNodeAsync, readEffectiveTransitionTime, readEffectiveTransitionTimeAsync, readName, readNameAsync, readNumber, readNumberAsync, readTransitionTime, readTransitionTimeAsync, setEffectiveTransitionTime, setId, setName, setNumber, setTransitionTime, writeEffectiveTransitionTime, writeEffectiveTransitionTimeAsync, writeId, writeIdAsync, writeName, writeNameAsync, writeNumber, writeNumberAsync, writeTransitionTime, writeTransitionTimeAsync

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

Field Details

ID

static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> ID

Method Details

getId

org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getId()
                                                      throws org.eclipse.milo.opcua.stack.core.UaException

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 TransitionVariableType

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

void setId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
    throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Id Node.

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

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

org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readId()
                                                       throws org.eclipse.milo.opcua.stack.core.UaException

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

Specified by:

readId in interface TransitionVariableType

Returns:

the NodeId value read from the server.

Throws:

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

writeId

void writeId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
      throws org.eclipse.milo.opcua.stack.core.UaException

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

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

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> readIdAsync()

An asynchronous implementation of readId().

Specified by:

readIdAsync in interface TransitionVariableType

Returns:

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

writeIdAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)

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

Returns:

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

getIdNode

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

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 TransitionVariableType

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

CompletableFuture<? extends PropertyType> getIdNodeAsync()

Asynchronous implementation of getIdNode().

Specified by:

getIdNodeAsync in interface TransitionVariableType

Returns:

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