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

Class ProgramTransitionEventTypeNode

java.lang.Object

org.eclipse.milo.opcua.sdk.client.nodes.UaNode

org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode

org.eclipse.milo.opcua.sdk.client.model.nodes.objects.BaseObjectTypeNode

org.eclipse.milo.opcua.sdk.client.model.nodes.objects.BaseEventTypeNode

org.eclipse.milo.opcua.sdk.client.model.nodes.objects.TransitionEventTypeNode

org.eclipse.milo.opcua.sdk.client.model.nodes.objects.ProgramTransitionEventTypeNode

All Implemented Interfaces:

BaseEventType, BaseObjectType, ProgramTransitionEventType, TransitionEventType, Node, ObjectNode

public class ProgramTransitionEventTypeNode
extends TransitionEventTypeNode
implements ProgramTransitionEventType

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.types.objects.ProgramTransitionEventType

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

Constructor Summary

Constructors

Constructor and Description

ProgramTransitionEventTypeNode(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.builtin.unsigned.UByte eventNotifier)

Method Summary

Modifier and Type	Method and Description
Object	getIntermediateResult() Get the local value of the IntermediateResult Node.
PropertyTypeNode	getIntermediateResultNode() Get the IntermediateResult PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getIntermediateResultNodeAsync() Asynchronous implementation of ProgramTransitionEventType.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 ProgramTransitionEventType.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 ProgramTransitionEventType.writeIntermediateResult(Object).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.nodes.objects.TransitionEventTypeNode

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 class org.eclipse.milo.opcua.sdk.client.model.nodes.objects.BaseEventTypeNode

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 class org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode

callMethod, callMethod, callMethodAsync, callMethodAsync, getAttributeValue, getEventNotifier, getIcon, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersion, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIcon, setNamingRuleAsync, setNodeVersion, writeEventNotifier

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getUserWriteMask, getWriteMask, invalidate, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readUserWriteMask, readWriteMask, refresh, refreshAsync, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, 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.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

Constructor Detail

ProgramTransitionEventTypeNode

public ProgramTransitionEventTypeNode(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.builtin.unsigned.UByte eventNotifier)

Method Detail

getIntermediateResult

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

Description copied from interface: ProgramTransitionEventType

Get the local value of the IntermediateResult Node.

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

Specified by:

getIntermediateResult in interface ProgramTransitionEventType

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

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

Description copied from interface: ProgramTransitionEventType

Set the local value of the IntermediateResult Node.

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

Specified by:

setIntermediateResult in interface ProgramTransitionEventType

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

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

Description copied from interface: ProgramTransitionEventType

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

Specified by:

readIntermediateResult in interface ProgramTransitionEventType

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

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

Description copied from interface: ProgramTransitionEventType

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

Specified by:

writeIntermediateResult in interface ProgramTransitionEventType

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

public CompletableFuture<?> readIntermediateResultAsync()

Description copied from interface: ProgramTransitionEventType

An asynchronous implementation of ProgramTransitionEventType.readIntermediateResult().

Specified by:

readIntermediateResultAsync in interface ProgramTransitionEventType

Returns:

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

writeIntermediateResultAsync

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

Description copied from interface: ProgramTransitionEventType

An asynchronous implementation of ProgramTransitionEventType.writeIntermediateResult(Object).

Specified by:

writeIntermediateResultAsync in interface ProgramTransitionEventType

Returns:

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

getIntermediateResultNode

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

Description copied from interface: ProgramTransitionEventType

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

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

Specified by:

getIntermediateResultNode in interface ProgramTransitionEventType

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

public CompletableFuture<? extends PropertyTypeNode> getIntermediateResultNodeAsync()

Description copied from interface: ProgramTransitionEventType

Asynchronous implementation of ProgramTransitionEventType.getIntermediateResultNode().

Specified by:

getIntermediateResultNodeAsync in interface ProgramTransitionEventType

Returns:

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