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

Class AlarmConditionTypeNode

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

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

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

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

All Implemented Interfaces:

AcknowledgeableConditionType, AlarmConditionType, BaseEventType, BaseObjectType, ConditionType, Node, ObjectNode

Direct Known Subclasses:

DiscreteAlarmTypeNode, LimitAlarmTypeNode

public class AlarmConditionTypeNode
extends AcknowledgeableConditionTypeNode
implements AlarmConditionType

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

INPUT_NODE, MAX_TIME_SHELVED, SUPPRESSED_OR_SHELVED

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.ConditionType

BRANCH_ID, CLIENT_USER_ID, CONDITION_CLASS_ID, CONDITION_CLASS_NAME, CONDITION_NAME, RETAIN

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.BaseEventType

EVENT_ID, EVENT_TYPE, LOCAL_TIME, MESSAGE, RECEIVE_TIME, SEVERITY, SOURCE_NAME, SOURCE_NODE, TIME

Constructor Summary

Constructors

Constructor and Description

AlarmConditionTypeNode(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.builtin.LocalizedText	getActiveState() Get the local value of the ActiveState Node.
TwoStateVariableTypeNode	getActiveStateNode() Get the ActiveState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableTypeNode>	getActiveStateNodeAsync() Asynchronous implementation of AlarmConditionType.getActiveStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getEnabledState() Get the local value of the EnabledState Node.
TwoStateVariableTypeNode	getEnabledStateNode() Get the EnabledState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableTypeNode>	getEnabledStateNodeAsync() Asynchronous implementation of ConditionType.getEnabledStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getInputNode() Get the local value of the InputNode Node.
PropertyTypeNode	getInputNodeNode() Get the InputNode PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getInputNodeNodeAsync() Asynchronous implementation of AlarmConditionType.getInputNodeNode().
Double	getMaxTimeShelved() Get the local value of the MaxTimeShelved Node.
PropertyTypeNode	getMaxTimeShelvedNode() Get the MaxTimeShelved PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getMaxTimeShelvedNodeAsync() Asynchronous implementation of AlarmConditionType.getMaxTimeShelvedNode().
ShelvedStateMachineTypeNode	getShelvingStateNode() Get the ShelvingState ShelvedStateMachineType Node, or null if it does not exist.
CompletableFuture<? extends ShelvedStateMachineTypeNode>	getShelvingStateNodeAsync() Asynchronous implementation of AlarmConditionType.getShelvingStateNode().
Boolean	getSuppressedOrShelved() Get the local value of the SuppressedOrShelved Node.
PropertyTypeNode	getSuppressedOrShelvedNode() Get the SuppressedOrShelved PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSuppressedOrShelvedNodeAsync() Asynchronous implementation of AlarmConditionType.getSuppressedOrShelvedNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getSuppressedState() Get the local value of the SuppressedState Node.
TwoStateVariableTypeNode	getSuppressedStateNode() Get the SuppressedState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableTypeNode>	getSuppressedStateNodeAsync() Asynchronous implementation of AlarmConditionType.getSuppressedStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readActiveState() Read the value of the ActiveState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readActiveStateAsync() An asynchronous implementation of AlarmConditionType.readActiveState().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readEnabledState() Read the value of the EnabledState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readEnabledStateAsync() An asynchronous implementation of ConditionType.readEnabledState().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readInputNode() Read the value of the InputNode Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readInputNodeAsync() An asynchronous implementation of AlarmConditionType.readInputNode().
Double	readMaxTimeShelved() Read the value of the MaxTimeShelved Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readMaxTimeShelvedAsync() An asynchronous implementation of AlarmConditionType.readMaxTimeShelved().
Boolean	readSuppressedOrShelved() Read the value of the SuppressedOrShelved Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readSuppressedOrShelvedAsync() An asynchronous implementation of AlarmConditionType.readSuppressedOrShelved().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readSuppressedState() Read the value of the SuppressedState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readSuppressedStateAsync() An asynchronous implementation of AlarmConditionType.readSuppressedState().
void	setActiveState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText activeState) Set the local value of the ActiveState Node.
void	setEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState) Set the local value of the EnabledState Node.
void	setInputNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode) Set the local value of the InputNode Node.
void	setMaxTimeShelved(Double maxTimeShelved) Set the local value of the MaxTimeShelved Node.
void	setSuppressedOrShelved(Boolean suppressedOrShelved) Set the local value of the SuppressedOrShelved Node.
void	setSuppressedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState) Set the local value of the SuppressedState Node.
void	writeActiveState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText activeState) Write a new value for the ActiveState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeActiveStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText activeState) An asynchronous implementation of AlarmConditionType.writeActiveState(LocalizedText).
void	writeEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState) Write a new value for the EnabledState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEnabledStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState) An asynchronous implementation of ConditionType.writeEnabledState(LocalizedText).
void	writeInputNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode) Write a new value for the InputNode Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeInputNodeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode) An asynchronous implementation of AlarmConditionType.writeInputNode(NodeId).
void	writeMaxTimeShelved(Double maxTimeShelved) Write a new value for the MaxTimeShelved Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMaxTimeShelvedAsync(Double maxTimeShelved) An asynchronous implementation of AlarmConditionType.writeMaxTimeShelved(Double).
void	writeSuppressedOrShelved(Boolean suppressedOrShelved) Write a new value for the SuppressedOrShelved Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSuppressedOrShelvedAsync(Boolean suppressedOrShelved) An asynchronous implementation of AlarmConditionType.writeSuppressedOrShelved(Boolean).
void	writeSuppressedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState) Write a new value for the SuppressedState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSuppressedStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState) An asynchronous implementation of AlarmConditionType.writeSuppressedState(LocalizedText).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.nodes.objects.AcknowledgeableConditionTypeNode

getAckedState, getAckedStateNode, getAckedStateNodeAsync, getConfirmedState, getConfirmedStateNode, getConfirmedStateNodeAsync, readAckedState, readAckedStateAsync, readConfirmedState, readConfirmedStateAsync, setAckedState, setConfirmedState, writeAckedState, writeAckedStateAsync, writeConfirmedState, writeConfirmedStateAsync

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.nodes.objects.ConditionTypeNode

getBranchId, getBranchIdNode, getBranchIdNodeAsync, getClientUserId, getClientUserIdNode, getClientUserIdNodeAsync, getComment, getCommentNode, getCommentNodeAsync, getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionName, getConditionNameNode, getConditionNameNodeAsync, getLastSeverity, getLastSeverityNode, getLastSeverityNodeAsync, getQuality, getQualityNode, getQualityNodeAsync, getRetain, getRetainNode, getRetainNodeAsync, readBranchId, readBranchIdAsync, readClientUserId, readClientUserIdAsync, readComment, readCommentAsync, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionName, readConditionNameAsync, readLastSeverity, readLastSeverityAsync, readQuality, readQualityAsync, readRetain, readRetainAsync, setBranchId, setClientUserId, setComment, setConditionClassId, setConditionClassName, setConditionName, setLastSeverity, setQuality, setRetain, writeBranchId, writeBranchIdAsync, writeClientUserId, writeClientUserIdAsync, writeComment, writeCommentAsync, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionName, writeConditionNameAsync, writeLastSeverity, writeLastSeverityAsync, writeQuality, writeQualityAsync, writeRetain, writeRetainAsync

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.nodes.objects.BaseEventTypeNode

getEventId, getEventIdNode, getEventIdNodeAsync, getEventType, getEventTypeNode, getEventTypeNodeAsync, getLocalTime, getLocalTimeNode, getLocalTimeNodeAsync, getMessage, getMessageNode, getMessageNodeAsync, getReceiveTime, getReceiveTimeNode, getReceiveTimeNodeAsync, getSeverity, getSeverityNode, getSeverityNodeAsync, getSourceName, getSourceNameNode, getSourceNameNodeAsync, getSourceNode, getSourceNodeNode, getSourceNodeNodeAsync, getTime, getTimeNode, getTimeNodeAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeEventId, writeEventIdAsync, writeEventType, writeEventTypeAsync, writeLocalTime, writeLocalTimeAsync, writeMessage, writeMessageAsync, writeReceiveTime, writeReceiveTimeAsync, writeSeverity, writeSeverityAsync, writeSourceName, writeSourceNameAsync, writeSourceNode, writeSourceNodeAsync, writeTime, writeTimeAsync

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.client.model.types.objects.AcknowledgeableConditionType

getAckedState, getAckedStateNode, getAckedStateNodeAsync, getConfirmedState, getConfirmedStateNode, getConfirmedStateNodeAsync, readAckedState, readAckedStateAsync, readConfirmedState, readConfirmedStateAsync, setAckedState, setConfirmedState, writeAckedState, writeAckedStateAsync, writeConfirmedState, writeConfirmedStateAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.ConditionType

getBranchId, getBranchIdNode, getBranchIdNodeAsync, getClientUserId, getClientUserIdNode, getClientUserIdNodeAsync, getComment, getCommentNode, getCommentNodeAsync, getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionName, getConditionNameNode, getConditionNameNodeAsync, getLastSeverity, getLastSeverityNode, getLastSeverityNodeAsync, getQuality, getQualityNode, getQualityNodeAsync, getRetain, getRetainNode, getRetainNodeAsync, readBranchId, readBranchIdAsync, readClientUserId, readClientUserIdAsync, readComment, readCommentAsync, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionName, readConditionNameAsync, readLastSeverity, readLastSeverityAsync, readQuality, readQualityAsync, readRetain, readRetainAsync, setBranchId, setClientUserId, setComment, setConditionClassId, setConditionClassName, setConditionName, setLastSeverity, setQuality, setRetain, writeBranchId, writeBranchIdAsync, writeClientUserId, writeClientUserIdAsync, writeComment, writeCommentAsync, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionName, writeConditionNameAsync, writeLastSeverity, writeLastSeverityAsync, writeQuality, writeQualityAsync, writeRetain, writeRetainAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.BaseEventType

getEventId, getEventIdNode, getEventIdNodeAsync, getEventType, getEventTypeNode, getEventTypeNodeAsync, getLocalTime, getLocalTimeNode, getLocalTimeNodeAsync, getMessage, getMessageNode, getMessageNodeAsync, getReceiveTime, getReceiveTimeNode, getReceiveTimeNodeAsync, getSeverity, getSeverityNode, getSeverityNodeAsync, getSourceName, getSourceNameNode, getSourceNameNodeAsync, getSourceNode, getSourceNodeNode, getSourceNodeNodeAsync, getTime, getTimeNode, getTimeNodeAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeEventId, writeEventIdAsync, writeEventType, writeEventTypeAsync, writeLocalTime, writeLocalTimeAsync, writeMessage, writeMessageAsync, writeReceiveTime, writeReceiveTimeAsync, writeSeverity, writeSeverityAsync, writeSourceName, writeSourceNameAsync, writeSourceNode, writeSourceNodeAsync, writeTime, writeTimeAsync

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

AlarmConditionTypeNode

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

getInputNode

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getInputNode()
                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Get the local value of the InputNode Node.

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

Specified by:

getInputNode in interface AlarmConditionType

Returns:

the local value of the InputNode Node.

Throws:

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

setInputNode

public void setInputNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Set the local value of the InputNode Node.

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

Specified by:

setInputNode in interface AlarmConditionType

Parameters:

inputNode - the local value to set for the InputNode Node.

Throws:

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

readInputNode

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readInputNode()
                                                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

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

Specified by:

readInputNode in interface AlarmConditionType

Returns:

the NodeId value read from the server.

Throws:

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

writeInputNode

public void writeInputNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

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

Specified by:

writeInputNode in interface AlarmConditionType

Parameters:

inputNode - the NodeId value to write to the server.

Throws:

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

readInputNodeAsync

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

Description copied from interface: AlarmConditionType

An asynchronous implementation of AlarmConditionType.readInputNode().

Specified by:

readInputNodeAsync in interface AlarmConditionType

Returns:

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

writeInputNodeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeInputNodeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode)

Description copied from interface: AlarmConditionType

An asynchronous implementation of AlarmConditionType.writeInputNode(NodeId).

Specified by:

writeInputNodeAsync in interface AlarmConditionType

Returns:

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

getInputNodeNode

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

Description copied from interface: AlarmConditionType

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

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

Specified by:

getInputNodeNode in interface AlarmConditionType

Returns:

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

getInputNodeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getInputNodeNodeAsync()

Description copied from interface: AlarmConditionType

Asynchronous implementation of AlarmConditionType.getInputNodeNode().

Specified by:

getInputNodeNodeAsync in interface AlarmConditionType

Returns:

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

getSuppressedOrShelved

public Boolean getSuppressedOrShelved()
                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Get the local value of the SuppressedOrShelved Node.

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

Specified by:

getSuppressedOrShelved in interface AlarmConditionType

Returns:

the local value of the SuppressedOrShelved Node.

Throws:

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

setSuppressedOrShelved

public void setSuppressedOrShelved(Boolean suppressedOrShelved)
                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Set the local value of the SuppressedOrShelved Node.

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

Specified by:

setSuppressedOrShelved in interface AlarmConditionType

Parameters:

suppressedOrShelved - the local value to set for the SuppressedOrShelved Node.

Throws:

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

readSuppressedOrShelved

public Boolean readSuppressedOrShelved()
                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

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

Specified by:

readSuppressedOrShelved in interface AlarmConditionType

Returns:

the Boolean value read from the server.

Throws:

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

writeSuppressedOrShelved

public void writeSuppressedOrShelved(Boolean suppressedOrShelved)
                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

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

Specified by:

writeSuppressedOrShelved in interface AlarmConditionType

Parameters:

suppressedOrShelved - the Boolean value to write to the server.

Throws:

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

readSuppressedOrShelvedAsync

public CompletableFuture<? extends Boolean> readSuppressedOrShelvedAsync()

Description copied from interface: AlarmConditionType

An asynchronous implementation of AlarmConditionType.readSuppressedOrShelved().

Specified by:

readSuppressedOrShelvedAsync in interface AlarmConditionType

Returns:

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

writeSuppressedOrShelvedAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSuppressedOrShelvedAsync(Boolean suppressedOrShelved)

Description copied from interface: AlarmConditionType

An asynchronous implementation of AlarmConditionType.writeSuppressedOrShelved(Boolean).

Specified by:

writeSuppressedOrShelvedAsync in interface AlarmConditionType

Returns:

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

getSuppressedOrShelvedNode

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

Description copied from interface: AlarmConditionType

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

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

Specified by:

getSuppressedOrShelvedNode in interface AlarmConditionType

Returns:

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

getSuppressedOrShelvedNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getSuppressedOrShelvedNodeAsync()

Description copied from interface: AlarmConditionType

Asynchronous implementation of AlarmConditionType.getSuppressedOrShelvedNode().

Specified by:

getSuppressedOrShelvedNodeAsync in interface AlarmConditionType

Returns:

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

getMaxTimeShelved

public Double getMaxTimeShelved()
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Get the local value of the MaxTimeShelved Node.

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

Specified by:

getMaxTimeShelved in interface AlarmConditionType

Returns:

the local value of the MaxTimeShelved Node.

Throws:

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

setMaxTimeShelved

public void setMaxTimeShelved(Double maxTimeShelved)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Set the local value of the MaxTimeShelved Node.

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

Specified by:

setMaxTimeShelved in interface AlarmConditionType

Parameters:

maxTimeShelved - the local value to set for the MaxTimeShelved Node.

Throws:

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

readMaxTimeShelved

public Double readMaxTimeShelved()
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

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

Specified by:

readMaxTimeShelved in interface AlarmConditionType

Returns:

the Double value read from the server.

Throws:

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

writeMaxTimeShelved

public void writeMaxTimeShelved(Double maxTimeShelved)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

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

Specified by:

writeMaxTimeShelved in interface AlarmConditionType

Parameters:

maxTimeShelved - the Double value to write to the server.

Throws:

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

readMaxTimeShelvedAsync

public CompletableFuture<? extends Double> readMaxTimeShelvedAsync()

Description copied from interface: AlarmConditionType

An asynchronous implementation of AlarmConditionType.readMaxTimeShelved().

Specified by:

readMaxTimeShelvedAsync in interface AlarmConditionType

Returns:

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

writeMaxTimeShelvedAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMaxTimeShelvedAsync(Double maxTimeShelved)

Description copied from interface: AlarmConditionType

An asynchronous implementation of AlarmConditionType.writeMaxTimeShelved(Double).

Specified by:

writeMaxTimeShelvedAsync in interface AlarmConditionType

Returns:

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

getMaxTimeShelvedNode

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

Description copied from interface: AlarmConditionType

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

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

Specified by:

getMaxTimeShelvedNode in interface AlarmConditionType

Returns:

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

getMaxTimeShelvedNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getMaxTimeShelvedNodeAsync()

Description copied from interface: AlarmConditionType

Asynchronous implementation of AlarmConditionType.getMaxTimeShelvedNode().

Specified by:

getMaxTimeShelvedNodeAsync in interface AlarmConditionType

Returns:

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

getEnabledState

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getEnabledState()
                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ConditionType

Get the local value of the EnabledState Node.

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

Specified by:

getEnabledState in interface AcknowledgeableConditionType

Specified by:

getEnabledState in interface AlarmConditionType

Specified by:

getEnabledState in interface ConditionType

Overrides:

getEnabledState in class AcknowledgeableConditionTypeNode

Returns:

the local value of the EnabledState Node.

Throws:

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

setEnabledState

public void setEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ConditionType

Set the local value of the EnabledState Node.

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

Specified by:

setEnabledState in interface AcknowledgeableConditionType

Specified by:

setEnabledState in interface AlarmConditionType

Specified by:

setEnabledState in interface ConditionType

Overrides:

setEnabledState in class AcknowledgeableConditionTypeNode

Parameters:

enabledState - the local value to set for the EnabledState Node.

Throws:

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

readEnabledState

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readEnabledState()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ConditionType

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

Specified by:

readEnabledState in interface AcknowledgeableConditionType

Specified by:

readEnabledState in interface AlarmConditionType

Specified by:

readEnabledState in interface ConditionType

Overrides:

readEnabledState in class AcknowledgeableConditionTypeNode

Returns:

the LocalizedText value read from the server.

Throws:

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

writeEnabledState

public void writeEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ConditionType

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

Specified by:

writeEnabledState in interface AcknowledgeableConditionType

Specified by:

writeEnabledState in interface AlarmConditionType

Specified by:

writeEnabledState in interface ConditionType

Overrides:

writeEnabledState in class AcknowledgeableConditionTypeNode

Parameters:

enabledState - the LocalizedText value to write to the server.

Throws:

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

readEnabledStateAsync

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

Description copied from interface: ConditionType

An asynchronous implementation of ConditionType.readEnabledState().

Specified by:

readEnabledStateAsync in interface AcknowledgeableConditionType

Specified by:

readEnabledStateAsync in interface AlarmConditionType

Specified by:

readEnabledStateAsync in interface ConditionType

Overrides:

readEnabledStateAsync in class AcknowledgeableConditionTypeNode

Returns:

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

writeEnabledStateAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEnabledStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState)

Description copied from interface: ConditionType

An asynchronous implementation of ConditionType.writeEnabledState(LocalizedText).

Specified by:

writeEnabledStateAsync in interface AcknowledgeableConditionType

Specified by:

writeEnabledStateAsync in interface AlarmConditionType

Specified by:

writeEnabledStateAsync in interface ConditionType

Overrides:

writeEnabledStateAsync in class AcknowledgeableConditionTypeNode

Returns:

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

getEnabledStateNode

public TwoStateVariableTypeNode getEnabledStateNode()
                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ConditionType

Get the EnabledState TwoStateVariableType Node, or null if it does not exist.

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

Specified by:

getEnabledStateNode in interface AcknowledgeableConditionType

Specified by:

getEnabledStateNode in interface AlarmConditionType

Specified by:

getEnabledStateNode in interface ConditionType

Overrides:

getEnabledStateNode in class AcknowledgeableConditionTypeNode

Returns:

the EnabledState TwoStateVariableType 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.

getEnabledStateNodeAsync

public CompletableFuture<? extends TwoStateVariableTypeNode> getEnabledStateNodeAsync()

Description copied from interface: ConditionType

Asynchronous implementation of ConditionType.getEnabledStateNode().

Specified by:

getEnabledStateNodeAsync in interface AcknowledgeableConditionType

Specified by:

getEnabledStateNodeAsync in interface AlarmConditionType

Specified by:

getEnabledStateNodeAsync in interface ConditionType

Overrides:

getEnabledStateNodeAsync in class AcknowledgeableConditionTypeNode

Returns:

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

getActiveState

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getActiveState()
                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Get the local value of the ActiveState Node.

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

Specified by:

getActiveState in interface AlarmConditionType

Returns:

the local value of the ActiveState Node.

Throws:

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

setActiveState

public void setActiveState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText activeState)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Set the local value of the ActiveState Node.

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

Specified by:

setActiveState in interface AlarmConditionType

Parameters:

activeState - the local value to set for the ActiveState Node.

Throws:

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

readActiveState

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readActiveState()
                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

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

Specified by:

readActiveState in interface AlarmConditionType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeActiveState

public void writeActiveState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText activeState)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

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

Specified by:

writeActiveState in interface AlarmConditionType

Parameters:

activeState - the LocalizedText value to write to the server.

Throws:

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

readActiveStateAsync

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

Description copied from interface: AlarmConditionType

An asynchronous implementation of AlarmConditionType.readActiveState().

Specified by:

readActiveStateAsync in interface AlarmConditionType

Returns:

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

writeActiveStateAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeActiveStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText activeState)

Description copied from interface: AlarmConditionType

An asynchronous implementation of AlarmConditionType.writeActiveState(LocalizedText).

Specified by:

writeActiveStateAsync in interface AlarmConditionType

Returns:

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

getActiveStateNode

public TwoStateVariableTypeNode getActiveStateNode()
                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Get the ActiveState TwoStateVariableType Node, or null if it does not exist.

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

Specified by:

getActiveStateNode in interface AlarmConditionType

Returns:

the ActiveState TwoStateVariableType 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.

getActiveStateNodeAsync

public CompletableFuture<? extends TwoStateVariableTypeNode> getActiveStateNodeAsync()

Description copied from interface: AlarmConditionType

Asynchronous implementation of AlarmConditionType.getActiveStateNode().

Specified by:

getActiveStateNodeAsync in interface AlarmConditionType

Returns:

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

getSuppressedState

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getSuppressedState()
                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Get the local value of the SuppressedState Node.

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

Specified by:

getSuppressedState in interface AlarmConditionType

Returns:

the local value of the SuppressedState Node.

Throws:

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

setSuppressedState

public void setSuppressedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Set the local value of the SuppressedState Node.

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

Specified by:

setSuppressedState in interface AlarmConditionType

Parameters:

suppressedState - the local value to set for the SuppressedState Node.

Throws:

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

readSuppressedState

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readSuppressedState()
                                                                                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

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

Specified by:

readSuppressedState in interface AlarmConditionType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeSuppressedState

public void writeSuppressedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

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

Specified by:

writeSuppressedState in interface AlarmConditionType

Parameters:

suppressedState - the LocalizedText value to write to the server.

Throws:

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

readSuppressedStateAsync

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

Description copied from interface: AlarmConditionType

An asynchronous implementation of AlarmConditionType.readSuppressedState().

Specified by:

readSuppressedStateAsync in interface AlarmConditionType

Returns:

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

writeSuppressedStateAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSuppressedStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState)

Description copied from interface: AlarmConditionType

An asynchronous implementation of AlarmConditionType.writeSuppressedState(LocalizedText).

Specified by:

writeSuppressedStateAsync in interface AlarmConditionType

Returns:

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

getSuppressedStateNode

public TwoStateVariableTypeNode getSuppressedStateNode()
                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Get the SuppressedState TwoStateVariableType Node, or null if it does not exist.

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

Specified by:

getSuppressedStateNode in interface AlarmConditionType

Returns:

the SuppressedState TwoStateVariableType 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.

getSuppressedStateNodeAsync

public CompletableFuture<? extends TwoStateVariableTypeNode> getSuppressedStateNodeAsync()

Description copied from interface: AlarmConditionType

Asynchronous implementation of AlarmConditionType.getSuppressedStateNode().

Specified by:

getSuppressedStateNodeAsync in interface AlarmConditionType

Returns:

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

getShelvingStateNode

public ShelvedStateMachineTypeNode getShelvingStateNode()
                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlarmConditionType

Get the ShelvingState ShelvedStateMachineType Node, or null if it does not exist.

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

Specified by:

getShelvingStateNode in interface AlarmConditionType

Returns:

the ShelvingState ShelvedStateMachineType 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.

getShelvingStateNodeAsync

public CompletableFuture<? extends ShelvedStateMachineTypeNode> getShelvingStateNodeAsync()

Description copied from interface: AlarmConditionType

Asynchronous implementation of AlarmConditionType.getShelvingStateNode().

Specified by:

getShelvingStateNodeAsync in interface AlarmConditionType

Returns:

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