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

Interface SystemStatusChangeEventType

All Superinterfaces:

BaseEventType, BaseObjectType, Node, ObjectNode, SystemEventType

All Known Implementing Classes:

SystemStatusChangeEventTypeNode

public interface SystemStatusChangeEventType
extends SystemEventType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState>	SYSTEM_STATE

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.enumerated.ServerState	getSystemState() Get the local value of the SystemState Node.
PropertyType	getSystemStateNode() Get the SystemState PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getSystemStateNodeAsync() Asynchronous implementation of getSystemStateNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState	readSystemState() Read the value of the SystemState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState>	readSystemStateAsync() An asynchronous implementation of readSystemState().
void	setSystemState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState systemState) Set the local value of the SystemState Node.
void	writeSystemState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState systemState) Write a new value for the SystemState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSystemStateAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState systemState) An asynchronous implementation of writeSystemState(ServerState).

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

SYSTEM_STATE

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState> SYSTEM_STATE

Method Detail

getSystemState

org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState getSystemState()
                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SystemState Node.

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

Returns:

the local value of the SystemState Node.

Throws:

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

setSystemState

void setSystemState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState systemState)
             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SystemState Node.

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

Parameters:

systemState - the local value to set for the SystemState Node.

Throws:

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

readSystemState

org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState readSystemState()
                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the ServerState value read from the server.

Throws:

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

writeSystemState

void writeSystemState(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState systemState)
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

systemState - the ServerState value to write to the server.

Throws:

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

readSystemStateAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState> readSystemStateAsync()

An asynchronous implementation of readSystemState().

Returns:

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

writeSystemStateAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSystemStateAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.ServerState systemState)

An asynchronous implementation of writeSystemState(ServerState).

Returns:

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

getSystemStateNode

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

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

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

Returns:

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

getSystemStateNodeAsync

CompletableFuture<? extends PropertyType> getSystemStateNodeAsync()

Asynchronous implementation of getSystemStateNode().

Returns:

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