EventBlock

<< Click to Display Table of Contents >>

 

EventBlock

Read-Only

 

B1

2 (two)

B2

Not used

B3

Not used

B4

Not used

Size

18

 

This Tag returns a block of data for each alarm or event received by this Driver.

Each reading of this Tag can return between 0 (zero) and N events. An application can access events individually by using an OnRead event. The Elements of this Block Tag are the following:

0 (Source, String): The name of the source of an event

1 (Message, String): A message describing an event

2 (EventType, String): The type of an event. Possible values are Simple, Tracking, or Condition

3 (EventCategory, String): The name of the category of an event

4 (ConditionName, String): The name of the condition related to an event

5 (SubconditionName, String): The name of the sub-condition related to an event

6 (IsAckRequired, Boolean): 1 (one) if an event requires acknowledgment or 0 (zero) if it does not require acknowledgment

7 (ActorID, String): The user that acknowledged an event

8 (Severity, Integer): The severity of an event, between 1 (one, the lowest) and 1000 (the highest)

9 (EventQuality, Integer): The OPC quality related to an event

10 (IsActive, Boolean): 1 (one) if a condition is active or 0 (zero) if it is inactive. Represents the bit 1 (one) of Element NewState

11 (IsEnabled, Boolean): 1 (one) if a condition is enabled or 0 (zero) if it is disabled. Represents the bit 0 (zero) of Element NewState

12 (IsAcked, Boolean): 1 (one) if a condition was acknowledged or 0 (zero) if it was not acknowledged. Represents the bit 2 (two) of Element NewState

13 (IsRefresh, Boolean): 1 (one) if a notification is sent as part of an event subscription's general interrogation or 0 (zero) otherwise

14 (EventTypeNum, Integer): Number value of the type of an event. Possible values are 1: Simple, 2: Tracking, or 4: Condition

15 (EventCategoryNum, Integer): Number value of the category of an event

16 (ChangeMask, Integer): A bit mask indicating which properties of a condition were changed:

Bit 0 (value 1): The IsActive property was changed

Bit 1 (value 2): The IsAcked property was changed

Bit 2 (value 4): The IsEnabled property was changed

Bit 3 (value 8): The EventQuality property was changed

Bit 4 (value 16): The Severity property was changed

Bit 5 (value 32): The SubconditionName property was changed

Bit 6 (value 64): The Message property was changed

Bit 7 (value 128): The attributes of a message were changed. This Driver currently does not return attributes

17 (NewState, Integer): A bit mask that indicates the new status of a condition. Notice that this mask is already returned separately in Elements IsActive (10), IsEnabled (11), and IsAcked (12):

Bit 0 (value 1): Element IsEnabled

Bit 1 (value 2): Element IsActive

Bit 2 (value 4): Element IsAcked

 

NOTE

Whenever this Driver establishes a connection to an OPC A&E server, it requests the current status of all messages. Alarms and events returned by this refresh command are identified by the Element 13, IsRefresh, equal to 1 (one).

Was this page useful?