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

Interface BaseEventType

All Superinterfaces:

BaseObjectType, Node, ObjectNode

All Known Subinterfaces:

AcknowledgeableConditionType, AlarmConditionType, AuditActivateSessionEventType, AuditAddNodesEventType, AuditAddReferencesEventType, AuditCancelEventType, AuditCertificateDataMismatchEventType, AuditCertificateEventType, AuditCertificateExpiredEventType, AuditCertificateInvalidEventType, AuditCertificateMismatchEventType, AuditCertificateRevokedEventType, AuditCertificateUntrustedEventType, AuditChannelEventType, AuditConditionAcknowledgeEventType, AuditConditionCommentEventType, AuditConditionConfirmEventType, AuditConditionEnableEventType, AuditConditionEventType, AuditConditionRespondEventType, AuditConditionShelvingEventType, AuditCreateSessionEventType, AuditDeleteNodesEventType, AuditDeleteReferencesEventType, AuditEventType, AuditHistoryAtTimeDeleteEventType, AuditHistoryDeleteEventType, AuditHistoryEventDeleteEventType, AuditHistoryEventUpdateEventType, AuditHistoryRawModifyDeleteEventType, AuditHistoryUpdateEventType, AuditHistoryValueUpdateEventType, AuditNodeManagementEventType, AuditOpenSecureChannelEventType, AuditProgramTransitionEventType, AuditSecurityEventType, AuditSessionEventType, AuditUpdateEventType, AuditUpdateMethodEventType, AuditUpdateStateEventType, AuditUrlMismatchEventType, AuditWriteUpdateEventType, BaseModelChangeEventType, CertificateExpirationAlarmType, CertificateUpdatedAuditEventType, ConditionType, DeviceFailureEventType, DialogConditionType, DiscreteAlarmType, EventQueueOverflowEventType, ExclusiveDeviationAlarmType, ExclusiveLevelAlarmType, ExclusiveLimitAlarmType, ExclusiveRateOfChangeAlarmType, GeneralModelChangeEventType, LimitAlarmType, NonExclusiveDeviationAlarmType, NonExclusiveLevelAlarmType, NonExclusiveLimitAlarmType, NonExclusiveRateOfChangeAlarmType, OffNormalAlarmType, ProgramTransitionAuditEventType, ProgramTransitionEventType, ProgressEventType, RefreshEndEventType, RefreshRequiredEventType, RefreshStartEventType, SemanticChangeEventType, SystemEventType, SystemOffNormalAlarmType, SystemStatusChangeEventType, TransitionEventType, TripAlarmType, TrustListUpdatedAuditEventType

All Known Implementing Classes:

AcknowledgeableConditionTypeNode, AlarmConditionTypeNode, AuditActivateSessionEventTypeNode, AuditAddNodesEventTypeNode, AuditAddReferencesEventTypeNode, AuditCancelEventTypeNode, AuditCertificateDataMismatchEventTypeNode, AuditCertificateEventTypeNode, AuditCertificateExpiredEventTypeNode, AuditCertificateInvalidEventTypeNode, AuditCertificateMismatchEventTypeNode, AuditCertificateRevokedEventTypeNode, AuditCertificateUntrustedEventTypeNode, AuditChannelEventTypeNode, AuditConditionAcknowledgeEventTypeNode, AuditConditionCommentEventTypeNode, AuditConditionConfirmEventTypeNode, AuditConditionEnableEventTypeNode, AuditConditionEventTypeNode, AuditConditionRespondEventTypeNode, AuditConditionShelvingEventTypeNode, AuditCreateSessionEventTypeNode, AuditDeleteNodesEventTypeNode, AuditDeleteReferencesEventTypeNode, AuditEventTypeNode, AuditHistoryAtTimeDeleteEventTypeNode, AuditHistoryDeleteEventTypeNode, AuditHistoryEventDeleteEventTypeNode, AuditHistoryEventUpdateEventTypeNode, AuditHistoryRawModifyDeleteEventTypeNode, AuditHistoryUpdateEventTypeNode, AuditHistoryValueUpdateEventTypeNode, AuditNodeManagementEventTypeNode, AuditOpenSecureChannelEventTypeNode, AuditProgramTransitionEventTypeNode, AuditSecurityEventTypeNode, AuditSessionEventTypeNode, AuditUpdateEventTypeNode, AuditUpdateMethodEventTypeNode, AuditUpdateStateEventTypeNode, AuditUrlMismatchEventTypeNode, AuditWriteUpdateEventTypeNode, BaseEventTypeNode, BaseModelChangeEventTypeNode, CertificateExpirationAlarmTypeNode, CertificateUpdatedAuditEventTypeNode, ConditionTypeNode, DeviceFailureEventTypeNode, DialogConditionTypeNode, DiscreteAlarmTypeNode, EventQueueOverflowEventTypeNode, ExclusiveDeviationAlarmTypeNode, ExclusiveLevelAlarmTypeNode, ExclusiveLimitAlarmTypeNode, ExclusiveRateOfChangeAlarmTypeNode, GeneralModelChangeEventTypeNode, LimitAlarmTypeNode, NonExclusiveDeviationAlarmTypeNode, NonExclusiveLevelAlarmTypeNode, NonExclusiveLimitAlarmTypeNode, NonExclusiveRateOfChangeAlarmTypeNode, OffNormalAlarmTypeNode, ProgramTransitionAuditEventTypeNode, ProgramTransitionEventTypeNode, ProgressEventTypeNode, RefreshEndEventTypeNode, RefreshRequiredEventTypeNode, RefreshStartEventTypeNode, SemanticChangeEventTypeNode, SystemEventTypeNode, SystemOffNormalAlarmTypeNode, SystemStatusChangeEventTypeNode, TransitionEventTypeNode, TripAlarmTypeNode, TrustListUpdatedAuditEventTypeNode

public interface BaseEventType
extends BaseObjectType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>	EVENT_ID
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	EVENT_TYPE
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType>	LOCAL_TIME
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	MESSAGE
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	RECEIVE_TIME
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort>	SEVERITY
static QualifiedProperty<String>	SOURCE_NAME
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	SOURCE_NODE
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	TIME

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.builtin.ByteString	getEventId() Get the local value of the EventId Node.
PropertyType	getEventIdNode() Get the EventId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getEventIdNodeAsync() Asynchronous implementation of getEventIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getEventType() Get the local value of the EventType Node.
PropertyType	getEventTypeNode() Get the EventType PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getEventTypeNodeAsync() Asynchronous implementation of getEventTypeNode().
org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType	getLocalTime() Get the local value of the LocalTime Node.
PropertyType	getLocalTimeNode() Get the LocalTime PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getLocalTimeNodeAsync() Asynchronous implementation of getLocalTimeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getMessage() Get the local value of the Message Node.
PropertyType	getMessageNode() Get the Message PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getMessageNodeAsync() Asynchronous implementation of getMessageNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	getReceiveTime() Get the local value of the ReceiveTime Node.
PropertyType	getReceiveTimeNode() Get the ReceiveTime PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getReceiveTimeNodeAsync() Asynchronous implementation of getReceiveTimeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	getSeverity() Get the local value of the Severity Node.
PropertyType	getSeverityNode() Get the Severity PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getSeverityNodeAsync() Asynchronous implementation of getSeverityNode().
String	getSourceName() Get the local value of the SourceName Node.
PropertyType	getSourceNameNode() Get the SourceName PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getSourceNameNodeAsync() Asynchronous implementation of getSourceNameNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getSourceNode() Get the local value of the SourceNode Node.
PropertyType	getSourceNodeNode() Get the SourceNode PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getSourceNodeNodeAsync() Asynchronous implementation of getSourceNodeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	getTime() Get the local value of the Time Node.
PropertyType	getTimeNode() Get the Time PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getTimeNodeAsync() Asynchronous implementation of getTimeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.ByteString	readEventId() Read the value of the EventId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>	readEventIdAsync() An asynchronous implementation of readEventId().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readEventType() Read the value of the EventType Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readEventTypeAsync() An asynchronous implementation of readEventType().
org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType	readLocalTime() Read the value of the LocalTime Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType>	readLocalTimeAsync() An asynchronous implementation of readLocalTime().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readMessage() Read the value of the Message Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readMessageAsync() An asynchronous implementation of readMessage().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	readReceiveTime() Read the value of the ReceiveTime Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	readReceiveTimeAsync() An asynchronous implementation of readReceiveTime().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	readSeverity() Read the value of the Severity 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>	readSeverityAsync() An asynchronous implementation of readSeverity().
String	readSourceName() Read the value of the SourceName Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readSourceNameAsync() An asynchronous implementation of readSourceName().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readSourceNode() Read the value of the SourceNode Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readSourceNodeAsync() An asynchronous implementation of readSourceNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	readTime() Read the value of the Time Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	readTimeAsync() An asynchronous implementation of readTime().
void	setEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString eventId) Set the local value of the EventId Node.
void	setEventType(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId eventType) Set the local value of the EventType Node.
void	setLocalTime(org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType localTime) Set the local value of the LocalTime Node.
void	setMessage(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText message) Set the local value of the Message Node.
void	setReceiveTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime receiveTime) Set the local value of the ReceiveTime Node.
void	setSeverity(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort severity) Set the local value of the Severity Node.
void	setSourceName(String sourceName) Set the local value of the SourceName Node.
void	setSourceNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sourceNode) Set the local value of the SourceNode Node.
void	setTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime time) Set the local value of the Time Node.
void	writeEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString eventId) Write a new value for the EventId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEventIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString eventId) An asynchronous implementation of writeEventId(ByteString).
void	writeEventType(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId eventType) Write a new value for the EventType Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEventTypeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId eventType) An asynchronous implementation of writeEventType(NodeId).
void	writeLocalTime(org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType localTime) Write a new value for the LocalTime Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLocalTimeAsync(org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType localTime) An asynchronous implementation of writeLocalTime(TimeZoneDataType).
void	writeMessage(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText message) Write a new value for the Message Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMessageAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText message) An asynchronous implementation of writeMessage(LocalizedText).
void	writeReceiveTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime receiveTime) Write a new value for the ReceiveTime Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeReceiveTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime receiveTime) An asynchronous implementation of writeReceiveTime(DateTime).
void	writeSeverity(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort severity) Write a new value for the Severity Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSeverityAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort severity) An asynchronous implementation of writeSeverity(UShort).
void	writeSourceName(String sourceName) Write a new value for the SourceName Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSourceNameAsync(String sourceName) An asynchronous implementation of writeSourceName(String).
void	writeSourceNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sourceNode) Write a new value for the SourceNode Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSourceNodeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sourceNode) An asynchronous implementation of writeSourceNode(NodeId).
void	writeTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime time) Write a new value for the Time Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime time) An asynchronous implementation of writeTime(DateTime).

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

EVENT_ID

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> EVENT_ID

EVENT_TYPE

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

SOURCE_NODE

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

SOURCE_NAME

static final QualifiedProperty<String> SOURCE_NAME

TIME

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> TIME

RECEIVE_TIME

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> RECEIVE_TIME

LOCAL_TIME

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType> LOCAL_TIME

MESSAGE

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

SEVERITY

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> SEVERITY

Method Detail

getEventId

org.eclipse.milo.opcua.stack.core.types.builtin.ByteString getEventId()
                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the EventId Node.

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

Returns:

the local value of the EventId Node.

Throws:

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

setEventId

void setEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString eventId)
         throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the EventId Node.

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

Parameters:

eventId - the local value to set for the EventId Node.

Throws:

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

readEventId

org.eclipse.milo.opcua.stack.core.types.builtin.ByteString readEventId()
                                                                throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the ByteString value read from the server.

Throws:

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

writeEventId

void writeEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString eventId)
           throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

eventId - the ByteString value to write to the server.

Throws:

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

readEventIdAsync

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

An asynchronous implementation of readEventId().

Returns:

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

writeEventIdAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEventIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString eventId)

An asynchronous implementation of writeEventId(ByteString).

Returns:

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

getEventIdNode

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

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

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

Returns:

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

getEventIdNodeAsync

CompletableFuture<? extends PropertyType> getEventIdNodeAsync()

Asynchronous implementation of getEventIdNode().

Returns:

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

getEventType

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

Get the local value of the EventType Node.

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

Returns:

the local value of the EventType Node.

Throws:

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

setEventType

void setEventType(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId eventType)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the EventType Node.

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

Parameters:

eventType - the local value to set for the EventType Node.

Throws:

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

readEventType

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

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

writeEventType

void writeEventType(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId eventType)
             throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

eventType - the NodeId value to write to the server.

Throws:

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

readEventTypeAsync

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

An asynchronous implementation of readEventType().

Returns:

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

writeEventTypeAsync

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

An asynchronous implementation of writeEventType(NodeId).

Returns:

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

getEventTypeNode

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

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

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

Returns:

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

getEventTypeNodeAsync

CompletableFuture<? extends PropertyType> getEventTypeNodeAsync()

Asynchronous implementation of getEventTypeNode().

Returns:

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

getSourceNode

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

Get the local value of the SourceNode Node.

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

Returns:

the local value of the SourceNode Node.

Throws:

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

setSourceNode

void setSourceNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sourceNode)
            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SourceNode Node.

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

Parameters:

sourceNode - the local value to set for the SourceNode Node.

Throws:

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

readSourceNode

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

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

writeSourceNode

void writeSourceNode(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sourceNode)
              throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

sourceNode - the NodeId value to write to the server.

Throws:

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

readSourceNodeAsync

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

An asynchronous implementation of readSourceNode().

Returns:

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

writeSourceNodeAsync

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

An asynchronous implementation of writeSourceNode(NodeId).

Returns:

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

getSourceNodeNode

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

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

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

Returns:

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

getSourceNodeNodeAsync

CompletableFuture<? extends PropertyType> getSourceNodeNodeAsync()

Asynchronous implementation of getSourceNodeNode().

Returns:

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

getSourceName

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

Get the local value of the SourceName Node.

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

Returns:

the local value of the SourceName Node.

Throws:

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

setSourceName

void setSourceName(String sourceName)
            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SourceName Node.

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

Parameters:

sourceName - the local value to set for the SourceName Node.

Throws:

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

readSourceName

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

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

writeSourceName

void writeSourceName(String sourceName)
              throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

sourceName - the String value to write to the server.

Throws:

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

readSourceNameAsync

CompletableFuture<? extends String> readSourceNameAsync()

An asynchronous implementation of readSourceName().

Returns:

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

writeSourceNameAsync

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

An asynchronous implementation of writeSourceName(String).

Returns:

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

getSourceNameNode

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

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

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

Returns:

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

getSourceNameNodeAsync

CompletableFuture<? extends PropertyType> getSourceNameNodeAsync()

Asynchronous implementation of getSourceNameNode().

Returns:

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

getTime

org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getTime()
                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the Time Node.

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

Returns:

the local value of the Time Node.

Throws:

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

setTime

void setTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime time)
      throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Time Node.

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

Parameters:

time - the local value to set for the Time Node.

Throws:

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

readTime

org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readTime()
                                                           throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the DateTime value read from the server.

Throws:

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

writeTime

void writeTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime time)
        throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

time - the DateTime value to write to the server.

Throws:

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

readTimeAsync

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

An asynchronous implementation of readTime().

Returns:

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

writeTimeAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime time)

An asynchronous implementation of writeTime(DateTime).

Returns:

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

getTimeNode

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

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

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

Returns:

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

getTimeNodeAsync

CompletableFuture<? extends PropertyType> getTimeNodeAsync()

Asynchronous implementation of getTimeNode().

Returns:

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

getReceiveTime

org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getReceiveTime()
                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ReceiveTime Node.

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

Returns:

the local value of the ReceiveTime Node.

Throws:

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

setReceiveTime

void setReceiveTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime receiveTime)
             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ReceiveTime Node.

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

Parameters:

receiveTime - the local value to set for the ReceiveTime Node.

Throws:

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

readReceiveTime

org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readReceiveTime()
                                                                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the DateTime value read from the server.

Throws:

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

writeReceiveTime

void writeReceiveTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime receiveTime)
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

receiveTime - the DateTime value to write to the server.

Throws:

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

readReceiveTimeAsync

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

An asynchronous implementation of readReceiveTime().

Returns:

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

writeReceiveTimeAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeReceiveTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime receiveTime)

An asynchronous implementation of writeReceiveTime(DateTime).

Returns:

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

getReceiveTimeNode

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

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

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

Returns:

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

getReceiveTimeNodeAsync

CompletableFuture<? extends PropertyType> getReceiveTimeNodeAsync()

Asynchronous implementation of getReceiveTimeNode().

Returns:

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

getLocalTime

org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType getLocalTime()
                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the LocalTime Node.

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

Returns:

the local value of the LocalTime Node.

Throws:

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

setLocalTime

void setLocalTime(org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType localTime)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the LocalTime Node.

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

Parameters:

localTime - the local value to set for the LocalTime Node.

Throws:

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

readLocalTime

org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType readLocalTime()
                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the TimeZoneDataType value read from the server.

Throws:

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

writeLocalTime

void writeLocalTime(org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType localTime)
             throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

localTime - the TimeZoneDataType value to write to the server.

Throws:

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

readLocalTimeAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType> readLocalTimeAsync()

An asynchronous implementation of readLocalTime().

Returns:

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

writeLocalTimeAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLocalTimeAsync(org.eclipse.milo.opcua.stack.core.types.structured.TimeZoneDataType localTime)

An asynchronous implementation of writeLocalTime(TimeZoneDataType).

Returns:

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

getLocalTimeNode

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

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

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

Returns:

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

getLocalTimeNodeAsync

CompletableFuture<? extends PropertyType> getLocalTimeNodeAsync()

Asynchronous implementation of getLocalTimeNode().

Returns:

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

getMessage

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

Get the local value of the Message Node.

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

Returns:

the local value of the Message Node.

Throws:

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

setMessage

void setMessage(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText message)
         throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Message Node.

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

Parameters:

message - the local value to set for the Message Node.

Throws:

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

readMessage

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

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

writeMessage

void writeMessage(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText message)
           throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

message - the LocalizedText value to write to the server.

Throws:

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

readMessageAsync

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

An asynchronous implementation of readMessage().

Returns:

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

writeMessageAsync

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

An asynchronous implementation of writeMessage(LocalizedText).

Returns:

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

getMessageNode

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

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

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

Returns:

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

getMessageNodeAsync

CompletableFuture<? extends PropertyType> getMessageNodeAsync()

Asynchronous implementation of getMessageNode().

Returns:

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

getSeverity

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

Get the local value of the Severity Node.

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

Returns:

the local value of the Severity Node.

Throws:

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

setSeverity

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

Set the local value of the Severity Node.

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

Parameters:

severity - the local value to set for the Severity Node.

Throws:

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

readSeverity

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

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

writeSeverity

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

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

Parameters:

severity - the UShort value to write to the server.

Throws:

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

readSeverityAsync

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

An asynchronous implementation of readSeverity().

Returns:

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

writeSeverityAsync

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

An asynchronous implementation of writeSeverity(UShort).

Returns:

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

getSeverityNode

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

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

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

Returns:

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

getSeverityNodeAsync

CompletableFuture<? extends PropertyType> getSeverityNodeAsync()

Asynchronous implementation of getSeverityNode().

Returns:

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