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

Class OffNormalAlarmTypeNode

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SystemOffNormalAlarmTypeNode, TripAlarmTypeNode

public class OffNormalAlarmTypeNode
extends DiscreteAlarmTypeNode
implements OffNormalAlarmType

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

NORMAL_STATE

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

OffNormalAlarmTypeNode(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.NodeId	getNormalState() Get the local value of the NormalState Node.
PropertyTypeNode	getNormalStateNode() Get the NormalState PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getNormalStateNodeAsync() Asynchronous implementation of OffNormalAlarmType.getNormalStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readNormalState() Read the value of the NormalState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readNormalStateAsync() An asynchronous implementation of OffNormalAlarmType.readNormalState().
void	setNormalState(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId normalState) Set the local value of the NormalState Node.
void	writeNormalState(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId normalState) Write a new value for the NormalState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNormalStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId normalState) An asynchronous implementation of OffNormalAlarmType.writeNormalState(NodeId).

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

getActiveState, getActiveStateNode, getActiveStateNodeAsync, getEnabledState, getEnabledStateNode, getEnabledStateNodeAsync, getInputNode, getInputNodeNode, getInputNodeNodeAsync, getMaxTimeShelved, getMaxTimeShelvedNode, getMaxTimeShelvedNodeAsync, getShelvingStateNode, getShelvingStateNodeAsync, getSuppressedOrShelved, getSuppressedOrShelvedNode, getSuppressedOrShelvedNodeAsync, getSuppressedState, getSuppressedStateNode, getSuppressedStateNodeAsync, readActiveState, readActiveStateAsync, readEnabledState, readEnabledStateAsync, readInputNode, readInputNodeAsync, readMaxTimeShelved, readMaxTimeShelvedAsync, readSuppressedOrShelved, readSuppressedOrShelvedAsync, readSuppressedState, readSuppressedStateAsync, setActiveState, setEnabledState, setInputNode, setMaxTimeShelved, setSuppressedOrShelved, setSuppressedState, writeActiveState, writeActiveStateAsync, writeEnabledState, writeEnabledStateAsync, writeInputNode, writeInputNodeAsync, writeMaxTimeShelved, writeMaxTimeShelvedAsync, writeSuppressedOrShelved, writeSuppressedOrShelvedAsync, writeSuppressedState, writeSuppressedStateAsync

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

getActiveState, getActiveStateNode, getActiveStateNodeAsync, getEnabledState, getEnabledStateNode, getEnabledStateNodeAsync, getInputNode, getInputNodeNode, getInputNodeNodeAsync, getMaxTimeShelved, getMaxTimeShelvedNode, getMaxTimeShelvedNodeAsync, getShelvingStateNode, getShelvingStateNodeAsync, getSuppressedOrShelved, getSuppressedOrShelvedNode, getSuppressedOrShelvedNodeAsync, getSuppressedState, getSuppressedStateNode, getSuppressedStateNodeAsync, readActiveState, readActiveStateAsync, readEnabledState, readEnabledStateAsync, readInputNode, readInputNodeAsync, readMaxTimeShelved, readMaxTimeShelvedAsync, readSuppressedOrShelved, readSuppressedOrShelvedAsync, readSuppressedState, readSuppressedStateAsync, setActiveState, setEnabledState, setInputNode, setMaxTimeShelved, setSuppressedOrShelved, setSuppressedState, writeActiveState, writeActiveStateAsync, writeEnabledState, writeEnabledStateAsync, writeInputNode, writeInputNodeAsync, writeMaxTimeShelved, writeMaxTimeShelvedAsync, writeSuppressedOrShelved, writeSuppressedOrShelvedAsync, writeSuppressedState, writeSuppressedStateAsync

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

OffNormalAlarmTypeNode

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

getNormalState

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

Description copied from interface: OffNormalAlarmType

Get the local value of the NormalState Node.

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

Specified by:

getNormalState in interface OffNormalAlarmType

Returns:

the local value of the NormalState Node.

Throws:

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

setNormalState

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

Description copied from interface: OffNormalAlarmType

Set the local value of the NormalState Node.

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

Specified by:

setNormalState in interface OffNormalAlarmType

Parameters:

normalState - the local value to set for the NormalState Node.

Throws:

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

readNormalState

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

Description copied from interface: OffNormalAlarmType

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

Specified by:

readNormalState in interface OffNormalAlarmType

Returns:

the NodeId value read from the server.

Throws:

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

writeNormalState

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

Description copied from interface: OffNormalAlarmType

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

Specified by:

writeNormalState in interface OffNormalAlarmType

Parameters:

normalState - the NodeId value to write to the server.

Throws:

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

readNormalStateAsync

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

Description copied from interface: OffNormalAlarmType

An asynchronous implementation of OffNormalAlarmType.readNormalState().

Specified by:

readNormalStateAsync in interface OffNormalAlarmType

Returns:

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

writeNormalStateAsync

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

Description copied from interface: OffNormalAlarmType

An asynchronous implementation of OffNormalAlarmType.writeNormalState(NodeId).

Specified by:

writeNormalStateAsync in interface OffNormalAlarmType

Returns:

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

getNormalStateNode

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

Description copied from interface: OffNormalAlarmType

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

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

Specified by:

getNormalStateNode in interface OffNormalAlarmType

Returns:

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

getNormalStateNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getNormalStateNodeAsync()

Description copied from interface: OffNormalAlarmType

Asynchronous implementation of OffNormalAlarmType.getNormalStateNode().

Specified by:

getNormalStateNodeAsync in interface OffNormalAlarmType

Returns:

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