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

Class SystemStatusChangeEventTypeNode

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

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

All Implemented Interfaces:

BaseEventType, BaseObjectType, SystemEventType, SystemStatusChangeEventType, Node, ObjectNode

public class SystemStatusChangeEventTypeNode
extends SystemEventTypeNode
implements SystemStatusChangeEventType

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

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

Constructor Summary

Constructors

Constructor and Description

SystemStatusChangeEventTypeNode(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.enumerated.ServerState	getSystemState() Get the local value of the SystemState Node.
PropertyTypeNode	getSystemStateNode() Get the SystemState PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSystemStateNodeAsync() Asynchronous implementation of SystemStatusChangeEventType.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 SystemStatusChangeEventType.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 SystemStatusChangeEventType.writeSystemState(ServerState).

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

SystemStatusChangeEventTypeNode

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

getSystemState

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

Description copied from interface: SystemStatusChangeEventType

Get the local value of the SystemState Node.

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

Specified by:

getSystemState in interface SystemStatusChangeEventType

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

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

Description copied from interface: SystemStatusChangeEventType

Set the local value of the SystemState Node.

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

Specified by:

setSystemState in interface SystemStatusChangeEventType

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

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

Description copied from interface: SystemStatusChangeEventType

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

Specified by:

readSystemState in interface SystemStatusChangeEventType

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

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

Description copied from interface: SystemStatusChangeEventType

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

Specified by:

writeSystemState in interface SystemStatusChangeEventType

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

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

Description copied from interface: SystemStatusChangeEventType

An asynchronous implementation of SystemStatusChangeEventType.readSystemState().

Specified by:

readSystemStateAsync in interface SystemStatusChangeEventType

Returns:

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

writeSystemStateAsync

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

Description copied from interface: SystemStatusChangeEventType

An asynchronous implementation of SystemStatusChangeEventType.writeSystemState(ServerState).

Specified by:

writeSystemStateAsync in interface SystemStatusChangeEventType

Returns:

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

getSystemStateNode

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

Description copied from interface: SystemStatusChangeEventType

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

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

Specified by:

getSystemStateNode in interface SystemStatusChangeEventType

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

public CompletableFuture<? extends PropertyTypeNode> getSystemStateNodeAsync()

Description copied from interface: SystemStatusChangeEventType

Asynchronous implementation of SystemStatusChangeEventType.getSystemStateNode().

Specified by:

getSystemStateNodeAsync in interface SystemStatusChangeEventType

Returns:

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