com.digitalpetri.opcua.sdk.core.events

Interface BaseEventType

All Known Subinterfaces:

DeviceFailureEventType, SystemEventType, SystemStatusChangeEventType

All Known Implementing Classes:

BaseEvent, DeviceFailureEvent, SystemEvent, SystemStatusChangeEvent

public interface BaseEventType

Method Summary

Modifier and Type	Method and Description
com.digitalpetri.opcua.stack.core.types.builtin.ByteString	getEventId() An EventId is generated by the Server to uniquely identify a particular Event.
com.digitalpetri.opcua.stack.core.types.builtin.NodeId	getEventType()
Optional<com.digitalpetri.opcua.stack.core.types.structured.TimeZoneDataType>	getLocalTime() TimeZoneDataType is a structure containing the Offset and the DaylightSavingInOffset flag.
com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText	getMessage() A human-readable and localizable text description of the Event.
com.digitalpetri.opcua.stack.core.types.builtin.DataValue	getProperty(com.digitalpetri.opcua.stack.core.types.builtin.QualifiedName propertyName) Get the value of a property by name.
com.digitalpetri.opcua.stack.core.types.builtin.DateTime	getReceiveTime() Provides the time the OPC UA Server received the Event from the underlying device of another Server.
com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UShort	getSeverity() An indication of the urgency of the Event.
String	getSourceName() A description of the source of the Event.
com.digitalpetri.opcua.stack.core.types.builtin.NodeId	getSourceNode() The Node that the Event originated from.
com.digitalpetri.opcua.stack.core.types.builtin.DateTime	getTime() The time the Event occurred.

Method Detail

getEventId

com.digitalpetri.opcua.stack.core.types.builtin.ByteString getEventId()

An EventId is generated by the Server to uniquely identify a particular Event. The Server is responsible to ensure that each Event has its unique EventId.

Returns:

an ByteString that uniquely identifies this Event.

getEventType

com.digitalpetri.opcua.stack.core.types.builtin.NodeId getEventType()

Returns:

the NodeId of this type of Event.

getSourceNode

com.digitalpetri.opcua.stack.core.types.builtin.NodeId getSourceNode()

The Node that the Event originated from. If the Event is not specific to a Node the NodeId is set to null.

Returns:

the Node that the Event originated from.

getSourceName

String getSourceName()

A description of the source of the Event. This could be the DisplayName of the Event source, if the Event is specific to a Node, or some server-specific notation.

Returns:

a description of the source of the Event.

getTime

com.digitalpetri.opcua.stack.core.types.builtin.DateTime getTime()

The time the Event occurred. This value is set as close to the event generator as possible. It often comes from the underlying system or device.

Returns:

the time the Event occurred.

getReceiveTime

com.digitalpetri.opcua.stack.core.types.builtin.DateTime getReceiveTime()

Provides the time the OPC UA Server received the Event from the underlying device of another Server.

Returns:

the time the OPC UA Server received the Event from the underlying device of another Server.

getLocalTime

Optional<com.digitalpetri.opcua.stack.core.types.structured.TimeZoneDataType> getLocalTime()

TimeZoneDataType is a structure containing the Offset and the DaylightSavingInOffset flag. The Offset specifies the time difference (in minutes) between the Time Property and the time at the location in which the event was issued.

If DaylightSavingInOffset is TRUE, then Standard/Daylight savings time (DST) at the originating location is in effect and Offset includes the DST correction.

If FALSE then the Offset does not include DST correction and DST may or may not have been in effect.

Returns:

TimeZoneDataType, a structure containing the Offset and the DaylightSavingInOffset flag.

getMessage

com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText getMessage()

A human-readable and localizable text description of the Event. The Server may return any appropriate text to describe the Event. A null string is not a valid value; if the Server does not have a description, it shall return the string part of the BrowseName of the Node associated with the Event.

Returns:

a human-readable and localizable text description of the Event.

getSeverity

com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UShort getSeverity()

An indication of the urgency of the Event. This is also commonly called “priority”. Values will range from 1 to 1000, with 1 being the lowest severity and 1000 being the highest. Typically, a severity of 1 would indicate an Event which is informational in nature, while a value of 1000 would indicate an Event of catastrophic nature, which could potentially result in severe financial loss or loss of life.

Returns:

an indication of the urgency of the Event.

getProperty

com.digitalpetri.opcua.stack.core.types.builtin.DataValue getProperty(com.digitalpetri.opcua.stack.core.types.builtin.QualifiedName propertyName)

Get the value of a property by name.

Parameters:

propertyName - the QualifiedName of the property.

Returns:

the DataValue of the property indicated by propertyName.