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

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

Class ISrClassTypeNode

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

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

All Implemented Interfaces:

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

public class ISrClassTypeNode
extends BaseInterfaceTypeNode
implements ISrClassType

Field Summary

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

client

Constructor Summary

Constructors

Constructor

Description

ISrClassTypeNode(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
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	getId()	Get the local value of the Id Node.
BaseDataVariableTypeNode	getIdNode()	Get the Id BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getIdNodeAsync()	Asynchronous implementation of ISrClassType.getIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	getPriority()	Get the local value of the Priority Node.
BaseDataVariableTypeNode	getPriorityNode()	Get the Priority BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getPriorityNodeAsync()	Asynchronous implementation of ISrClassType.getPriorityNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	getVid()	Get the local value of the Vid Node.
BaseDataVariableTypeNode	getVidNode()	Get the Vid BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getVidNodeAsync()	Asynchronous implementation of ISrClassType.getVidNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	readId()	Read the value of the Id Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte>	readIdAsync()	An asynchronous implementation of ISrClassType.readId().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	readPriority()	Read the value of the Priority Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte>	readPriorityAsync()	An asynchronous implementation of ISrClassType.readPriority().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	readVid()	Read the value of the Vid 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>	readVidAsync()	An asynchronous implementation of ISrClassType.readVid().
void	setId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte value)	Set the local value of the Id Node.
void	setPriority(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte value)	Set the local value of the Priority Node.
void	setVid(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)	Set the local value of the Vid Node.
void	writeId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte value)	Write a new value for the Id Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte id)	An asynchronous implementation of ISrClassType.writeId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte).
void	writePriority(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte value)	Write a new value for the Priority Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writePriorityAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)	An asynchronous implementation of ISrClassType.writePriority(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte).
void	writeVid(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)	Write a new value for the Vid Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeVidAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort vid)	An asynchronous implementation of ISrClassType.writeVid(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).

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

ISrClassTypeNode

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

getId

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte getId()
                                                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ISrClassType

Get the local value of the Id Node.

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

Specified by:

getId in interface ISrClassType

Returns:

the local value of the Id Node.

Throws:

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

setId

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

Description copied from interface: ISrClassType

Set the local value of the Id Node.

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

Specified by:

setId in interface ISrClassType

Parameters:

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

Throws:

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

readId

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte readId()
                                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ISrClassType

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

Specified by:

readId in interface ISrClassType

Returns:

the UByte value read from the server.

Throws:

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

writeId

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

Description copied from interface: ISrClassType

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

Specified by:

writeId in interface ISrClassType

Parameters:

value - the UByte value to write to the server.

Throws:

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

readIdAsync

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

Description copied from interface: ISrClassType

An asynchronous implementation of ISrClassType.readId().

Specified by:

readIdAsync in interface ISrClassType

Returns:

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

writeIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte id)

Description copied from interface: ISrClassType

An asynchronous implementation of ISrClassType.writeId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte).

Specified by:

writeIdAsync in interface ISrClassType

Returns:

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

getIdNode

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

Description copied from interface: ISrClassType

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

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

Specified by:

getIdNode in interface ISrClassType

Returns:

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

getIdNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getIdNodeAsync()

Description copied from interface: ISrClassType

Asynchronous implementation of ISrClassType.getIdNode().

Specified by:

getIdNodeAsync in interface ISrClassType

Returns:

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

getPriority

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte getPriority()
                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ISrClassType

Get the local value of the Priority Node.

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

Specified by:

getPriority in interface ISrClassType

Returns:

the local value of the Priority Node.

Throws:

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

setPriority

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

Description copied from interface: ISrClassType

Set the local value of the Priority Node.

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

Specified by:

setPriority in interface ISrClassType

Parameters:

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

Throws:

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

readPriority

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte readPriority()
                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ISrClassType

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

Specified by:

readPriority in interface ISrClassType

Returns:

the UByte value read from the server.

Throws:

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

writePriority

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

Description copied from interface: ISrClassType

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

Specified by:

writePriority in interface ISrClassType

Parameters:

value - the UByte value to write to the server.

Throws:

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

readPriorityAsync

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

Description copied from interface: ISrClassType

An asynchronous implementation of ISrClassType.readPriority().

Specified by:

readPriorityAsync in interface ISrClassType

Returns:

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

writePriorityAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePriorityAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)

Description copied from interface: ISrClassType

An asynchronous implementation of ISrClassType.writePriority(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte).

Specified by:

writePriorityAsync in interface ISrClassType

Returns:

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

getPriorityNode

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

Description copied from interface: ISrClassType

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

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

Specified by:

getPriorityNode in interface ISrClassType

Returns:

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

getPriorityNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getPriorityNodeAsync()

Description copied from interface: ISrClassType

Asynchronous implementation of ISrClassType.getPriorityNode().

Specified by:

getPriorityNodeAsync in interface ISrClassType

Returns:

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

getVid

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

Description copied from interface: ISrClassType

Get the local value of the Vid Node.

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

Specified by:

getVid in interface ISrClassType

Returns:

the local value of the Vid Node.

Throws:

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

setVid

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

Description copied from interface: ISrClassType

Set the local value of the Vid Node.

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

Specified by:

setVid in interface ISrClassType

Parameters:

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

Throws:

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

readVid

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

Description copied from interface: ISrClassType

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

Specified by:

readVid in interface ISrClassType

Returns:

the UShort value read from the server.

Throws:

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

writeVid

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

Description copied from interface: ISrClassType

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

Specified by:

writeVid in interface ISrClassType

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.

readVidAsync

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

Description copied from interface: ISrClassType

An asynchronous implementation of ISrClassType.readVid().

Specified by:

readVidAsync in interface ISrClassType

Returns:

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

writeVidAsync

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

Description copied from interface: ISrClassType

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

Specified by:

writeVidAsync in interface ISrClassType

Returns:

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

getVidNode

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

Description copied from interface: ISrClassType

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

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

Specified by:

getVidNode in interface ISrClassType

Returns:

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

getVidNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getVidNodeAsync()

Description copied from interface: ISrClassType

Asynchronous implementation of ISrClassType.getVidNode().

Specified by:

getVidNodeAsync in interface ISrClassType

Returns:

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