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

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

Interface AcknowledgeableConditionType

All Superinterfaces:

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

All Known Subinterfaces:

AlarmConditionType, CertificateExpirationAlarmType, DiscrepancyAlarmType, DiscreteAlarmType, ExclusiveDeviationAlarmType, ExclusiveLevelAlarmType, ExclusiveLimitAlarmType, ExclusiveRateOfChangeAlarmType, InstrumentDiagnosticAlarmType, LimitAlarmType, NonExclusiveDeviationAlarmType, NonExclusiveLevelAlarmType, NonExclusiveLimitAlarmType, NonExclusiveRateOfChangeAlarmType, OffNormalAlarmType, SystemDiagnosticAlarmType, SystemOffNormalAlarmType, TripAlarmType, TrustListOutOfDateAlarmType

All Known Implementing Classes:

AcknowledgeableConditionTypeNode, AlarmConditionTypeNode, CertificateExpirationAlarmTypeNode, DiscrepancyAlarmTypeNode, DiscreteAlarmTypeNode, ExclusiveDeviationAlarmTypeNode, ExclusiveLevelAlarmTypeNode, ExclusiveLimitAlarmTypeNode, ExclusiveRateOfChangeAlarmTypeNode, InstrumentDiagnosticAlarmTypeNode, LimitAlarmTypeNode, NonExclusiveDeviationAlarmTypeNode, NonExclusiveLevelAlarmTypeNode, NonExclusiveLimitAlarmTypeNode, NonExclusiveRateOfChangeAlarmTypeNode, OffNormalAlarmTypeNode, SystemDiagnosticAlarmTypeNode, SystemOffNormalAlarmTypeNode, TripAlarmTypeNode, TrustListOutOfDateAlarmTypeNode

public interface AcknowledgeableConditionType
extends ConditionType

See Also:

• https://reference.opcfoundation.org/v105/Core/docs/Part9/5.7.2

Field Summary

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

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getAckedState()	Get the local value of the AckedState Node.
TwoStateVariableType	getAckedStateNode()	Get the AckedState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableType>	getAckedStateNodeAsync()	Asynchronous implementation of getAckedStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getConfirmedState()	Get the local value of the ConfirmedState Node.
TwoStateVariableType	getConfirmedStateNode()	Get the ConfirmedState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableType>	getConfirmedStateNodeAsync()	Asynchronous implementation of getConfirmedStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getEnabledState()	Get the local value of the EnabledState Node.
TwoStateVariableType	getEnabledStateNode()	Get the EnabledState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableType>	getEnabledStateNodeAsync()	Asynchronous implementation of getEnabledStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readAckedState()	Read the value of the AckedState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readAckedStateAsync()	An asynchronous implementation of readAckedState().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readConfirmedState()	Read the value of the ConfirmedState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readConfirmedStateAsync()	An asynchronous implementation of readConfirmedState().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readEnabledState()	Read the value of the EnabledState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readEnabledStateAsync()	An asynchronous implementation of readEnabledState().
void	setAckedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Set the local value of the AckedState Node.
void	setConfirmedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Set the local value of the ConfirmedState Node.
void	setEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Set the local value of the EnabledState Node.
void	writeAckedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Write a new value for the AckedState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeAckedStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	An asynchronous implementation of writeAckedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).
void	writeConfirmedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Write a new value for the ConfirmedState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConfirmedStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	An asynchronous implementation of writeConfirmedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).
void	writeEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Write a new value for the EnabledState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEnabledStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	An asynchronous implementation of writeEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

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

getEnabledState

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

Get the local value of the EnabledState Node.

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

Specified by:

getEnabledState in interface ConditionType

Returns:

the local value of the EnabledState Node.

Throws:

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

setEnabledState

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

Set the local value of the EnabledState Node.

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

Specified by:

setEnabledState in interface ConditionType

Parameters:

value - the local value to set for the EnabledState Node.

Throws:

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

readEnabledState

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

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

Specified by:

readEnabledState in interface ConditionType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeEnabledState

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

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

Specified by:

writeEnabledState in interface ConditionType

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.

readEnabledStateAsync

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

An asynchronous implementation of readEnabledState().

Specified by:

readEnabledStateAsync in interface ConditionType

Returns:

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

writeEnabledStateAsync

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

An asynchronous implementation of writeEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

Specified by:

writeEnabledStateAsync in interface ConditionType

Returns:

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

getEnabledStateNode

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

Get the EnabledState TwoStateVariableType Node, or null if it does not exist.

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

Specified by:

getEnabledStateNode in interface ConditionType

Returns:

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

getEnabledStateNodeAsync

CompletableFuture<? extends TwoStateVariableType> getEnabledStateNodeAsync()

Asynchronous implementation of getEnabledStateNode().

Specified by:

getEnabledStateNodeAsync in interface ConditionType

Returns:

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

getAckedState

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

Get the local value of the AckedState Node.

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

Returns:

the local value of the AckedState Node.

Throws:

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

setAckedState

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

Set the local value of the AckedState Node.

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

Parameters:

value - the local value to set for the AckedState Node.

Throws:

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

readAckedState

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

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

Returns:

the LocalizedText value read from the server.

Throws:

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

writeAckedState

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

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

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.

readAckedStateAsync

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

An asynchronous implementation of readAckedState().

Returns:

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

writeAckedStateAsync

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

An asynchronous implementation of writeAckedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

Returns:

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

getAckedStateNode

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

Get the AckedState TwoStateVariableType Node, or null if it does not exist.

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

Returns:

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

getAckedStateNodeAsync

CompletableFuture<? extends TwoStateVariableType> getAckedStateNodeAsync()

Asynchronous implementation of getAckedStateNode().

Returns:

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

getConfirmedState

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

Get the local value of the ConfirmedState Node.

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

Returns:

the local value of the ConfirmedState Node.

Throws:

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

setConfirmedState

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

Set the local value of the ConfirmedState Node.

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

Parameters:

value - the local value to set for the ConfirmedState Node.

Throws:

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

readConfirmedState

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

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

Returns:

the LocalizedText value read from the server.

Throws:

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

writeConfirmedState

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

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

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.

readConfirmedStateAsync

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

An asynchronous implementation of readConfirmedState().

Returns:

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

writeConfirmedStateAsync

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

An asynchronous implementation of writeConfirmedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

Returns:

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

getConfirmedStateNode

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

Get the ConfirmedState TwoStateVariableType Node, or null if it does not exist.

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

Returns:

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

getConfirmedStateNodeAsync

CompletableFuture<? extends TwoStateVariableType> getConfirmedStateNodeAsync()

Asynchronous implementation of getConfirmedStateNode().

Returns:

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