com.digitalpetri.opcua.sdk.server.events

Class BaseEvent

java.lang.Object

com.digitalpetri.opcua.sdk.server.events.BaseEvent

All Implemented Interfaces:

BaseEventType

Direct Known Subclasses:

SystemEvent

public class BaseEvent
extends Object
implements BaseEventType

The BaseEventType defines all general characteristics of an Event. All other EventTypes derive from it.

There is no other semantic associated with this type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseEvent.BaseEventBuilder

Constructor Summary

Constructors

Constructor and Description

BaseEvent(com.digitalpetri.opcua.stack.core.types.builtin.ByteString eventId, com.digitalpetri.opcua.stack.core.types.builtin.NodeId eventType, com.digitalpetri.opcua.stack.core.types.builtin.NodeId sourceNode, String sourceName, com.digitalpetri.opcua.stack.core.types.builtin.DateTime time, com.digitalpetri.opcua.stack.core.types.builtin.DateTime receiveTime, Optional<com.digitalpetri.opcua.stack.core.types.structured.TimeZoneDataType> localTime, com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText message, com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UShort severity)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseEvent

public BaseEvent(com.digitalpetri.opcua.stack.core.types.builtin.ByteString eventId,
                 com.digitalpetri.opcua.stack.core.types.builtin.NodeId eventType,
                 com.digitalpetri.opcua.stack.core.types.builtin.NodeId sourceNode,
                 String sourceName,
                 com.digitalpetri.opcua.stack.core.types.builtin.DateTime time,
                 com.digitalpetri.opcua.stack.core.types.builtin.DateTime receiveTime,
                 Optional<com.digitalpetri.opcua.stack.core.types.structured.TimeZoneDataType> localTime,
                 com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText message,
                 com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UShort severity)

Method Detail

getEventId

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

Description copied from interface: BaseEventType

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.

Specified by:

getEventId in interface BaseEventType

Returns:

an ByteString that uniquely identifies this Event.

getEventType

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

Specified by:

getEventType in interface BaseEventType

Returns:

the NodeId of this type of Event.

getSourceNode

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

Description copied from interface: BaseEventType

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

Specified by:

getSourceNode in interface BaseEventType

Returns:

the Node that the Event originated from.

getSourceName

public String getSourceName()

Description copied from interface: BaseEventType

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.

Specified by:

getSourceName in interface BaseEventType

Returns:

a description of the source of the Event.

getTime

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

Description copied from interface: BaseEventType

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.

Specified by:

getTime in interface BaseEventType

Returns:

the time the Event occurred.

getReceiveTime

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

Description copied from interface: BaseEventType

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

Specified by:

getReceiveTime in interface BaseEventType

Returns:

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

getLocalTime

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

Description copied from interface: BaseEventType

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.

Specified by:

getLocalTime in interface BaseEventType

Returns:

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

getMessage

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

Description copied from interface: BaseEventType

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.

Specified by:

getMessage in interface BaseEventType

Returns:

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

getSeverity

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

Description copied from interface: BaseEventType

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.

Specified by:

getSeverity in interface BaseEventType

Returns:

an indication of the urgency of the Event.

getProperty

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

Description copied from interface: BaseEventType

Get the value of a property by name.

Specified by:

getProperty in interface BaseEventType

Parameters:

propertyName - the QualifiedName of the property.

Returns:

the DataValue of the property indicated by propertyName.