Module org.eclipse.milo.opcua.sdk.client

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

Class ProgressEventTypeNode

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

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

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

All Implemented Interfaces:

BaseEventType, BaseObjectType, ProgressEventType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

public class ProgressEventTypeNode
extends BaseEventTypeNode
implements ProgressEventType

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

CONDITION_CLASS_ID, CONDITION_CLASS_NAME, CONDITION_SUB_CLASS_ID, CONDITION_SUB_CLASS_NAME, EVENT_ID, EVENT_TYPE, LOCAL_TIME, MESSAGE, RECEIVE_TIME, SEVERITY, SOURCE_NAME, SOURCE_NODE, TIME

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.ProgressEventType

CONTEXT, PROGRESS

Constructor Summary

Constructors

Constructor

Description

ProgressEventTypeNode(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.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Method Summary

Modifier and Type	Method	Description
Object	getContext()	Get the local value of the Context Node.
PropertyTypeNode	getContextNode()	Get the Context PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getContextNodeAsync()	Asynchronous implementation of ProgressEventType.getContextNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	getProgress()	Get the local value of the Progress Node.
PropertyTypeNode	getProgressNode()	Get the Progress PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getProgressNodeAsync()	Asynchronous implementation of ProgressEventType.getProgressNode().
Object	readContext()	Read the value of the Context Node from the server and update the local value if the operation succeeds.
CompletableFuture<?>	readContextAsync()	An asynchronous implementation of ProgressEventType.readContext().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	readProgress()	Read the value of the Progress Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort>	readProgressAsync()	An asynchronous implementation of ProgressEventType.readProgress().
void	setContext(Object value)	Set the local value of the Context Node.
void	setProgress(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)	Set the local value of the Progress Node.
void	writeContext(Object value)	Write a new value for the Context Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeContextAsync(Object context)	An asynchronous implementation of ProgressEventType.writeContext(java.lang.Object).
void	writeProgress(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)	Write a new value for the Progress Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeProgressAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort progress)	An asynchronous implementation of ProgressEventType.writeProgress(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.objects.BaseEventTypeNode

getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionSubClassId, getConditionSubClassIdNode, getConditionSubClassIdNodeAsync, getConditionSubClassName, getConditionSubClassNameNode, getConditionSubClassNameNodeAsync, 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, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionSubClassId, readConditionSubClassIdAsync, readConditionSubClassName, readConditionSubClassNameAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setConditionClassId, setConditionClassName, setConditionSubClassId, setConditionSubClassName, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionSubClassId, writeConditionSubClassIdAsync, writeConditionSubClassName, writeConditionSubClassNameAsync, 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, getIconAsync, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersionAsync, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIconAsync, setNamingRuleAsync, setNodeVersionAsync, writeEventNotifier

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, 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.objects.BaseEventType

getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionSubClassId, getConditionSubClassIdNode, getConditionSubClassIdNodeAsync, getConditionSubClassName, getConditionSubClassNameNode, getConditionSubClassNameNodeAsync, 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, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionSubClassId, readConditionSubClassIdAsync, readConditionSubClassName, readConditionSubClassNameAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setConditionClassId, setConditionClassName, setConditionSubClassId, setConditionSubClassName, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionSubClassId, writeConditionSubClassIdAsync, writeConditionSubClassName, writeConditionSubClassNameAsync, 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.Node

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

getEventNotifier, setEventNotifier

Constructor Details

ProgressEventTypeNode

public ProgressEventTypeNode(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.structured.RolePermissionType[] rolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Method Details

getContext

public Object getContext()
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProgressEventType

Get the local value of the Context Node.

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

Specified by:

getContext in interface ProgressEventType

Returns:

the local value of the Context Node.

Throws:

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

setContext

public void setContext(Object value)
                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProgressEventType

Set the local value of the Context Node.

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

Specified by:

setContext in interface ProgressEventType

Parameters:

value - the local value to set for the Context Node.

Throws:

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

readContext

public Object readContext()
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProgressEventType

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

Specified by:

readContext in interface ProgressEventType

Returns:

the Object value read from the server.

Throws:

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

writeContext

public void writeContext(Object value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProgressEventType

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

Specified by:

writeContext in interface ProgressEventType

Parameters:

value - the Object value to write to the server.

Throws:

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

readContextAsync

public CompletableFuture<?> readContextAsync()

Description copied from interface: ProgressEventType

An asynchronous implementation of ProgressEventType.readContext().

Specified by:

readContextAsync in interface ProgressEventType

Returns:

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

writeContextAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeContextAsync(Object context)

Description copied from interface: ProgressEventType

An asynchronous implementation of ProgressEventType.writeContext(java.lang.Object).

Specified by:

writeContextAsync in interface ProgressEventType

Returns:

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

getContextNode

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

Description copied from interface: ProgressEventType

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

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

Specified by:

getContextNode in interface ProgressEventType

Returns:

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

getContextNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getContextNodeAsync()

Description copied from interface: ProgressEventType

Asynchronous implementation of ProgressEventType.getContextNode().

Specified by:

getContextNodeAsync in interface ProgressEventType

Returns:

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

getProgress

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getProgress()
                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProgressEventType

Get the local value of the Progress Node.

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

Specified by:

getProgress in interface ProgressEventType

Returns:

the local value of the Progress Node.

Throws:

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

setProgress

public void setProgress(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProgressEventType

Set the local value of the Progress Node.

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

Specified by:

setProgress in interface ProgressEventType

Parameters:

value - the local value to set for the Progress Node.

Throws:

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

readProgress

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort readProgress()
                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProgressEventType

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

Specified by:

readProgress in interface ProgressEventType

Returns:

the UShort value read from the server.

Throws:

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

writeProgress

public void writeProgress(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProgressEventType

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

Specified by:

writeProgress in interface ProgressEventType

Parameters:

value - the UShort value to write to the server.

Throws:

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

readProgressAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> readProgressAsync()

Description copied from interface: ProgressEventType

An asynchronous implementation of ProgressEventType.readProgress().

Specified by:

readProgressAsync in interface ProgressEventType

Returns:

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

writeProgressAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeProgressAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort progress)

Description copied from interface: ProgressEventType

An asynchronous implementation of ProgressEventType.writeProgress(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).

Specified by:

writeProgressAsync in interface ProgressEventType

Returns:

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

getProgressNode

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

Description copied from interface: ProgressEventType

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

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

Specified by:

getProgressNode in interface ProgressEventType

Returns:

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

getProgressNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getProgressNodeAsync()

Description copied from interface: ProgressEventType

Asynchronous implementation of ProgressEventType.getProgressNode().

Specified by:

getProgressNodeAsync in interface ProgressEventType

Returns:

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