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

Interface AlarmConditionType

All Superinterfaces:

AcknowledgeableConditionType, BaseEventType, BaseObjectType, ConditionType, Node, ObjectNode

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface AlarmConditionType
extends AcknowledgeableConditionType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	INPUT_NODE
static QualifiedProperty<Double>	MAX_TIME_SHELVED
static QualifiedProperty<Boolean>	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.LocalizedText	getActiveState() Get the local value of the ActiveState Node.
TwoStateVariableType	getActiveStateNode() Get the ActiveState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableType>	getActiveStateNodeAsync() Asynchronous implementation of getActiveStateNode().
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.NodeId	getInputNode() Get the local value of the InputNode Node.
PropertyType	getInputNodeNode() Get the InputNode PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getInputNodeNodeAsync() Asynchronous implementation of getInputNodeNode().
Double	getMaxTimeShelved() Get the local value of the MaxTimeShelved Node.
PropertyType	getMaxTimeShelvedNode() Get the MaxTimeShelved PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getMaxTimeShelvedNodeAsync() Asynchronous implementation of getMaxTimeShelvedNode().
ShelvedStateMachineType	getShelvingStateNode() Get the ShelvingState ShelvedStateMachineType Node, or null if it does not exist.
CompletableFuture<? extends ShelvedStateMachineType>	getShelvingStateNodeAsync() Asynchronous implementation of getShelvingStateNode().
Boolean	getSuppressedOrShelved() Get the local value of the SuppressedOrShelved Node.
PropertyType	getSuppressedOrShelvedNode() Get the SuppressedOrShelved PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getSuppressedOrShelvedNodeAsync() Asynchronous implementation of getSuppressedOrShelvedNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getSuppressedState() Get the local value of the SuppressedState Node.
TwoStateVariableType	getSuppressedStateNode() Get the SuppressedState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableType>	getSuppressedStateNodeAsync() Asynchronous implementation of getSuppressedStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readActiveState() Read the value of the ActiveState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readActiveStateAsync() An asynchronous implementation of readActiveState().
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.NodeId	readInputNode() Read the value of the InputNode Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readInputNodeAsync() An asynchronous implementation of readInputNode().
Double	readMaxTimeShelved() Read the value of the MaxTimeShelved Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readMaxTimeShelvedAsync() An asynchronous implementation of readMaxTimeShelved().
Boolean	readSuppressedOrShelved() Read the value of the SuppressedOrShelved Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readSuppressedOrShelvedAsync() An asynchronous implementation of readSuppressedOrShelved().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readSuppressedState() Read the value of the SuppressedState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readSuppressedStateAsync() An asynchronous implementation of readSuppressedState().
void	setActiveState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText activeState) Set the local value of the ActiveState Node.
void	setEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState) Set the local value of the EnabledState Node.
void	setInputNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode) Set the local value of the InputNode Node.
void	setMaxTimeShelved(Double maxTimeShelved) Set the local value of the MaxTimeShelved Node.
void	setSuppressedOrShelved(Boolean suppressedOrShelved) Set the local value of the SuppressedOrShelved Node.
void	setSuppressedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState) Set the local value of the SuppressedState Node.
void	writeActiveState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText activeState) Write a new value for the ActiveState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeActiveStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText activeState) An asynchronous implementation of writeActiveState(LocalizedText).
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	writeInputNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode) Write a new value for the InputNode Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeInputNodeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode) An asynchronous implementation of writeInputNode(NodeId).
void	writeMaxTimeShelved(Double maxTimeShelved) Write a new value for the MaxTimeShelved Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMaxTimeShelvedAsync(Double maxTimeShelved) An asynchronous implementation of writeMaxTimeShelved(Double).
void	writeSuppressedOrShelved(Boolean suppressedOrShelved) Write a new value for the SuppressedOrShelved Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSuppressedOrShelvedAsync(Boolean suppressedOrShelved) An asynchronous implementation of writeSuppressedOrShelved(Boolean).
void	writeSuppressedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState) Write a new value for the SuppressedState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSuppressedStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState) An asynchronous implementation of writeSuppressedState(LocalizedText).

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

INPUT_NODE

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

SUPPRESSED_OR_SHELVED

static final QualifiedProperty<Boolean> SUPPRESSED_OR_SHELVED

MAX_TIME_SHELVED

static final QualifiedProperty<Double> MAX_TIME_SHELVED

Method Detail

getInputNode

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

Get the local value of the InputNode Node.

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

Returns:

the local value of the InputNode Node.

Throws:

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

setInputNode

void setInputNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the InputNode Node.

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

Parameters:

inputNode - the local value to set for the InputNode Node.

Throws:

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

readInputNode

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

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

writeInputNode

void writeInputNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId inputNode)
             throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

inputNode - the NodeId value to write to the server.

Throws:

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

readInputNodeAsync

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

An asynchronous implementation of readInputNode().

Returns:

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

writeInputNodeAsync

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

An asynchronous implementation of writeInputNode(NodeId).

Returns:

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

getInputNodeNode

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

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

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

Returns:

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

getInputNodeNodeAsync

CompletableFuture<? extends PropertyType> getInputNodeNodeAsync()

Asynchronous implementation of getInputNodeNode().

Returns:

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

getSuppressedOrShelved

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

Get the local value of the SuppressedOrShelved Node.

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

Returns:

the local value of the SuppressedOrShelved Node.

Throws:

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

setSuppressedOrShelved

void setSuppressedOrShelved(Boolean suppressedOrShelved)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SuppressedOrShelved Node.

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

Parameters:

suppressedOrShelved - the local value to set for the SuppressedOrShelved Node.

Throws:

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

readSuppressedOrShelved

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

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

writeSuppressedOrShelved

void writeSuppressedOrShelved(Boolean suppressedOrShelved)
                       throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

suppressedOrShelved - the Boolean value to write to the server.

Throws:

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

readSuppressedOrShelvedAsync

CompletableFuture<? extends Boolean> readSuppressedOrShelvedAsync()

An asynchronous implementation of readSuppressedOrShelved().

Returns:

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

writeSuppressedOrShelvedAsync

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

An asynchronous implementation of writeSuppressedOrShelved(Boolean).

Returns:

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

getSuppressedOrShelvedNode

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

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

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

Returns:

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

getSuppressedOrShelvedNodeAsync

CompletableFuture<? extends PropertyType> getSuppressedOrShelvedNodeAsync()

Asynchronous implementation of getSuppressedOrShelvedNode().

Returns:

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

getMaxTimeShelved

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

Get the local value of the MaxTimeShelved Node.

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

Returns:

the local value of the MaxTimeShelved Node.

Throws:

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

setMaxTimeShelved

void setMaxTimeShelved(Double maxTimeShelved)
                throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the MaxTimeShelved Node.

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

Parameters:

maxTimeShelved - the local value to set for the MaxTimeShelved Node.

Throws:

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

readMaxTimeShelved

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

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

writeMaxTimeShelved

void writeMaxTimeShelved(Double maxTimeShelved)
                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

maxTimeShelved - the Double value to write to the server.

Throws:

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

readMaxTimeShelvedAsync

CompletableFuture<? extends Double> readMaxTimeShelvedAsync()

An asynchronous implementation of readMaxTimeShelved().

Returns:

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

writeMaxTimeShelvedAsync

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

An asynchronous implementation of writeMaxTimeShelved(Double).

Returns:

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

getMaxTimeShelvedNode

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

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

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

Returns:

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

getMaxTimeShelvedNodeAsync

CompletableFuture<? extends PropertyType> getMaxTimeShelvedNodeAsync()

Asynchronous implementation of getMaxTimeShelvedNode().

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.

Specified by:

getEnabledState in interface AcknowledgeableConditionType

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

Specified by:

setEnabledState in interface AcknowledgeableConditionType

Specified by:

setEnabledState in interface ConditionType

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.

Specified by:

readEnabledState in interface AcknowledgeableConditionType

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

Specified by:

writeEnabledState in interface AcknowledgeableConditionType

Specified by:

writeEnabledState in interface ConditionType

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

Specified by:

readEnabledStateAsync in interface AcknowledgeableConditionType

Specified by:

readEnabledStateAsync in interface ConditionType

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

Specified by:

writeEnabledStateAsync in interface AcknowledgeableConditionType

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 AcknowledgeableConditionType

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 AcknowledgeableConditionType

Specified by:

getEnabledStateNodeAsync in interface ConditionType

Returns:

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

getActiveState

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

Get the local value of the ActiveState Node.

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

Returns:

the local value of the ActiveState Node.

Throws:

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

setActiveState

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

Set the local value of the ActiveState Node.

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

Parameters:

activeState - the local value to set for the ActiveState Node.

Throws:

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

readActiveState

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

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

Returns:

the LocalizedText value read from the server.

Throws:

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

writeActiveState

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

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

Parameters:

activeState - the LocalizedText value to write to the server.

Throws:

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

readActiveStateAsync

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

An asynchronous implementation of readActiveState().

Returns:

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

writeActiveStateAsync

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

An asynchronous implementation of writeActiveState(LocalizedText).

Returns:

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

getActiveStateNode

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

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

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

Returns:

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

Throws:

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

getActiveStateNodeAsync

CompletableFuture<? extends TwoStateVariableType> getActiveStateNodeAsync()

Asynchronous implementation of getActiveStateNode().

Returns:

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

getSuppressedState

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

Get the local value of the SuppressedState Node.

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

Returns:

the local value of the SuppressedState Node.

Throws:

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

setSuppressedState

void setSuppressedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SuppressedState Node.

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

Parameters:

suppressedState - the local value to set for the SuppressedState Node.

Throws:

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

readSuppressedState

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

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

writeSuppressedState

void writeSuppressedState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText suppressedState)
                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

suppressedState - the LocalizedText value to write to the server.

Throws:

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

readSuppressedStateAsync

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

An asynchronous implementation of readSuppressedState().

Returns:

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

writeSuppressedStateAsync

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

An asynchronous implementation of writeSuppressedState(LocalizedText).

Returns:

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

getSuppressedStateNode

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

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

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

Returns:

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

getSuppressedStateNodeAsync

CompletableFuture<? extends TwoStateVariableType> getSuppressedStateNodeAsync()

Asynchronous implementation of getSuppressedStateNode().

Returns:

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

getShelvingStateNode

ShelvedStateMachineType getShelvingStateNode()
                                      throws org.eclipse.milo.opcua.stack.core.UaException

Get the ShelvingState ShelvedStateMachineType Node, or null if it does not exist.

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

Returns:

the ShelvingState ShelvedStateMachineType 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.

getShelvingStateNodeAsync

CompletableFuture<? extends ShelvedStateMachineType> getShelvingStateNodeAsync()

Asynchronous implementation of getShelvingStateNode().

Returns:

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