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

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

Interface ExclusiveLimitAlarmType

All Superinterfaces:

AcknowledgeableConditionType, AlarmConditionType, BaseEventType, BaseObjectType, ConditionType, LimitAlarmType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

All Known Subinterfaces:

ExclusiveDeviationAlarmType, ExclusiveLevelAlarmType, ExclusiveRateOfChangeAlarmType

All Known Implementing Classes:

ExclusiveDeviationAlarmTypeNode, ExclusiveLevelAlarmTypeNode, ExclusiveLimitAlarmTypeNode, ExclusiveRateOfChangeAlarmTypeNode

public interface ExclusiveLimitAlarmType
extends LimitAlarmType

See Also:

• https://reference.opcfoundation.org/v105/Core/docs/Part9/5.8.19/#5.8.19.3

Field Summary

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

AUDIBLE_ENABLED, INPUT_NODE, MAX_TIME_SHELVED, OFF_DELAY, ON_DELAY, RE_ALARM_TIME, SUPPRESSED_OR_SHELVED

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

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

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

BRANCH_ID, CLIENT_USER_ID, CONDITION_CLASS_ID, CONDITION_CLASS_NAME, CONDITION_NAME, CONDITION_SUB_CLASS_ID, CONDITION_SUB_CLASS_NAME, RETAIN, SUPPORTS_FILTERED_RETAIN

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

BASE_HIGH_HIGH_LIMIT, BASE_HIGH_LIMIT, BASE_LOW_LIMIT, BASE_LOW_LOW_LIMIT, HIGH_DEADBAND, HIGH_HIGH_DEADBAND, HIGH_HIGH_LIMIT, HIGH_LIMIT, LOW_DEADBAND, LOW_LIMIT, LOW_LOW_DEADBAND, LOW_LOW_LIMIT, SEVERITY_HIGH, SEVERITY_HIGH_HIGH, SEVERITY_LOW, SEVERITY_LOW_LOW

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getActiveState()	Get the local value of the ActiveState Node.
TwoStateVariableType	getActiveStateNode()	Get the ActiveState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableType>	getActiveStateNodeAsync()	Asynchronous implementation of getActiveStateNode().
ExclusiveLimitStateMachineType	getLimitStateNode()	Get the LimitState ExclusiveLimitStateMachineType Node, or null if it does not exist.
CompletableFuture<? extends ExclusiveLimitStateMachineType>	getLimitStateNodeAsync()	Asynchronous implementation of getLimitStateNode().
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 readActiveState().
void	setActiveState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Set the local value of the ActiveState Node.
void	writeActiveState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	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 value)	An asynchronous implementation of writeActiveState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.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.objects.AlarmConditionType

getAudibleEnabled, getAudibleEnabledNode, getAudibleEnabledNodeAsync, getAudibleSound, getAudibleSoundNode, getAudibleSoundNodeAsync, getEnabledState, getEnabledStateNode, getEnabledStateNodeAsync, getFirstInGroupFlag, getFirstInGroupFlagNode, getFirstInGroupFlagNodeAsync, getFirstInGroupNode, getFirstInGroupNodeAsync, getInputNode, getInputNodeNode, getInputNodeNodeAsync, getLatchedState, getLatchedStateNode, getLatchedStateNodeAsync, getMaxTimeShelved, getMaxTimeShelvedNode, getMaxTimeShelvedNodeAsync, getOffDelay, getOffDelayNode, getOffDelayNodeAsync, getOnDelay, getOnDelayNode, getOnDelayNodeAsync, getOutOfServiceState, getOutOfServiceStateNode, getOutOfServiceStateNodeAsync, getReAlarmRepeatCount, getReAlarmRepeatCountNode, getReAlarmRepeatCountNodeAsync, getReAlarmTime, getReAlarmTimeNode, getReAlarmTimeNodeAsync, getShelvingStateNode, getShelvingStateNodeAsync, getSilenceState, getSilenceStateNode, getSilenceStateNodeAsync, getSuppressedOrShelved, getSuppressedOrShelvedNode, getSuppressedOrShelvedNodeAsync, getSuppressedState, getSuppressedStateNode, getSuppressedStateNodeAsync, readAudibleEnabled, readAudibleEnabledAsync, readAudibleSound, readAudibleSoundAsync, readEnabledState, readEnabledStateAsync, readFirstInGroupFlag, readFirstInGroupFlagAsync, readInputNode, readInputNodeAsync, readLatchedState, readLatchedStateAsync, readMaxTimeShelved, readMaxTimeShelvedAsync, readOffDelay, readOffDelayAsync, readOnDelay, readOnDelayAsync, readOutOfServiceState, readOutOfServiceStateAsync, readReAlarmRepeatCount, readReAlarmRepeatCountAsync, readReAlarmTime, readReAlarmTimeAsync, readSilenceState, readSilenceStateAsync, readSuppressedOrShelved, readSuppressedOrShelvedAsync, readSuppressedState, readSuppressedStateAsync, setAudibleEnabled, setAudibleSound, setEnabledState, setFirstInGroupFlag, setInputNode, setLatchedState, setMaxTimeShelved, setOffDelay, setOnDelay, setOutOfServiceState, setReAlarmRepeatCount, setReAlarmTime, setSilenceState, setSuppressedOrShelved, setSuppressedState, writeAudibleEnabled, writeAudibleEnabledAsync, writeAudibleSound, writeAudibleSoundAsync, writeEnabledState, writeEnabledStateAsync, writeFirstInGroupFlag, writeFirstInGroupFlagAsync, writeInputNode, writeInputNodeAsync, writeLatchedState, writeLatchedStateAsync, writeMaxTimeShelved, writeMaxTimeShelvedAsync, writeOffDelay, writeOffDelayAsync, writeOnDelay, writeOnDelayAsync, writeOutOfServiceState, writeOutOfServiceStateAsync, writeReAlarmRepeatCount, writeReAlarmRepeatCountAsync, writeReAlarmTime, writeReAlarmTimeAsync, writeSilenceState, writeSilenceStateAsync, writeSuppressedOrShelved, writeSuppressedOrShelvedAsync, writeSuppressedState, writeSuppressedStateAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.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.client.model.objects.ConditionType

getBranchId, getBranchIdNode, getBranchIdNodeAsync, getClientUserId, getClientUserIdNode, getClientUserIdNodeAsync, getComment, getCommentNode, getCommentNodeAsync, getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionName, getConditionNameNode, getConditionNameNodeAsync, getConditionSubClassId, getConditionSubClassIdNode, getConditionSubClassIdNodeAsync, getConditionSubClassName, getConditionSubClassNameNode, getConditionSubClassNameNodeAsync, getLastSeverity, getLastSeverityNode, getLastSeverityNodeAsync, getQuality, getQualityNode, getQualityNodeAsync, getRetain, getRetainNode, getRetainNodeAsync, getSupportsFilteredRetain, getSupportsFilteredRetainNode, getSupportsFilteredRetainNodeAsync, readBranchId, readBranchIdAsync, readClientUserId, readClientUserIdAsync, readComment, readCommentAsync, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionName, readConditionNameAsync, readConditionSubClassId, readConditionSubClassIdAsync, readConditionSubClassName, readConditionSubClassNameAsync, readLastSeverity, readLastSeverityAsync, readQuality, readQualityAsync, readRetain, readRetainAsync, readSupportsFilteredRetain, readSupportsFilteredRetainAsync, setBranchId, setClientUserId, setComment, setConditionClassId, setConditionClassName, setConditionName, setConditionSubClassId, setConditionSubClassName, setLastSeverity, setQuality, setRetain, setSupportsFilteredRetain, writeBranchId, writeBranchIdAsync, writeClientUserId, writeClientUserIdAsync, writeComment, writeCommentAsync, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionName, writeConditionNameAsync, writeConditionSubClassId, writeConditionSubClassIdAsync, writeConditionSubClassName, writeConditionSubClassNameAsync, writeLastSeverity, writeLastSeverityAsync, writeQuality, writeQualityAsync, writeRetain, writeRetainAsync, writeSupportsFilteredRetain, writeSupportsFilteredRetainAsync

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

getBaseHighHighLimit, getBaseHighHighLimitNode, getBaseHighHighLimitNodeAsync, getBaseHighLimit, getBaseHighLimitNode, getBaseHighLimitNodeAsync, getBaseLowLimit, getBaseLowLimitNode, getBaseLowLimitNodeAsync, getBaseLowLowLimit, getBaseLowLowLimitNode, getBaseLowLowLimitNodeAsync, getHighDeadband, getHighDeadbandNode, getHighDeadbandNodeAsync, getHighHighDeadband, getHighHighDeadbandNode, getHighHighDeadbandNodeAsync, getHighHighLimit, getHighHighLimitNode, getHighHighLimitNodeAsync, getHighLimit, getHighLimitNode, getHighLimitNodeAsync, getLowDeadband, getLowDeadbandNode, getLowDeadbandNodeAsync, getLowLimit, getLowLimitNode, getLowLimitNodeAsync, getLowLowDeadband, getLowLowDeadbandNode, getLowLowDeadbandNodeAsync, getLowLowLimit, getLowLowLimitNode, getLowLowLimitNodeAsync, getSeverityHigh, getSeverityHighHigh, getSeverityHighHighNode, getSeverityHighHighNodeAsync, getSeverityHighNode, getSeverityHighNodeAsync, getSeverityLow, getSeverityLowLow, getSeverityLowLowNode, getSeverityLowLowNodeAsync, getSeverityLowNode, getSeverityLowNodeAsync, readBaseHighHighLimit, readBaseHighHighLimitAsync, readBaseHighLimit, readBaseHighLimitAsync, readBaseLowLimit, readBaseLowLimitAsync, readBaseLowLowLimit, readBaseLowLowLimitAsync, readHighDeadband, readHighDeadbandAsync, readHighHighDeadband, readHighHighDeadbandAsync, readHighHighLimit, readHighHighLimitAsync, readHighLimit, readHighLimitAsync, readLowDeadband, readLowDeadbandAsync, readLowLimit, readLowLimitAsync, readLowLowDeadband, readLowLowDeadbandAsync, readLowLowLimit, readLowLowLimitAsync, readSeverityHigh, readSeverityHighAsync, readSeverityHighHigh, readSeverityHighHighAsync, readSeverityLow, readSeverityLowAsync, readSeverityLowLow, readSeverityLowLowAsync, setBaseHighHighLimit, setBaseHighLimit, setBaseLowLimit, setBaseLowLowLimit, setHighDeadband, setHighHighDeadband, setHighHighLimit, setHighLimit, setLowDeadband, setLowLimit, setLowLowDeadband, setLowLowLimit, setSeverityHigh, setSeverityHighHigh, setSeverityLow, setSeverityLowLow, writeBaseHighHighLimit, writeBaseHighHighLimitAsync, writeBaseHighLimit, writeBaseHighLimitAsync, writeBaseLowLimit, writeBaseLowLimitAsync, writeBaseLowLowLimit, writeBaseLowLowLimitAsync, writeHighDeadband, writeHighDeadbandAsync, writeHighHighDeadband, writeHighHighDeadbandAsync, writeHighHighLimit, writeHighHighLimitAsync, writeHighLimit, writeHighLimitAsync, writeLowDeadband, writeLowDeadbandAsync, writeLowLimit, writeLowLimitAsync, writeLowLowDeadband, writeLowLowDeadbandAsync, writeLowLowLimit, writeLowLowLimitAsync, writeSeverityHigh, writeSeverityHighAsync, writeSeverityHighHigh, writeSeverityHighHighAsync, writeSeverityLow, writeSeverityLowAsync, writeSeverityLowLow, writeSeverityLowLowAsync

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

getEventNotifier, setEventNotifier

Method Details

getActiveState

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

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

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

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:

value - 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

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

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

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

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:

value - 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

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

An asynchronous implementation of readActiveState().

Specified by:

readActiveStateAsync in interface AlarmConditionType

Returns:

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

writeActiveStateAsync

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

An asynchronous implementation of writeActiveState(org.eclipse.milo.opcua.stack.core.types.builtin.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

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

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

CompletableFuture<? extends TwoStateVariableType> getActiveStateNodeAsync()

Asynchronous implementation of getActiveStateNode().

Specified by:

getActiveStateNodeAsync in interface AlarmConditionType

Returns:

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

getLimitStateNode

ExclusiveLimitStateMachineType getLimitStateNode()
                                          throws org.eclipse.milo.opcua.stack.core.UaException

Get the LimitState ExclusiveLimitStateMachineType Node, or null if it does not exist.

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

Returns:

the LimitState ExclusiveLimitStateMachineType 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.

getLimitStateNodeAsync

CompletableFuture<? extends ExclusiveLimitStateMachineType> getLimitStateNodeAsync()

Asynchronous implementation of getLimitStateNode().

Returns:

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