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

Interface OffNormalAlarmType

All Superinterfaces:

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

All Known Subinterfaces:

CertificateExpirationAlarmType, SystemOffNormalAlarmType, TripAlarmType

All Known Implementing Classes:

CertificateExpirationAlarmTypeNode, OffNormalAlarmTypeNode, SystemOffNormalAlarmTypeNode, TripAlarmTypeNode

public interface OffNormalAlarmType
extends DiscreteAlarmType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	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

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.
PropertyType	getNormalStateNode() Get the NormalState PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getNormalStateNodeAsync() Asynchronous implementation of 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 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 writeNormalState(NodeId).

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

Field Detail

NORMAL_STATE

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> NORMAL_STATE

Method Detail

getNormalState

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

Get the local value of the NormalState Node.

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

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

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

Set the local value of the NormalState Node.

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

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

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

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

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

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

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

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

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

An asynchronous implementation of readNormalState().

Returns:

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

writeNormalStateAsync

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 writeNormalState(NodeId).

Returns:

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

getNormalStateNode

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

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

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

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

CompletableFuture<? extends PropertyType> getNormalStateNodeAsync()

Asynchronous implementation of getNormalStateNode().

Returns:

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