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

Class ModellingRuleTypeNode

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

org.eclipse.milo.opcua.sdk.client.model.nodes.objects.ModellingRuleTypeNode

All Implemented Interfaces:

BaseObjectType, ModellingRuleType, Node, ObjectNode

public class ModellingRuleTypeNode
extends BaseObjectTypeNode
implements ModellingRuleType

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.types.objects.ModellingRuleType

NAMING_RULE

Constructor Summary

Constructors

Constructor and Description

ModellingRuleTypeNode(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.builtin.unsigned.UByte eventNotifier)

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType	getNamingRule() Get the local value of the NamingRule Node.
PropertyTypeNode	getNamingRuleNode() Get the NamingRule PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getNamingRuleNodeAsync() Asynchronous implementation of ModellingRuleType.getNamingRuleNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType	readNamingRule() Read the value of the NamingRule Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType>	readNamingRuleAsync() An asynchronous implementation of ModellingRuleType.readNamingRule().
void	setNamingRule(org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType namingRule) Set the local value of the NamingRule Node.
void	writeNamingRule(org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType namingRule) Write a new value for the NamingRule Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNamingRuleAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType namingRule) An asynchronous implementation of ModellingRuleType.writeNamingRule(NamingRuleType).

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

callMethod, callMethod, callMethodAsync, callMethodAsync, getAttributeValue, getEventNotifier, getIcon, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersion, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIcon, setNamingRuleAsync, setNodeVersion, writeEventNotifier

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

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

getEventNotifier, setEventNotifier

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

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Constructor Detail

ModellingRuleTypeNode

public ModellingRuleTypeNode(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.builtin.unsigned.UByte eventNotifier)

Method Detail

getNamingRule

public org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType getNamingRule()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ModellingRuleType

Get the local value of the NamingRule Node.

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

Specified by:

getNamingRule in interface ModellingRuleType

Returns:

the local value of the NamingRule Node.

Throws:

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

setNamingRule

public void setNamingRule(org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType namingRule)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ModellingRuleType

Set the local value of the NamingRule Node.

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

Specified by:

setNamingRule in interface ModellingRuleType

Parameters:

namingRule - the local value to set for the NamingRule Node.

Throws:

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

readNamingRule

public org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType readNamingRule()
                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ModellingRuleType

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

Specified by:

readNamingRule in interface ModellingRuleType

Returns:

the NamingRuleType value read from the server.

Throws:

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

writeNamingRule

public void writeNamingRule(org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType namingRule)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ModellingRuleType

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

Specified by:

writeNamingRule in interface ModellingRuleType

Parameters:

namingRule - the NamingRuleType value to write to the server.

Throws:

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

readNamingRuleAsync

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

Description copied from interface: ModellingRuleType

An asynchronous implementation of ModellingRuleType.readNamingRule().

Specified by:

readNamingRuleAsync in interface ModellingRuleType

Returns:

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

writeNamingRuleAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNamingRuleAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType namingRule)

Description copied from interface: ModellingRuleType

An asynchronous implementation of ModellingRuleType.writeNamingRule(NamingRuleType).

Specified by:

writeNamingRuleAsync in interface ModellingRuleType

Returns:

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

getNamingRuleNode

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

Description copied from interface: ModellingRuleType

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

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

Specified by:

getNamingRuleNode in interface ModellingRuleType

Returns:

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

getNamingRuleNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getNamingRuleNodeAsync()

Description copied from interface: ModellingRuleType

Asynchronous implementation of ModellingRuleType.getNamingRuleNode().

Specified by:

getNamingRuleNodeAsync in interface ModellingRuleType

Returns:

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