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

Interface ConditionType

All Superinterfaces:

BaseEventType, BaseObjectType, Node, ObjectNode

All Known Subinterfaces:

AcknowledgeableConditionType, AlarmConditionType, CertificateExpirationAlarmType, DialogConditionType, DiscreteAlarmType, ExclusiveDeviationAlarmType, ExclusiveLevelAlarmType, ExclusiveLimitAlarmType, ExclusiveRateOfChangeAlarmType, LimitAlarmType, NonExclusiveDeviationAlarmType, NonExclusiveLevelAlarmType, NonExclusiveLimitAlarmType, NonExclusiveRateOfChangeAlarmType, OffNormalAlarmType, SystemOffNormalAlarmType, TripAlarmType

All Known Implementing Classes:

AcknowledgeableConditionTypeNode, AlarmConditionTypeNode, CertificateExpirationAlarmTypeNode, ConditionTypeNode, DialogConditionTypeNode, DiscreteAlarmTypeNode, ExclusiveDeviationAlarmTypeNode, ExclusiveLevelAlarmTypeNode, ExclusiveLimitAlarmTypeNode, ExclusiveRateOfChangeAlarmTypeNode, LimitAlarmTypeNode, NonExclusiveDeviationAlarmTypeNode, NonExclusiveLevelAlarmTypeNode, NonExclusiveLimitAlarmTypeNode, NonExclusiveRateOfChangeAlarmTypeNode, OffNormalAlarmTypeNode, SystemOffNormalAlarmTypeNode, TripAlarmTypeNode

public interface ConditionType
extends BaseEventType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	BRANCH_ID
static QualifiedProperty<String>	CLIENT_USER_ID
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	CONDITION_CLASS_ID
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	CONDITION_CLASS_NAME
static QualifiedProperty<String>	CONDITION_NAME
static QualifiedProperty<Boolean>	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	getBranchId() Get the local value of the BranchId Node.
PropertyType	getBranchIdNode() Get the BranchId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getBranchIdNodeAsync() Asynchronous implementation of getBranchIdNode().
String	getClientUserId() Get the local value of the ClientUserId Node.
PropertyType	getClientUserIdNode() Get the ClientUserId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getClientUserIdNodeAsync() Asynchronous implementation of getClientUserIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getComment() Get the local value of the Comment Node.
ConditionVariableType	getCommentNode() Get the Comment ConditionVariableType Node, or null if it does not exist.
CompletableFuture<? extends ConditionVariableType>	getCommentNodeAsync() Asynchronous implementation of getCommentNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getConditionClassId() Get the local value of the ConditionClassId Node.
PropertyType	getConditionClassIdNode() Get the ConditionClassId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getConditionClassIdNodeAsync() Asynchronous implementation of getConditionClassIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getConditionClassName() Get the local value of the ConditionClassName Node.
PropertyType	getConditionClassNameNode() Get the ConditionClassName PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getConditionClassNameNodeAsync() Asynchronous implementation of getConditionClassNameNode().
String	getConditionName() Get the local value of the ConditionName Node.
PropertyType	getConditionNameNode() Get the ConditionName PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getConditionNameNodeAsync() Asynchronous implementation of getConditionNameNode().
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.unsigned.UShort	getLastSeverity() Get the local value of the LastSeverity Node.
ConditionVariableType	getLastSeverityNode() Get the LastSeverity ConditionVariableType Node, or null if it does not exist.
CompletableFuture<? extends ConditionVariableType>	getLastSeverityNodeAsync() Asynchronous implementation of getLastSeverityNode().
org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode	getQuality() Get the local value of the Quality Node.
ConditionVariableType	getQualityNode() Get the Quality ConditionVariableType Node, or null if it does not exist.
CompletableFuture<? extends ConditionVariableType>	getQualityNodeAsync() Asynchronous implementation of getQualityNode().
Boolean	getRetain() Get the local value of the Retain Node.
PropertyType	getRetainNode() Get the Retain PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getRetainNodeAsync() Asynchronous implementation of getRetainNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readBranchId() Read the value of the BranchId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readBranchIdAsync() An asynchronous implementation of readBranchId().
String	readClientUserId() Read the value of the ClientUserId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readClientUserIdAsync() An asynchronous implementation of readClientUserId().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readComment() Read the value of the Comment Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readCommentAsync() An asynchronous implementation of readComment().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readConditionClassId() Read the value of the ConditionClassId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readConditionClassIdAsync() An asynchronous implementation of readConditionClassId().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readConditionClassName() Read the value of the ConditionClassName Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readConditionClassNameAsync() An asynchronous implementation of readConditionClassName().
String	readConditionName() Read the value of the ConditionName Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readConditionNameAsync() An asynchronous implementation of readConditionName().
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().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	readLastSeverity() Read the value of the LastSeverity Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort>	readLastSeverityAsync() An asynchronous implementation of readLastSeverity().
org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode	readQuality() Read the value of the Quality Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	readQualityAsync() An asynchronous implementation of readQuality().
Boolean	readRetain() Read the value of the Retain Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readRetainAsync() An asynchronous implementation of readRetain().
void	setBranchId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId branchId) Set the local value of the BranchId Node.
void	setClientUserId(String clientUserId) Set the local value of the ClientUserId Node.
void	setComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText comment) Set the local value of the Comment Node.
void	setConditionClassId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId conditionClassId) Set the local value of the ConditionClassId Node.
void	setConditionClassName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText conditionClassName) Set the local value of the ConditionClassName Node.
void	setConditionName(String conditionName) Set the local value of the ConditionName Node.
void	setEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState) Set the local value of the EnabledState Node.
void	setLastSeverity(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort lastSeverity) Set the local value of the LastSeverity Node.
void	setQuality(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode quality) Set the local value of the Quality Node.
void	setRetain(Boolean retain) Set the local value of the Retain Node.
void	writeBranchId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId branchId) Write a new value for the BranchId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeBranchIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId branchId) An asynchronous implementation of writeBranchId(NodeId).
void	writeClientUserId(String clientUserId) Write a new value for the ClientUserId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeClientUserIdAsync(String clientUserId) An asynchronous implementation of writeClientUserId(String).
void	writeComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText comment) Write a new value for the Comment Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCommentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText comment) An asynchronous implementation of writeComment(LocalizedText).
void	writeConditionClassId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId conditionClassId) Write a new value for the ConditionClassId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConditionClassIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId conditionClassId) An asynchronous implementation of writeConditionClassId(NodeId).
void	writeConditionClassName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText conditionClassName) Write a new value for the ConditionClassName Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConditionClassNameAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText conditionClassName) An asynchronous implementation of writeConditionClassName(LocalizedText).
void	writeConditionName(String conditionName) Write a new value for the ConditionName Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConditionNameAsync(String conditionName) An asynchronous implementation of writeConditionName(String).
void	writeEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState) 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 enabledState) An asynchronous implementation of writeEnabledState(LocalizedText).
void	writeLastSeverity(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort lastSeverity) Write a new value for the LastSeverity Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLastSeverityAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort lastSeverity) An asynchronous implementation of writeLastSeverity(UShort).
void	writeQuality(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode quality) Write a new value for the Quality Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeQualityAsync(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode quality) An asynchronous implementation of writeQuality(StatusCode).
void	writeRetain(Boolean retain) Write a new value for the Retain Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeRetainAsync(Boolean retain) An asynchronous implementation of writeRetain(Boolean).

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

CONDITION_CLASS_ID

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

CONDITION_CLASS_NAME

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> CONDITION_CLASS_NAME

CONDITION_NAME

static final QualifiedProperty<String> CONDITION_NAME

BRANCH_ID

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

RETAIN

static final QualifiedProperty<Boolean> RETAIN

CLIENT_USER_ID

static final QualifiedProperty<String> CLIENT_USER_ID

Method Detail

getConditionClassId

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

Get the local value of the ConditionClassId Node.

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

Returns:

the local value of the ConditionClassId Node.

Throws:

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

setConditionClassId

void setConditionClassId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId conditionClassId)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ConditionClassId Node.

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

Parameters:

conditionClassId - the local value to set for the ConditionClassId Node.

Throws:

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

readConditionClassId

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

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

writeConditionClassId

void writeConditionClassId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId conditionClassId)
                    throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

conditionClassId - the NodeId value to write to the server.

Throws:

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

readConditionClassIdAsync

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

An asynchronous implementation of readConditionClassId().

Returns:

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

writeConditionClassIdAsync

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

An asynchronous implementation of writeConditionClassId(NodeId).

Returns:

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

getConditionClassIdNode

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

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

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

Returns:

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

getConditionClassIdNodeAsync

CompletableFuture<? extends PropertyType> getConditionClassIdNodeAsync()

Asynchronous implementation of getConditionClassIdNode().

Returns:

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

getConditionClassName

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

Get the local value of the ConditionClassName Node.

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

Returns:

the local value of the ConditionClassName Node.

Throws:

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

setConditionClassName

void setConditionClassName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText conditionClassName)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ConditionClassName Node.

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

Parameters:

conditionClassName - the local value to set for the ConditionClassName Node.

Throws:

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

readConditionClassName

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

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

writeConditionClassName

void writeConditionClassName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText conditionClassName)
                      throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

conditionClassName - the LocalizedText value to write to the server.

Throws:

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

readConditionClassNameAsync

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

An asynchronous implementation of readConditionClassName().

Returns:

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

writeConditionClassNameAsync

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

An asynchronous implementation of writeConditionClassName(LocalizedText).

Returns:

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

getConditionClassNameNode

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

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

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

Returns:

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

getConditionClassNameNodeAsync

CompletableFuture<? extends PropertyType> getConditionClassNameNodeAsync()

Asynchronous implementation of getConditionClassNameNode().

Returns:

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

getConditionName

String getConditionName()
                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ConditionName Node.

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

Returns:

the local value of the ConditionName Node.

Throws:

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

setConditionName

void setConditionName(String conditionName)
               throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ConditionName Node.

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

Parameters:

conditionName - the local value to set for the ConditionName Node.

Throws:

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

readConditionName

String readConditionName()
                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the String value read from the server.

Throws:

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

writeConditionName

void writeConditionName(String conditionName)
                 throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

conditionName - the String value to write to the server.

Throws:

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

readConditionNameAsync

CompletableFuture<? extends String> readConditionNameAsync()

An asynchronous implementation of readConditionName().

Returns:

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

writeConditionNameAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConditionNameAsync(String conditionName)

An asynchronous implementation of writeConditionName(String).

Returns:

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

getConditionNameNode

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

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

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

Returns:

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

getConditionNameNodeAsync

CompletableFuture<? extends PropertyType> getConditionNameNodeAsync()

Asynchronous implementation of getConditionNameNode().

Returns:

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

getBranchId

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

Get the local value of the BranchId Node.

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

Returns:

the local value of the BranchId Node.

Throws:

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

setBranchId

void setBranchId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId branchId)
          throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the BranchId Node.

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

Parameters:

branchId - the local value to set for the BranchId Node.

Throws:

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

readBranchId

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

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

writeBranchId

void writeBranchId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId branchId)
            throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

branchId - the NodeId value to write to the server.

Throws:

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

readBranchIdAsync

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

An asynchronous implementation of readBranchId().

Returns:

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

writeBranchIdAsync

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

An asynchronous implementation of writeBranchId(NodeId).

Returns:

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

getBranchIdNode

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

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

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

Returns:

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

getBranchIdNodeAsync

CompletableFuture<? extends PropertyType> getBranchIdNodeAsync()

Asynchronous implementation of getBranchIdNode().

Returns:

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

getRetain

Boolean getRetain()
           throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the Retain Node.

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

Returns:

the local value of the Retain Node.

Throws:

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

setRetain

void setRetain(Boolean retain)
        throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Retain Node.

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

Parameters:

retain - the local value to set for the Retain Node.

Throws:

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

readRetain

Boolean readRetain()
            throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Boolean value read from the server.

Throws:

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

writeRetain

void writeRetain(Boolean retain)
          throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

retain - the Boolean value to write to the server.

Throws:

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

readRetainAsync

CompletableFuture<? extends Boolean> readRetainAsync()

An asynchronous implementation of readRetain().

Returns:

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

writeRetainAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRetainAsync(Boolean retain)

An asynchronous implementation of writeRetain(Boolean).

Returns:

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

getRetainNode

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

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

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

Returns:

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

getRetainNodeAsync

CompletableFuture<? extends PropertyType> getRetainNodeAsync()

Asynchronous implementation of getRetainNode().

Returns:

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

getClientUserId

String getClientUserId()
                throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ClientUserId Node.

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

Returns:

the local value of the ClientUserId Node.

Throws:

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

setClientUserId

void setClientUserId(String clientUserId)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ClientUserId Node.

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

Parameters:

clientUserId - the local value to set for the ClientUserId Node.

Throws:

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

readClientUserId

String readClientUserId()
                 throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the String value read from the server.

Throws:

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

writeClientUserId

void writeClientUserId(String clientUserId)
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

clientUserId - the String value to write to the server.

Throws:

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

readClientUserIdAsync

CompletableFuture<? extends String> readClientUserIdAsync()

An asynchronous implementation of readClientUserId().

Returns:

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

writeClientUserIdAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeClientUserIdAsync(String clientUserId)

An asynchronous implementation of writeClientUserId(String).

Returns:

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

getClientUserIdNode

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

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

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

Returns:

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

getClientUserIdNodeAsync

CompletableFuture<? extends PropertyType> getClientUserIdNodeAsync()

Asynchronous implementation of getClientUserIdNode().

Returns:

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

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.

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

Parameters:

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

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

Parameters:

enabledState - 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().

Returns:

a CompletableFuture that completes successfully with the property 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 enabledState)

An asynchronous implementation of writeEnabledState(LocalizedText).

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.

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

Returns:

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

getQuality

org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode getQuality()
                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the Quality Node.

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

Returns:

the local value of the Quality Node.

Throws:

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

setQuality

void setQuality(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode quality)
         throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Quality Node.

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

Parameters:

quality - the local value to set for the Quality Node.

Throws:

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

readQuality

org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode readQuality()
                                                                throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the StatusCode value read from the server.

Throws:

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

writeQuality

void writeQuality(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode quality)
           throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

quality - the StatusCode value to write to the server.

Throws:

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

readQualityAsync

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

An asynchronous implementation of readQuality().

Returns:

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

writeQualityAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeQualityAsync(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode quality)

An asynchronous implementation of writeQuality(StatusCode).

Returns:

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

getQualityNode

ConditionVariableType getQualityNode()
                              throws org.eclipse.milo.opcua.stack.core.UaException

Get the Quality ConditionVariableType Node, or null if it does not exist.

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

Returns:

the Quality ConditionVariableType 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.

getQualityNodeAsync

CompletableFuture<? extends ConditionVariableType> getQualityNodeAsync()

Asynchronous implementation of getQualityNode().

Returns:

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

getLastSeverity

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getLastSeverity()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the LastSeverity Node.

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

Returns:

the local value of the LastSeverity Node.

Throws:

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

setLastSeverity

void setLastSeverity(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort lastSeverity)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the LastSeverity Node.

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

Parameters:

lastSeverity - the local value to set for the LastSeverity Node.

Throws:

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

readLastSeverity

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort readLastSeverity()
                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the UShort value read from the server.

Throws:

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

writeLastSeverity

void writeLastSeverity(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort lastSeverity)
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

lastSeverity - the UShort value to write to the server.

Throws:

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

readLastSeverityAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> readLastSeverityAsync()

An asynchronous implementation of readLastSeverity().

Returns:

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

writeLastSeverityAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLastSeverityAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort lastSeverity)

An asynchronous implementation of writeLastSeverity(UShort).

Returns:

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

getLastSeverityNode

ConditionVariableType getLastSeverityNode()
                                   throws org.eclipse.milo.opcua.stack.core.UaException

Get the LastSeverity ConditionVariableType Node, or null if it does not exist.

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

Returns:

the LastSeverity ConditionVariableType 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.

getLastSeverityNodeAsync

CompletableFuture<? extends ConditionVariableType> getLastSeverityNodeAsync()

Asynchronous implementation of getLastSeverityNode().

Returns:

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

getComment

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

Get the local value of the Comment Node.

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

Returns:

the local value of the Comment Node.

Throws:

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

setComment

void setComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText comment)
         throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Comment Node.

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

Parameters:

comment - the local value to set for the Comment Node.

Throws:

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

readComment

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

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

writeComment

void writeComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText comment)
           throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

comment - the LocalizedText value to write to the server.

Throws:

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

readCommentAsync

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

An asynchronous implementation of readComment().

Returns:

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

writeCommentAsync

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

An asynchronous implementation of writeComment(LocalizedText).

Returns:

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

getCommentNode

ConditionVariableType getCommentNode()
                              throws org.eclipse.milo.opcua.stack.core.UaException

Get the Comment ConditionVariableType Node, or null if it does not exist.

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

Returns:

the Comment ConditionVariableType 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.

getCommentNodeAsync

CompletableFuture<? extends ConditionVariableType> getCommentNodeAsync()

Asynchronous implementation of getCommentNode().

Returns:

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