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

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

Interface ProgressEventType

All Superinterfaces:

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

All Known Implementing Classes:

ProgressEventTypeNode

public interface ProgressEventType
extends BaseEventType

See Also:

• https://reference.opcfoundation.org/v105/Core/docs/Part5/6.4.35

Field Summary

Fields

Modifier and Type	Field	Description
static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Object>	CONTEXT
static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort>	PROGRESS

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

Method Summary

Modifier and Type	Method	Description
Object	getContext()	Get the local value of the Context Node.
PropertyType	getContextNode()	Get the Context PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getContextNodeAsync()	Asynchronous implementation of getContextNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	getProgress()	Get the local value of the Progress Node.
PropertyType	getProgressNode()	Get the Progress PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getProgressNodeAsync()	Asynchronous implementation of 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 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 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 value)	An asynchronous implementation of 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 value)	An asynchronous implementation of writeProgress(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).

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

Field Details

CONTEXT

static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Object> CONTEXT

PROGRESS

static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> PROGRESS

Method Details

getContext

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

Get the local value of the Context Node.

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

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

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

Set the local value of the Context Node.

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

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

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

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

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

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

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

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

CompletableFuture<?> readContextAsync()

An asynchronous implementation of readContext().

Returns:

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

writeContextAsync

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

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

Returns:

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

getContextNode

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

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

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

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

CompletableFuture<? extends PropertyType> getContextNodeAsync()

Asynchronous implementation of getContextNode().

Returns:

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

getProgress

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

Get the local value of the Progress Node.

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

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

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

Set the local value of the Progress Node.

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

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

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

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

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

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

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

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

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

An asynchronous implementation of readProgress().

Returns:

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

writeProgressAsync

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

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

Returns:

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

getProgressNode

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

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

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

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

CompletableFuture<? extends PropertyType> getProgressNodeAsync()

Asynchronous implementation of getProgressNode().

Returns:

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