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

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

Class PubSubDiagnosticsTypeNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

PubSubDiagnosticsConnectionTypeNode, PubSubDiagnosticsDataSetReaderTypeNode, PubSubDiagnosticsDataSetWriterTypeNode, PubSubDiagnosticsReaderGroupTypeNode, PubSubDiagnosticsRootTypeNode, PubSubDiagnosticsWriterGroupTypeNode

public class PubSubDiagnosticsTypeNode
extends BaseObjectTypeNode
implements PubSubDiagnosticsType

Field Summary

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

client

Constructor Summary

Constructors

Constructor

Description

PubSubDiagnosticsTypeNode(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
BaseObjectTypeNode	getCountersNode()	Get the Counters BaseObjectType Node, or null if it does not exist.
CompletableFuture<? extends BaseObjectTypeNode>	getCountersNodeAsync()	Asynchronous implementation of PubSubDiagnosticsType.getCountersNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel	getDiagnosticsLevel()	Get the local value of the DiagnosticsLevel Node.
BaseDataVariableTypeNode	getDiagnosticsLevelNode()	Get the DiagnosticsLevel BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getDiagnosticsLevelNodeAsync()	Asynchronous implementation of PubSubDiagnosticsType.getDiagnosticsLevelNode().
BaseObjectTypeNode	getLiveValuesNode()	Get the LiveValues BaseObjectType Node, or null if it does not exist.
CompletableFuture<? extends BaseObjectTypeNode>	getLiveValuesNodeAsync()	Asynchronous implementation of PubSubDiagnosticsType.getLiveValuesNode().
Boolean	getSubError()	Get the local value of the SubError Node.
BaseDataVariableTypeNode	getSubErrorNode()	Get the SubError BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getSubErrorNodeAsync()	Asynchronous implementation of PubSubDiagnosticsType.getSubErrorNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getTotalError()	Get the local value of the TotalError Node.
PubSubDiagnosticsCounterTypeNode	getTotalErrorNode()	Get the TotalError PubSubDiagnosticsCounterType Node, or null if it does not exist.
CompletableFuture<? extends PubSubDiagnosticsCounterTypeNode>	getTotalErrorNodeAsync()	Asynchronous implementation of PubSubDiagnosticsType.getTotalErrorNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getTotalInformation()	Get the local value of the TotalInformation Node.
PubSubDiagnosticsCounterTypeNode	getTotalInformationNode()	Get the TotalInformation PubSubDiagnosticsCounterType Node, or null if it does not exist.
CompletableFuture<? extends PubSubDiagnosticsCounterTypeNode>	getTotalInformationNodeAsync()	Asynchronous implementation of PubSubDiagnosticsType.getTotalInformationNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel	readDiagnosticsLevel()	Read the value of the DiagnosticsLevel Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel>	readDiagnosticsLevelAsync()	An asynchronous implementation of PubSubDiagnosticsType.readDiagnosticsLevel().
Boolean	readSubError()	Read the value of the SubError Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readSubErrorAsync()	An asynchronous implementation of PubSubDiagnosticsType.readSubError().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readTotalError()	Read the value of the TotalError Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readTotalErrorAsync()	An asynchronous implementation of PubSubDiagnosticsType.readTotalError().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readTotalInformation()	Read the value of the TotalInformation Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readTotalInformationAsync()	An asynchronous implementation of PubSubDiagnosticsType.readTotalInformation().
void	setDiagnosticsLevel(org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel value)	Set the local value of the DiagnosticsLevel Node.
void	setSubError(Boolean value)	Set the local value of the SubError Node.
void	setTotalError(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Set the local value of the TotalError Node.
void	setTotalInformation(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Set the local value of the TotalInformation Node.
void	writeDiagnosticsLevel(org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel value)	Write a new value for the DiagnosticsLevel Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDiagnosticsLevelAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel diagnosticsLevel)	An asynchronous implementation of PubSubDiagnosticsType.writeDiagnosticsLevel(org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel).
void	writeSubError(Boolean value)	Write a new value for the SubError Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSubErrorAsync(Boolean subError)	An asynchronous implementation of PubSubDiagnosticsType.writeSubError(java.lang.Boolean).
void	writeTotalError(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Write a new value for the TotalError Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeTotalErrorAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger totalError)	An asynchronous implementation of PubSubDiagnosticsType.writeTotalError(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).
void	writeTotalInformation(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Write a new value for the TotalInformation Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeTotalInformationAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger totalInformation)	An asynchronous implementation of PubSubDiagnosticsType.writeTotalInformation(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

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

PubSubDiagnosticsTypeNode

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

getDiagnosticsLevel

public org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel getDiagnosticsLevel()
                                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Get the local value of the DiagnosticsLevel Node.

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

Specified by:

getDiagnosticsLevel in interface PubSubDiagnosticsType

Returns:

the local value of the DiagnosticsLevel Node.

Throws:

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

setDiagnosticsLevel

public void setDiagnosticsLevel(org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel value)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Set the local value of the DiagnosticsLevel Node.

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

Specified by:

setDiagnosticsLevel in interface PubSubDiagnosticsType

Parameters:

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

Throws:

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

readDiagnosticsLevel

public org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel readDiagnosticsLevel()
                                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

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

Specified by:

readDiagnosticsLevel in interface PubSubDiagnosticsType

Returns:

the DiagnosticsLevel value read from the server.

Throws:

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

writeDiagnosticsLevel

public void writeDiagnosticsLevel(org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel value)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

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

Specified by:

writeDiagnosticsLevel in interface PubSubDiagnosticsType

Parameters:

value - the DiagnosticsLevel value to write to the server.

Throws:

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

readDiagnosticsLevelAsync

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

Description copied from interface: PubSubDiagnosticsType

An asynchronous implementation of PubSubDiagnosticsType.readDiagnosticsLevel().

Specified by:

readDiagnosticsLevelAsync in interface PubSubDiagnosticsType

Returns:

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

writeDiagnosticsLevelAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDiagnosticsLevelAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel diagnosticsLevel)

Description copied from interface: PubSubDiagnosticsType

An asynchronous implementation of PubSubDiagnosticsType.writeDiagnosticsLevel(org.eclipse.milo.opcua.stack.core.types.enumerated.DiagnosticsLevel).

Specified by:

writeDiagnosticsLevelAsync in interface PubSubDiagnosticsType

Returns:

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

getDiagnosticsLevelNode

public BaseDataVariableTypeNode getDiagnosticsLevelNode()
                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Get the DiagnosticsLevel BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getDiagnosticsLevelNode in interface PubSubDiagnosticsType

Returns:

the DiagnosticsLevel BaseDataVariableType 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.

getDiagnosticsLevelNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getDiagnosticsLevelNodeAsync()

Description copied from interface: PubSubDiagnosticsType

Asynchronous implementation of PubSubDiagnosticsType.getDiagnosticsLevelNode().

Specified by:

getDiagnosticsLevelNodeAsync in interface PubSubDiagnosticsType

Returns:

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

getTotalInformation

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getTotalInformation()
                                                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Get the local value of the TotalInformation Node.

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

Specified by:

getTotalInformation in interface PubSubDiagnosticsType

Returns:

the local value of the TotalInformation Node.

Throws:

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

setTotalInformation

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

Description copied from interface: PubSubDiagnosticsType

Set the local value of the TotalInformation Node.

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

Specified by:

setTotalInformation in interface PubSubDiagnosticsType

Parameters:

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

Throws:

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

readTotalInformation

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readTotalInformation()
                                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

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

Specified by:

readTotalInformation in interface PubSubDiagnosticsType

Returns:

the UInteger value read from the server.

Throws:

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

writeTotalInformation

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

Description copied from interface: PubSubDiagnosticsType

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

Specified by:

writeTotalInformation in interface PubSubDiagnosticsType

Parameters:

value - the UInteger value to write to the server.

Throws:

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

readTotalInformationAsync

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

Description copied from interface: PubSubDiagnosticsType

An asynchronous implementation of PubSubDiagnosticsType.readTotalInformation().

Specified by:

readTotalInformationAsync in interface PubSubDiagnosticsType

Returns:

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

writeTotalInformationAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTotalInformationAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger totalInformation)

Description copied from interface: PubSubDiagnosticsType

An asynchronous implementation of PubSubDiagnosticsType.writeTotalInformation(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

Specified by:

writeTotalInformationAsync in interface PubSubDiagnosticsType

Returns:

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

getTotalInformationNode

public PubSubDiagnosticsCounterTypeNode getTotalInformationNode()
                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Get the TotalInformation PubSubDiagnosticsCounterType Node, or null if it does not exist.

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

Specified by:

getTotalInformationNode in interface PubSubDiagnosticsType

Returns:

the TotalInformation PubSubDiagnosticsCounterType 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.

getTotalInformationNodeAsync

public CompletableFuture<? extends PubSubDiagnosticsCounterTypeNode> getTotalInformationNodeAsync()

Description copied from interface: PubSubDiagnosticsType

Asynchronous implementation of PubSubDiagnosticsType.getTotalInformationNode().

Specified by:

getTotalInformationNodeAsync in interface PubSubDiagnosticsType

Returns:

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

getTotalError

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getTotalError()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Get the local value of the TotalError Node.

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

Specified by:

getTotalError in interface PubSubDiagnosticsType

Returns:

the local value of the TotalError Node.

Throws:

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

setTotalError

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

Description copied from interface: PubSubDiagnosticsType

Set the local value of the TotalError Node.

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

Specified by:

setTotalError in interface PubSubDiagnosticsType

Parameters:

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

Throws:

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

readTotalError

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readTotalError()
                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

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

Specified by:

readTotalError in interface PubSubDiagnosticsType

Returns:

the UInteger value read from the server.

Throws:

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

writeTotalError

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

Description copied from interface: PubSubDiagnosticsType

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

Specified by:

writeTotalError in interface PubSubDiagnosticsType

Parameters:

value - the UInteger value to write to the server.

Throws:

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

readTotalErrorAsync

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

Description copied from interface: PubSubDiagnosticsType

An asynchronous implementation of PubSubDiagnosticsType.readTotalError().

Specified by:

readTotalErrorAsync in interface PubSubDiagnosticsType

Returns:

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

writeTotalErrorAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTotalErrorAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger totalError)

Description copied from interface: PubSubDiagnosticsType

An asynchronous implementation of PubSubDiagnosticsType.writeTotalError(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

Specified by:

writeTotalErrorAsync in interface PubSubDiagnosticsType

Returns:

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

getTotalErrorNode

public PubSubDiagnosticsCounterTypeNode getTotalErrorNode()
                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Get the TotalError PubSubDiagnosticsCounterType Node, or null if it does not exist.

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

Specified by:

getTotalErrorNode in interface PubSubDiagnosticsType

Returns:

the TotalError PubSubDiagnosticsCounterType 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.

getTotalErrorNodeAsync

public CompletableFuture<? extends PubSubDiagnosticsCounterTypeNode> getTotalErrorNodeAsync()

Description copied from interface: PubSubDiagnosticsType

Asynchronous implementation of PubSubDiagnosticsType.getTotalErrorNode().

Specified by:

getTotalErrorNodeAsync in interface PubSubDiagnosticsType

Returns:

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

getSubError

public Boolean getSubError()
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Get the local value of the SubError Node.

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

Specified by:

getSubError in interface PubSubDiagnosticsType

Returns:

the local value of the SubError Node.

Throws:

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

setSubError

public void setSubError(Boolean value)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Set the local value of the SubError Node.

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

Specified by:

setSubError in interface PubSubDiagnosticsType

Parameters:

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

Throws:

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

readSubError

public Boolean readSubError()
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

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

Specified by:

readSubError in interface PubSubDiagnosticsType

Returns:

the Boolean value read from the server.

Throws:

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

writeSubError

public void writeSubError(Boolean value)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

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

Specified by:

writeSubError in interface PubSubDiagnosticsType

Parameters:

value - the Boolean value to write to the server.

Throws:

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

readSubErrorAsync

public CompletableFuture<? extends Boolean> readSubErrorAsync()

Description copied from interface: PubSubDiagnosticsType

An asynchronous implementation of PubSubDiagnosticsType.readSubError().

Specified by:

readSubErrorAsync in interface PubSubDiagnosticsType

Returns:

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

writeSubErrorAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSubErrorAsync(Boolean subError)

Description copied from interface: PubSubDiagnosticsType

An asynchronous implementation of PubSubDiagnosticsType.writeSubError(java.lang.Boolean).

Specified by:

writeSubErrorAsync in interface PubSubDiagnosticsType

Returns:

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

getSubErrorNode

public BaseDataVariableTypeNode getSubErrorNode()
                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Get the SubError BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getSubErrorNode in interface PubSubDiagnosticsType

Returns:

the SubError BaseDataVariableType 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.

getSubErrorNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getSubErrorNodeAsync()

Description copied from interface: PubSubDiagnosticsType

Asynchronous implementation of PubSubDiagnosticsType.getSubErrorNode().

Specified by:

getSubErrorNodeAsync in interface PubSubDiagnosticsType

Returns:

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

getCountersNode

public BaseObjectTypeNode getCountersNode()
                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Get the Counters BaseObjectType Node, or null if it does not exist.

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

Specified by:

getCountersNode in interface PubSubDiagnosticsType

Returns:

the Counters BaseObjectType 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.

getCountersNodeAsync

public CompletableFuture<? extends BaseObjectTypeNode> getCountersNodeAsync()

Description copied from interface: PubSubDiagnosticsType

Asynchronous implementation of PubSubDiagnosticsType.getCountersNode().

Specified by:

getCountersNodeAsync in interface PubSubDiagnosticsType

Returns:

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

getLiveValuesNode

public BaseObjectTypeNode getLiveValuesNode()
                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PubSubDiagnosticsType

Get the LiveValues BaseObjectType Node, or null if it does not exist.

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

Specified by:

getLiveValuesNode in interface PubSubDiagnosticsType

Returns:

the LiveValues BaseObjectType 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.

getLiveValuesNodeAsync

public CompletableFuture<? extends BaseObjectTypeNode> getLiveValuesNodeAsync()

Description copied from interface: PubSubDiagnosticsType

Asynchronous implementation of PubSubDiagnosticsType.getLiveValuesNode().

Specified by:

getLiveValuesNodeAsync in interface PubSubDiagnosticsType

Returns:

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