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

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

Class ExpressionGuardVariableTypeNode

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

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

All Implemented Interfaces:

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

public class ExpressionGuardVariableTypeNode
extends GuardVariableTypeNode
implements ExpressionGuardVariableType

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

EXPRESSION

Constructor Summary

Constructors

Constructor

Description

ExpressionGuardVariableTypeNode(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.ContentFilter	getExpression()	Get the local value of the Expression Node.
PropertyTypeNode	getExpressionNode()	Get the Expression PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getExpressionNodeAsync()	Asynchronous implementation of ExpressionGuardVariableType.getExpressionNode().
org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter	readExpression()	Read the value of the Expression Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter>	readExpressionAsync()	An asynchronous implementation of ExpressionGuardVariableType.readExpression().
void	setExpression(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter value)	Set the local value of the Expression Node.
void	writeExpression(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter value)	Write a new value for the Expression Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeExpressionAsync(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter expression)	An asynchronous implementation of ExpressionGuardVariableType.writeExpression(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter).

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

ExpressionGuardVariableTypeNode

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

getExpression

public org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter getExpression()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ExpressionGuardVariableType

Get the local value of the Expression Node.

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

Specified by:

getExpression in interface ExpressionGuardVariableType

Returns:

the local value of the Expression Node.

Throws:

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

setExpression

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

Description copied from interface: ExpressionGuardVariableType

Set the local value of the Expression Node.

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

Specified by:

setExpression in interface ExpressionGuardVariableType

Parameters:

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

Throws:

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

readExpression

public org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter readExpression()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ExpressionGuardVariableType

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

Specified by:

readExpression in interface ExpressionGuardVariableType

Returns:

the ContentFilter value read from the server.

Throws:

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

writeExpression

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

Description copied from interface: ExpressionGuardVariableType

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

Specified by:

writeExpression in interface ExpressionGuardVariableType

Parameters:

value - the ContentFilter value to write to the server.

Throws:

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

readExpressionAsync

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

Description copied from interface: ExpressionGuardVariableType

An asynchronous implementation of ExpressionGuardVariableType.readExpression().

Specified by:

readExpressionAsync in interface ExpressionGuardVariableType

Returns:

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

writeExpressionAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeExpressionAsync(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter expression)

Description copied from interface: ExpressionGuardVariableType

An asynchronous implementation of ExpressionGuardVariableType.writeExpression(org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter).

Specified by:

writeExpressionAsync in interface ExpressionGuardVariableType

Returns:

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

getExpressionNode

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

Description copied from interface: ExpressionGuardVariableType

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

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

Specified by:

getExpressionNode in interface ExpressionGuardVariableType

Returns:

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

getExpressionNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getExpressionNodeAsync()

Description copied from interface: ExpressionGuardVariableType

Asynchronous implementation of ExpressionGuardVariableType.getExpressionNode().

Specified by:

getExpressionNodeAsync in interface ExpressionGuardVariableType

Returns:

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