org.eclipse.milo.opcua.sdk.client.model.types.objects

Interface ProgramTransitionEventType

All Superinterfaces:

BaseEventType, BaseObjectType, Node, ObjectNode, TransitionEventType

All Known Implementing Classes:

ProgramTransitionEventTypeNode

public interface ProgramTransitionEventType
extends TransitionEventType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<Object>	INTERMEDIATE_RESULT

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.BaseEventType

EVENT_ID, EVENT_TYPE, LOCAL_TIME, MESSAGE, RECEIVE_TIME, SEVERITY, SOURCE_NAME, SOURCE_NODE, TIME

Method Summary

Modifier and Type	Method and Description
Object	getIntermediateResult() Get the local value of the IntermediateResult Node.
PropertyType	getIntermediateResultNode() Get the IntermediateResult PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getIntermediateResultNodeAsync() Asynchronous implementation of getIntermediateResultNode().
Object	readIntermediateResult() Read the value of the IntermediateResult Node from the server and update the local value if the operation succeeds.
CompletableFuture<?>	readIntermediateResultAsync() An asynchronous implementation of readIntermediateResult().
void	setIntermediateResult(Object intermediateResult) Set the local value of the IntermediateResult Node.
void	writeIntermediateResult(Object intermediateResult) Write a new value for the IntermediateResult Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeIntermediateResultAsync(Object intermediateResult) An asynchronous implementation of writeIntermediateResult(Object).

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.TransitionEventType

getFromState, getFromStateNode, getFromStateNodeAsync, getToState, getToStateNode, getToStateNodeAsync, getTransition, getTransitionNode, getTransitionNodeAsync, readFromState, readFromStateAsync, readToState, readToStateAsync, readTransition, readTransitionAsync, setFromState, setToState, setTransition, writeFromState, writeFromStateAsync, writeToState, writeToStateAsync, writeTransition, writeTransitionAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.BaseEventType

getEventId, getEventIdNode, getEventIdNodeAsync, getEventType, getEventTypeNode, getEventTypeNodeAsync, getLocalTime, getLocalTimeNode, getLocalTimeNodeAsync, getMessage, getMessageNode, getMessageNodeAsync, getReceiveTime, getReceiveTimeNode, getReceiveTimeNodeAsync, getSeverity, getSeverityNode, getSeverityNodeAsync, getSourceName, getSourceNameNode, getSourceNameNodeAsync, getSourceNode, getSourceNodeNode, getSourceNodeNodeAsync, getTime, getTimeNode, getTimeNodeAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeEventId, writeEventIdAsync, writeEventType, writeEventTypeAsync, writeLocalTime, writeLocalTimeAsync, writeMessage, writeMessageAsync, writeReceiveTime, writeReceiveTimeAsync, writeSeverity, writeSeverityAsync, writeSourceName, writeSourceNameAsync, writeSourceNode, writeSourceNodeAsync, writeTime, writeTimeAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

getEventNotifier, setEventNotifier

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Field Detail

INTERMEDIATE_RESULT

static final QualifiedProperty<Object> INTERMEDIATE_RESULT

Method Detail

getIntermediateResult

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

Get the local value of the IntermediateResult Node.

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

Returns:

the local value of the IntermediateResult Node.

Throws:

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

setIntermediateResult

void setIntermediateResult(Object intermediateResult)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the IntermediateResult Node.

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

Parameters:

intermediateResult - the local value to set for the IntermediateResult Node.

Throws:

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

readIntermediateResult

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

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

Returns:

the Object value read from the server.

Throws:

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

writeIntermediateResult

void writeIntermediateResult(Object intermediateResult)
                      throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

intermediateResult - the Object value to write to the server.

Throws:

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

readIntermediateResultAsync

CompletableFuture<?> readIntermediateResultAsync()

An asynchronous implementation of readIntermediateResult().

Returns:

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

writeIntermediateResultAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIntermediateResultAsync(Object intermediateResult)

An asynchronous implementation of writeIntermediateResult(Object).

Returns:

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

getIntermediateResultNode

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

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

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

Returns:

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

getIntermediateResultNodeAsync

CompletableFuture<? extends PropertyType> getIntermediateResultNodeAsync()

Asynchronous implementation of getIntermediateResultNode().

Returns:

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