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

Class GeneralModelChangeEventTypeNode

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

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

All Implemented Interfaces:

BaseEventType, BaseModelChangeEventType, BaseObjectType, GeneralModelChangeEventType, Node, ObjectNode

public class GeneralModelChangeEventTypeNode
extends BaseModelChangeEventTypeNode
implements GeneralModelChangeEventType

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

CHANGES

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

GeneralModelChangeEventTypeNode(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.structured.ModelChangeStructureDataType[]	getChanges() Get the local value of the Changes Node.
PropertyTypeNode	getChangesNode() Get the Changes PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getChangesNodeAsync() Asynchronous implementation of GeneralModelChangeEventType.getChangesNode().
org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[]	readChanges() Read the value of the Changes Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[]>	readChangesAsync() An asynchronous implementation of GeneralModelChangeEventType.readChanges().
void	setChanges(org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[] changes) Set the local value of the Changes Node.
void	writeChanges(org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[] changes) Write a new value for the Changes Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeChangesAsync(org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[] changes) An asynchronous implementation of GeneralModelChangeEventType.writeChanges(ModelChangeStructureDataType[]).

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

GeneralModelChangeEventTypeNode

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

getChanges

public org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[] getChanges()
                                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: GeneralModelChangeEventType

Get the local value of the Changes Node.

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

Specified by:

getChanges in interface GeneralModelChangeEventType

Returns:

the local value of the Changes Node.

Throws:

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

setChanges

public void setChanges(org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[] changes)
                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: GeneralModelChangeEventType

Set the local value of the Changes Node.

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

Specified by:

setChanges in interface GeneralModelChangeEventType

Parameters:

changes - the local value to set for the Changes Node.

Throws:

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

readChanges

public org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[] readChanges()
                                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: GeneralModelChangeEventType

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

Specified by:

readChanges in interface GeneralModelChangeEventType

Returns:

the ModelChangeStructureDataType[] value read from the server.

Throws:

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

writeChanges

public void writeChanges(org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[] changes)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: GeneralModelChangeEventType

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

Specified by:

writeChanges in interface GeneralModelChangeEventType

Parameters:

changes - the ModelChangeStructureDataType[] value to write to the server.

Throws:

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

readChangesAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[]> readChangesAsync()

Description copied from interface: GeneralModelChangeEventType

An asynchronous implementation of GeneralModelChangeEventType.readChanges().

Specified by:

readChangesAsync in interface GeneralModelChangeEventType

Returns:

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

writeChangesAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeChangesAsync(org.eclipse.milo.opcua.stack.core.types.structured.ModelChangeStructureDataType[] changes)

Description copied from interface: GeneralModelChangeEventType

An asynchronous implementation of GeneralModelChangeEventType.writeChanges(ModelChangeStructureDataType[]).

Specified by:

writeChangesAsync in interface GeneralModelChangeEventType

Returns:

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

getChangesNode

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

Description copied from interface: GeneralModelChangeEventType

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

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

Specified by:

getChangesNode in interface GeneralModelChangeEventType

Returns:

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

getChangesNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getChangesNodeAsync()

Description copied from interface: GeneralModelChangeEventType

Asynchronous implementation of GeneralModelChangeEventType.getChangesNode().

Specified by:

getChangesNodeAsync in interface GeneralModelChangeEventType

Returns:

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