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

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

Class SessionDiagnosticsArrayTypeNode

java.lang.Object

org.eclipse.milo.opcua.sdk.client.nodes.UaNode

org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

org.eclipse.milo.opcua.sdk.client.model.variables.BaseVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.variables.BaseDataVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.variables.SessionDiagnosticsArrayTypeNode

All Implemented Interfaces:

BaseDataVariableType, BaseVariableType, SessionDiagnosticsArrayType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

public class SessionDiagnosticsArrayTypeNode
extends BaseDataVariableTypeNode
implements SessionDiagnosticsArrayType

Field Summary

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

client

Constructor Summary

Constructors

Constructor

Description

SessionDiagnosticsArrayTypeNode(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.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType	getSessionDiagnostics()	Get the local value of the SessionDiagnostics Node.
SessionDiagnosticsVariableTypeNode	getSessionDiagnosticsNode()	Get the SessionDiagnostics SessionDiagnosticsVariableType Node, or null if it does not exist.
CompletableFuture<? extends SessionDiagnosticsVariableTypeNode>	getSessionDiagnosticsNodeAsync()	Asynchronous implementation of SessionDiagnosticsArrayType.getSessionDiagnosticsNode().
org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType	readSessionDiagnostics()	Read the value of the SessionDiagnostics Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType>	readSessionDiagnosticsAsync()	An asynchronous implementation of SessionDiagnosticsArrayType.readSessionDiagnostics().
void	setSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType value)	Set the local value of the SessionDiagnostics Node.
void	writeSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType value)	Write a new value for the SessionDiagnostics Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSessionDiagnosticsAsync(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType sessionDiagnostics)	An asynchronous implementation of SessionDiagnosticsArrayType.writeSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType).

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

getAccessLevel, getAccessLevelEx, getArrayDimensions, getAttributeValue, getDataType, getHistorizing, getMinimumSamplingInterval, getTypeDefinition, getTypeDefinitionAsync, getUserAccessLevel, getValue, getValueRank, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readAccessLevel, readAccessLevelEx, readAllowNullsAsync, readArrayDimensions, readDataType, readDataTypeVersionAsync, readDictionaryFragmentAsync, readEngineeringUnitsAsync, readHistorizing, readLocalTimeAsync, readMaxArrayLengthAsync, readMaxStringLengthAsync, readMinimumSamplingInterval, readNodeVersionAsync, readUserAccessLevel, readValue, readValueAsTextAsync, readValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setAttributeValue, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValue, setValueRank, writeAccessLevel, writeAccessLevelEx, writeAllowNullsAsync, writeArrayDimensions, writeDataType, writeDataTypeVersionAsync, writeDictionaryFragmentAsync, writeEngineeringUnitsAsync, writeHistorizing, writeLocalTimeAsync, writeMaxArrayLengthAsync, writeMaxStringLengthAsync, writeMinimumSamplingInterval, writeNodeVersionAsync, writeUserAccessLevel, writeValue, writeValue, writeValueAsTextAsync, writeValueRank

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

getAccessLevel, getAccessLevelEx, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

Constructor Details

SessionDiagnosticsArrayTypeNode

public SessionDiagnosticsArrayTypeNode(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.DataValue value,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType,
 Integer valueRank,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel,
 Double minimumSamplingInterval,
 Boolean historizing,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Details

getSessionDiagnostics

public org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType getSessionDiagnostics()
                                                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SessionDiagnosticsArrayType

Get the local value of the SessionDiagnostics Node.

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

Specified by:

getSessionDiagnostics in interface SessionDiagnosticsArrayType

Returns:

the local value of the SessionDiagnostics Node.

Throws:

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

setSessionDiagnostics

public void setSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType value)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SessionDiagnosticsArrayType

Set the local value of the SessionDiagnostics Node.

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

Specified by:

setSessionDiagnostics in interface SessionDiagnosticsArrayType

Parameters:

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

Throws:

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

readSessionDiagnostics

public org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType readSessionDiagnostics()
                                                                                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SessionDiagnosticsArrayType

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

Specified by:

readSessionDiagnostics in interface SessionDiagnosticsArrayType

Returns:

the SessionDiagnosticsDataType value read from the server.

Throws:

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

writeSessionDiagnostics

public void writeSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType value)
                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SessionDiagnosticsArrayType

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

Specified by:

writeSessionDiagnostics in interface SessionDiagnosticsArrayType

Parameters:

value - the SessionDiagnosticsDataType value to write to the server.

Throws:

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

readSessionDiagnosticsAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType> readSessionDiagnosticsAsync()

Description copied from interface: SessionDiagnosticsArrayType

An asynchronous implementation of SessionDiagnosticsArrayType.readSessionDiagnostics().

Specified by:

readSessionDiagnosticsAsync in interface SessionDiagnosticsArrayType

Returns:

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

writeSessionDiagnosticsAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSessionDiagnosticsAsync(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType sessionDiagnostics)

Description copied from interface: SessionDiagnosticsArrayType

An asynchronous implementation of SessionDiagnosticsArrayType.writeSessionDiagnostics(org.eclipse.milo.opcua.stack.core.types.structured.SessionDiagnosticsDataType).

Specified by:

writeSessionDiagnosticsAsync in interface SessionDiagnosticsArrayType

Returns:

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

getSessionDiagnosticsNode

public SessionDiagnosticsVariableTypeNode getSessionDiagnosticsNode()
                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SessionDiagnosticsArrayType

Get the SessionDiagnostics SessionDiagnosticsVariableType Node, or null if it does not exist.

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

Specified by:

getSessionDiagnosticsNode in interface SessionDiagnosticsArrayType

Returns:

the SessionDiagnostics SessionDiagnosticsVariableType 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.

getSessionDiagnosticsNodeAsync

public CompletableFuture<? extends SessionDiagnosticsVariableTypeNode> getSessionDiagnosticsNodeAsync()

Description copied from interface: SessionDiagnosticsArrayType

Asynchronous implementation of SessionDiagnosticsArrayType.getSessionDiagnosticsNode().

Specified by:

getSessionDiagnosticsNodeAsync in interface SessionDiagnosticsArrayType

Returns:

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