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

Interface LimitAlarmType

All Superinterfaces:

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

All Known Subinterfaces:

ExclusiveDeviationAlarmType, ExclusiveLevelAlarmType, ExclusiveLimitAlarmType, ExclusiveRateOfChangeAlarmType, NonExclusiveDeviationAlarmType, NonExclusiveLevelAlarmType, NonExclusiveLimitAlarmType, NonExclusiveRateOfChangeAlarmType

All Known Implementing Classes:

ExclusiveDeviationAlarmTypeNode, ExclusiveLevelAlarmTypeNode, ExclusiveLimitAlarmTypeNode, ExclusiveRateOfChangeAlarmTypeNode, LimitAlarmTypeNode, NonExclusiveDeviationAlarmTypeNode, NonExclusiveLevelAlarmTypeNode, NonExclusiveLimitAlarmTypeNode, NonExclusiveRateOfChangeAlarmTypeNode

public interface LimitAlarmType
extends AlarmConditionType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<Double>	HIGH_HIGH_LIMIT
static QualifiedProperty<Double>	HIGH_LIMIT
static QualifiedProperty<Double>	LOW_LIMIT
static QualifiedProperty<Double>	LOW_LOW_LIMIT

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
Double	getHighHighLimit() Get the local value of the HighHighLimit Node.
PropertyType	getHighHighLimitNode() Get the HighHighLimit PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getHighHighLimitNodeAsync() Asynchronous implementation of getHighHighLimitNode().
Double	getHighLimit() Get the local value of the HighLimit Node.
PropertyType	getHighLimitNode() Get the HighLimit PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getHighLimitNodeAsync() Asynchronous implementation of getHighLimitNode().
Double	getLowLimit() Get the local value of the LowLimit Node.
PropertyType	getLowLimitNode() Get the LowLimit PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getLowLimitNodeAsync() Asynchronous implementation of getLowLimitNode().
Double	getLowLowLimit() Get the local value of the LowLowLimit Node.
PropertyType	getLowLowLimitNode() Get the LowLowLimit PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getLowLowLimitNodeAsync() Asynchronous implementation of getLowLowLimitNode().
Double	readHighHighLimit() Read the value of the HighHighLimit Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readHighHighLimitAsync() An asynchronous implementation of readHighHighLimit().
Double	readHighLimit() Read the value of the HighLimit Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readHighLimitAsync() An asynchronous implementation of readHighLimit().
Double	readLowLimit() Read the value of the LowLimit Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readLowLimitAsync() An asynchronous implementation of readLowLimit().
Double	readLowLowLimit() Read the value of the LowLowLimit Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readLowLowLimitAsync() An asynchronous implementation of readLowLowLimit().
void	setHighHighLimit(Double highHighLimit) Set the local value of the HighHighLimit Node.
void	setHighLimit(Double highLimit) Set the local value of the HighLimit Node.
void	setLowLimit(Double lowLimit) Set the local value of the LowLimit Node.
void	setLowLowLimit(Double lowLowLimit) Set the local value of the LowLowLimit Node.
void	writeHighHighLimit(Double highHighLimit) Write a new value for the HighHighLimit Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeHighHighLimitAsync(Double highHighLimit) An asynchronous implementation of writeHighHighLimit(Double).
void	writeHighLimit(Double highLimit) Write a new value for the HighLimit Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeHighLimitAsync(Double highLimit) An asynchronous implementation of writeHighLimit(Double).
void	writeLowLimit(Double lowLimit) Write a new value for the LowLimit Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLowLimitAsync(Double lowLimit) An asynchronous implementation of writeLowLimit(Double).
void	writeLowLowLimit(Double lowLowLimit) Write a new value for the LowLowLimit Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLowLowLimitAsync(Double lowLowLimit) An asynchronous implementation of writeLowLowLimit(Double).

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

HIGH_HIGH_LIMIT

static final QualifiedProperty<Double> HIGH_HIGH_LIMIT

HIGH_LIMIT

static final QualifiedProperty<Double> HIGH_LIMIT

LOW_LIMIT

static final QualifiedProperty<Double> LOW_LIMIT

LOW_LOW_LIMIT

static final QualifiedProperty<Double> LOW_LOW_LIMIT

Method Detail

getHighHighLimit

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

Get the local value of the HighHighLimit Node.

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

Returns:

the local value of the HighHighLimit Node.

Throws:

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

setHighHighLimit

void setHighHighLimit(Double highHighLimit)
               throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the HighHighLimit Node.

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

Parameters:

highHighLimit - the local value to set for the HighHighLimit Node.

Throws:

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

readHighHighLimit

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

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

Returns:

the Double value read from the server.

Throws:

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

writeHighHighLimit

void writeHighHighLimit(Double highHighLimit)
                 throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

highHighLimit - the Double value to write to the server.

Throws:

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

readHighHighLimitAsync

CompletableFuture<? extends Double> readHighHighLimitAsync()

An asynchronous implementation of readHighHighLimit().

Returns:

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

writeHighHighLimitAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeHighHighLimitAsync(Double highHighLimit)

An asynchronous implementation of writeHighHighLimit(Double).

Returns:

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

getHighHighLimitNode

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

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

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

Returns:

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

getHighHighLimitNodeAsync

CompletableFuture<? extends PropertyType> getHighHighLimitNodeAsync()

Asynchronous implementation of getHighHighLimitNode().

Returns:

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

getHighLimit

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

Get the local value of the HighLimit Node.

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

Returns:

the local value of the HighLimit Node.

Throws:

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

setHighLimit

void setHighLimit(Double highLimit)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the HighLimit Node.

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

Parameters:

highLimit - the local value to set for the HighLimit Node.

Throws:

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

readHighLimit

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

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

Returns:

the Double value read from the server.

Throws:

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

writeHighLimit

void writeHighLimit(Double highLimit)
             throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

highLimit - the Double value to write to the server.

Throws:

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

readHighLimitAsync

CompletableFuture<? extends Double> readHighLimitAsync()

An asynchronous implementation of readHighLimit().

Returns:

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

writeHighLimitAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeHighLimitAsync(Double highLimit)

An asynchronous implementation of writeHighLimit(Double).

Returns:

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

getHighLimitNode

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

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

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

Returns:

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

getHighLimitNodeAsync

CompletableFuture<? extends PropertyType> getHighLimitNodeAsync()

Asynchronous implementation of getHighLimitNode().

Returns:

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

getLowLimit

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

Get the local value of the LowLimit Node.

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

Returns:

the local value of the LowLimit Node.

Throws:

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

setLowLimit

void setLowLimit(Double lowLimit)
          throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the LowLimit Node.

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

Parameters:

lowLimit - the local value to set for the LowLimit Node.

Throws:

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

readLowLimit

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

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

Returns:

the Double value read from the server.

Throws:

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

writeLowLimit

void writeLowLimit(Double lowLimit)
            throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

lowLimit - the Double value to write to the server.

Throws:

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

readLowLimitAsync

CompletableFuture<? extends Double> readLowLimitAsync()

An asynchronous implementation of readLowLimit().

Returns:

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

writeLowLimitAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLowLimitAsync(Double lowLimit)

An asynchronous implementation of writeLowLimit(Double).

Returns:

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

getLowLimitNode

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

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

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

Returns:

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

getLowLimitNodeAsync

CompletableFuture<? extends PropertyType> getLowLimitNodeAsync()

Asynchronous implementation of getLowLimitNode().

Returns:

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

getLowLowLimit

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

Get the local value of the LowLowLimit Node.

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

Returns:

the local value of the LowLowLimit Node.

Throws:

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

setLowLowLimit

void setLowLowLimit(Double lowLowLimit)
             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the LowLowLimit Node.

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

Parameters:

lowLowLimit - the local value to set for the LowLowLimit Node.

Throws:

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

readLowLowLimit

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

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

Returns:

the Double value read from the server.

Throws:

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

writeLowLowLimit

void writeLowLowLimit(Double lowLowLimit)
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

lowLowLimit - the Double value to write to the server.

Throws:

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

readLowLowLimitAsync

CompletableFuture<? extends Double> readLowLowLimitAsync()

An asynchronous implementation of readLowLowLimit().

Returns:

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

writeLowLowLimitAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLowLowLimitAsync(Double lowLowLimit)

An asynchronous implementation of writeLowLowLimit(Double).

Returns:

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

getLowLowLimitNode

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

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

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

Returns:

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

getLowLowLimitNodeAsync

CompletableFuture<? extends PropertyType> getLowLowLimitNodeAsync()

Asynchronous implementation of getLowLowLimitNode().

Returns:

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