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

Interface ModellingRuleType

All Superinterfaces:

BaseObjectType, Node, ObjectNode

All Known Implementing Classes:

ModellingRuleTypeNode

public interface ModellingRuleType
extends BaseObjectType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType>	NAMING_RULE

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.
PropertyType	getNamingRuleNode() Get the NamingRule PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getNamingRuleNodeAsync() Asynchronous implementation of 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 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 writeNamingRule(NamingRuleType).

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

Field Detail

NAMING_RULE

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType> NAMING_RULE

Method Detail

getNamingRule

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

Get the local value of the NamingRule Node.

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

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

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

Set the local value of the NamingRule Node.

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

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

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

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

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

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

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

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

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

An asynchronous implementation of readNamingRule().

Returns:

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

writeNamingRuleAsync

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 writeNamingRule(NamingRuleType).

Returns:

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

getNamingRuleNode

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

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

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

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

CompletableFuture<? extends PropertyType> getNamingRuleNodeAsync()

Asynchronous implementation of getNamingRuleNode().

Returns:

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