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

Interface TransitionEventType

All Superinterfaces:

BaseEventType, BaseObjectType, Node, ObjectNode

All Known Subinterfaces:

ProgramTransitionEventType

All Known Implementing Classes:

ProgramTransitionEventTypeNode, TransitionEventTypeNode

public interface TransitionEventType
extends BaseEventType

Field Summary

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
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getFromState() Get the local value of the FromState Node.
StateVariableType	getFromStateNode() Get the FromState StateVariableType Node, or null if it does not exist.
CompletableFuture<? extends StateVariableType>	getFromStateNodeAsync() Asynchronous implementation of getFromStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getToState() Get the local value of the ToState Node.
StateVariableType	getToStateNode() Get the ToState StateVariableType Node, or null if it does not exist.
CompletableFuture<? extends StateVariableType>	getToStateNodeAsync() Asynchronous implementation of getToStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getTransition() Get the local value of the Transition Node.
TransitionVariableType	getTransitionNode() Get the Transition TransitionVariableType Node, or null if it does not exist.
CompletableFuture<? extends TransitionVariableType>	getTransitionNodeAsync() Asynchronous implementation of 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 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 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 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 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 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 writeTransition(LocalizedText).

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

Method Detail

getTransition

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

Get the local value of the Transition Node.

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

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

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

Set the local value of the Transition Node.

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

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

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

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

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

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

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

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

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

An asynchronous implementation of readTransition().

Returns:

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

writeTransitionAsync

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 writeTransition(LocalizedText).

Returns:

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

getTransitionNode

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

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

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

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

CompletableFuture<? extends TransitionVariableType> getTransitionNodeAsync()

Asynchronous implementation of getTransitionNode().

Returns:

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

getFromState

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

Get the local value of the FromState Node.

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

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

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

Set the local value of the FromState Node.

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

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

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

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

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

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

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

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

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

An asynchronous implementation of readFromState().

Returns:

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

writeFromStateAsync

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 writeFromState(LocalizedText).

Returns:

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

getFromStateNode

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

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

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

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

CompletableFuture<? extends StateVariableType> getFromStateNodeAsync()

Asynchronous implementation of getFromStateNode().

Returns:

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

getToState

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

Get the local value of the ToState Node.

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

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

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

Set the local value of the ToState Node.

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

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

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

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

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

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

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

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

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

An asynchronous implementation of readToState().

Returns:

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

writeToStateAsync

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 writeToState(LocalizedText).

Returns:

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

getToStateNode

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

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

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

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

CompletableFuture<? extends StateVariableType> getToStateNodeAsync()

Asynchronous implementation of getToStateNode().

Returns:

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