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

Interface ExclusiveDeviationAlarmType

All Superinterfaces:

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

All Known Implementing Classes:

ExclusiveDeviationAlarmTypeNode

public interface ExclusiveDeviationAlarmType
extends ExclusiveLimitAlarmType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	SETPOINT_NODE

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

HIGH_HIGH_LIMIT, HIGH_LIMIT, LOW_LIMIT, 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
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getSetpointNode() Get the local value of the SetpointNode Node.
PropertyType	getSetpointNodeNode() Get the SetpointNode PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getSetpointNodeNodeAsync() Asynchronous implementation of getSetpointNodeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readSetpointNode() Read the value of the SetpointNode Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readSetpointNodeAsync() An asynchronous implementation of readSetpointNode().
void	setSetpointNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId setpointNode) Set the local value of the SetpointNode Node.
void	writeSetpointNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId setpointNode) Write a new value for the SetpointNode Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSetpointNodeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId setpointNode) An asynchronous implementation of writeSetpointNode(NodeId).

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

getActiveState, getActiveStateNode, getActiveStateNodeAsync, getLimitStateNode, getLimitStateNodeAsync, readActiveState, readActiveStateAsync, setActiveState, writeActiveState, writeActiveStateAsync

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

getHighHighLimit, getHighHighLimitNode, getHighHighLimitNodeAsync, getHighLimit, getHighLimitNode, getHighLimitNodeAsync, getLowLimit, getLowLimitNode, getLowLimitNodeAsync, getLowLowLimit, getLowLowLimitNode, getLowLowLimitNodeAsync, readHighHighLimit, readHighHighLimitAsync, readHighLimit, readHighLimitAsync, readLowLimit, readLowLimitAsync, readLowLowLimit, readLowLowLimitAsync, setHighHighLimit, setHighLimit, setLowLimit, setLowLowLimit, writeHighHighLimit, writeHighHighLimitAsync, writeHighLimit, writeHighLimitAsync, writeLowLimit, writeLowLimitAsync, writeLowLowLimit, writeLowLowLimitAsync

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

getEnabledState, getEnabledStateNode, getEnabledStateNodeAsync, getInputNode, getInputNodeNode, getInputNodeNodeAsync, getMaxTimeShelved, getMaxTimeShelvedNode, getMaxTimeShelvedNodeAsync, getShelvingStateNode, getShelvingStateNodeAsync, getSuppressedOrShelved, getSuppressedOrShelvedNode, getSuppressedOrShelvedNodeAsync, getSuppressedState, getSuppressedStateNode, getSuppressedStateNodeAsync, readEnabledState, readEnabledStateAsync, readInputNode, readInputNodeAsync, readMaxTimeShelved, readMaxTimeShelvedAsync, readSuppressedOrShelved, readSuppressedOrShelvedAsync, readSuppressedState, readSuppressedStateAsync, setEnabledState, setInputNode, setMaxTimeShelved, setSuppressedOrShelved, setSuppressedState, 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

SETPOINT_NODE

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

Method Detail

getSetpointNode

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

Get the local value of the SetpointNode Node.

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

Returns:

the local value of the SetpointNode Node.

Throws:

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

setSetpointNode

void setSetpointNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId setpointNode)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SetpointNode Node.

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

Parameters:

setpointNode - the local value to set for the SetpointNode Node.

Throws:

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

readSetpointNode

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

Read the value of the SetpointNode 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.

writeSetpointNode

void writeSetpointNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId setpointNode)
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

setpointNode - the NodeId value to write to the server.

Throws:

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

readSetpointNodeAsync

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

An asynchronous implementation of readSetpointNode().

Returns:

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

writeSetpointNodeAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSetpointNodeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId setpointNode)

An asynchronous implementation of writeSetpointNode(NodeId).

Returns:

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

getSetpointNodeNode

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

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

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

Returns:

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

getSetpointNodeNodeAsync

CompletableFuture<? extends PropertyType> getSetpointNodeNodeAsync()

Asynchronous implementation of getSetpointNodeNode().

Returns:

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