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

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

Class ConditionVariableTypeNode

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

All Implemented Interfaces:

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

public class ConditionVariableTypeNode
extends BaseDataVariableTypeNode
implements ConditionVariableType

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

SOURCE_TIMESTAMP

Constructor Summary

Constructors

Constructor

Description

ConditionVariableTypeNode(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.builtin.DateTime	getSourceTimestamp()	Get the local value of the SourceTimestamp Node.
PropertyTypeNode	getSourceTimestampNode()	Get the SourceTimestamp PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSourceTimestampNodeAsync()	Asynchronous implementation of ConditionVariableType.getSourceTimestampNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	readSourceTimestamp()	Read the value of the SourceTimestamp Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	readSourceTimestampAsync()	An asynchronous implementation of ConditionVariableType.readSourceTimestamp().
void	setSourceTimestamp(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value)	Set the local value of the SourceTimestamp Node.
void	writeSourceTimestamp(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value)	Write a new value for the SourceTimestamp Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSourceTimestampAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime sourceTimestamp)	An asynchronous implementation of ConditionVariableType.writeSourceTimestamp(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime).

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

ConditionVariableTypeNode

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

getSourceTimestamp

public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getSourceTimestamp()
                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ConditionVariableType

Get the local value of the SourceTimestamp Node.

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

Specified by:

getSourceTimestamp in interface ConditionVariableType

Returns:

the local value of the SourceTimestamp Node.

Throws:

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

setSourceTimestamp

public void setSourceTimestamp(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ConditionVariableType

Set the local value of the SourceTimestamp Node.

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

Specified by:

setSourceTimestamp in interface ConditionVariableType

Parameters:

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

Throws:

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

readSourceTimestamp

public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readSourceTimestamp()
                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ConditionVariableType

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

Specified by:

readSourceTimestamp in interface ConditionVariableType

Returns:

the DateTime value read from the server.

Throws:

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

writeSourceTimestamp

public void writeSourceTimestamp(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ConditionVariableType

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

Specified by:

writeSourceTimestamp in interface ConditionVariableType

Parameters:

value - the DateTime value to write to the server.

Throws:

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

readSourceTimestampAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readSourceTimestampAsync()

Description copied from interface: ConditionVariableType

An asynchronous implementation of ConditionVariableType.readSourceTimestamp().

Specified by:

readSourceTimestampAsync in interface ConditionVariableType

Returns:

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

writeSourceTimestampAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSourceTimestampAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime sourceTimestamp)

Description copied from interface: ConditionVariableType

An asynchronous implementation of ConditionVariableType.writeSourceTimestamp(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime).

Specified by:

writeSourceTimestampAsync in interface ConditionVariableType

Returns:

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

getSourceTimestampNode

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

Description copied from interface: ConditionVariableType

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

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

Specified by:

getSourceTimestampNode in interface ConditionVariableType

Returns:

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

getSourceTimestampNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getSourceTimestampNodeAsync()

Description copied from interface: ConditionVariableType

Asynchronous implementation of ConditionVariableType.getSourceTimestampNode().

Specified by:

getSourceTimestampNodeAsync in interface ConditionVariableType

Returns:

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