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

Class TransitionEventTypeNode

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

All Implemented Interfaces:

BaseEventType, BaseObjectType, TransitionEventType, Node, ObjectNode

Direct Known Subclasses:

ProgramTransitionEventTypeNode

public class TransitionEventTypeNode
extends BaseEventTypeNode
implements TransitionEventType

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

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

Constructor Summary

Constructors

Constructor and Description

TransitionEventTypeNode(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
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getFromState() Get the local value of the FromState Node.
StateVariableTypeNode	getFromStateNode() Get the FromState StateVariableType Node, or null if it does not exist.
CompletableFuture<? extends StateVariableTypeNode>	getFromStateNodeAsync() Asynchronous implementation of TransitionEventType.getFromStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getToState() Get the local value of the ToState Node.
StateVariableTypeNode	getToStateNode() Get the ToState StateVariableType Node, or null if it does not exist.
CompletableFuture<? extends StateVariableTypeNode>	getToStateNodeAsync() Asynchronous implementation of TransitionEventType.getToStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getTransition() Get the local value of the Transition Node.
TransitionVariableTypeNode	getTransitionNode() Get the Transition TransitionVariableType Node, or null if it does not exist.
CompletableFuture<? extends TransitionVariableTypeNode>	getTransitionNodeAsync() Asynchronous implementation of TransitionEventType.getTransitionNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readFromState() Read the value of the FromState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readFromStateAsync() An asynchronous implementation of TransitionEventType.readFromState().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readToState() Read the value of the ToState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readToStateAsync() An asynchronous implementation of TransitionEventType.readToState().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readTransition() Read the value of the Transition Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readTransitionAsync() An asynchronous implementation of TransitionEventType.readTransition().
void	setFromState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText fromState) Set the local value of the FromState Node.
void	setToState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText toState) Set the local value of the ToState Node.
void	setTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText transition) Set the local value of the Transition Node.
void	writeFromState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText fromState) Write a new value for the FromState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeFromStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText fromState) An asynchronous implementation of TransitionEventType.writeFromState(LocalizedText).
void	writeToState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText toState) Write a new value for the ToState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeToStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText toState) An asynchronous implementation of TransitionEventType.writeToState(LocalizedText).
void	writeTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText transition) Write a new value for the Transition Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeTransitionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText transition) An asynchronous implementation of TransitionEventType.writeTransition(LocalizedText).

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

TransitionEventTypeNode

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

getTransition

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

Description copied from interface: TransitionEventType

Get the local value of the Transition Node.

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

Specified by:

getTransition in interface TransitionEventType

Returns:

the local value of the Transition Node.

Throws:

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

setTransition

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

Description copied from interface: TransitionEventType

Set the local value of the Transition Node.

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

Specified by:

setTransition in interface TransitionEventType

Parameters:

transition - the local value to set for the Transition Node.

Throws:

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

readTransition

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

Description copied from interface: TransitionEventType

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

Specified by:

readTransition in interface TransitionEventType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeTransition

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

Description copied from interface: TransitionEventType

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

Specified by:

writeTransition in interface TransitionEventType

Parameters:

transition - the LocalizedText value to write to the server.

Throws:

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

readTransitionAsync

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

Description copied from interface: TransitionEventType

An asynchronous implementation of TransitionEventType.readTransition().

Specified by:

readTransitionAsync in interface TransitionEventType

Returns:

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

writeTransitionAsync

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

Description copied from interface: TransitionEventType

An asynchronous implementation of TransitionEventType.writeTransition(LocalizedText).

Specified by:

writeTransitionAsync in interface TransitionEventType

Returns:

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

getTransitionNode

public TransitionVariableTypeNode getTransitionNode()
                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TransitionEventType

Get the Transition TransitionVariableType Node, or null if it does not exist.

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

Specified by:

getTransitionNode in interface TransitionEventType

Returns:

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

getTransitionNodeAsync

public CompletableFuture<? extends TransitionVariableTypeNode> getTransitionNodeAsync()

Description copied from interface: TransitionEventType

Asynchronous implementation of TransitionEventType.getTransitionNode().

Specified by:

getTransitionNodeAsync in interface TransitionEventType

Returns:

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

getFromState

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

Description copied from interface: TransitionEventType

Get the local value of the FromState Node.

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

Specified by:

getFromState in interface TransitionEventType

Returns:

the local value of the FromState Node.

Throws:

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

setFromState

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

Description copied from interface: TransitionEventType

Set the local value of the FromState Node.

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

Specified by:

setFromState in interface TransitionEventType

Parameters:

fromState - the local value to set for the FromState Node.

Throws:

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

readFromState

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

Description copied from interface: TransitionEventType

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

Specified by:

readFromState in interface TransitionEventType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeFromState

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

Description copied from interface: TransitionEventType

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

Specified by:

writeFromState in interface TransitionEventType

Parameters:

fromState - the LocalizedText value to write to the server.

Throws:

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

readFromStateAsync

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

Description copied from interface: TransitionEventType

An asynchronous implementation of TransitionEventType.readFromState().

Specified by:

readFromStateAsync in interface TransitionEventType

Returns:

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

writeFromStateAsync

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

Description copied from interface: TransitionEventType

An asynchronous implementation of TransitionEventType.writeFromState(LocalizedText).

Specified by:

writeFromStateAsync in interface TransitionEventType

Returns:

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

getFromStateNode

public StateVariableTypeNode getFromStateNode()
                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TransitionEventType

Get the FromState StateVariableType Node, or null if it does not exist.

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

Specified by:

getFromStateNode in interface TransitionEventType

Returns:

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

getFromStateNodeAsync

public CompletableFuture<? extends StateVariableTypeNode> getFromStateNodeAsync()

Description copied from interface: TransitionEventType

Asynchronous implementation of TransitionEventType.getFromStateNode().

Specified by:

getFromStateNodeAsync in interface TransitionEventType

Returns:

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

getToState

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

Description copied from interface: TransitionEventType

Get the local value of the ToState Node.

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

Specified by:

getToState in interface TransitionEventType

Returns:

the local value of the ToState Node.

Throws:

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

setToState

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

Description copied from interface: TransitionEventType

Set the local value of the ToState Node.

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

Specified by:

setToState in interface TransitionEventType

Parameters:

toState - the local value to set for the ToState Node.

Throws:

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

readToState

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

Description copied from interface: TransitionEventType

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

Specified by:

readToState in interface TransitionEventType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeToState

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

Description copied from interface: TransitionEventType

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

Specified by:

writeToState in interface TransitionEventType

Parameters:

toState - the LocalizedText value to write to the server.

Throws:

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

readToStateAsync

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

Description copied from interface: TransitionEventType

An asynchronous implementation of TransitionEventType.readToState().

Specified by:

readToStateAsync in interface TransitionEventType

Returns:

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

writeToStateAsync

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

Description copied from interface: TransitionEventType

An asynchronous implementation of TransitionEventType.writeToState(LocalizedText).

Specified by:

writeToStateAsync in interface TransitionEventType

Returns:

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

getToStateNode

public StateVariableTypeNode getToStateNode()
                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TransitionEventType

Get the ToState StateVariableType Node, or null if it does not exist.

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

Specified by:

getToStateNode in interface TransitionEventType

Returns:

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

getToStateNodeAsync

public CompletableFuture<? extends StateVariableTypeNode> getToStateNodeAsync()

Description copied from interface: TransitionEventType

Asynchronous implementation of TransitionEventType.getToStateNode().

Specified by:

getToStateNodeAsync in interface TransitionEventType

Returns:

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