|
FB-Name |
UA_EventItemAdd |
|||
|
This Function Block is used to add handles for events. |
||||
|
VAR_INPUT |
||||
|
B |
Execute |
BOOL |
FB performs its task on rising edge on this input. |
|
|
B |
SubscriptionHdl |
DWORD |
Subscription handle. |
|
|
B |
NodeHdl |
DWORD |
Handle of the node to monitor for emitted events. Events are only produced by the node classes Object and View. Whether a node is actually producing events or not may be determined by its EventNotifier attribute. |
|
|
B |
EventType |
UANodeID |
Type of the event to monitor. The EventType will be included as OfType operator in the Where Clause of the event monitored item filter. |
|
|
B |
EventFieldSelectionCount |
UINT |
Number of elements in EventFieldSelections |
|
|
B |
EventFieldSelections |
ARRAY OFUARelativePath |
Array of UARelativePath for the event fields to select. The path starts from the event type node. The FieldSelection is used as Select Clause of the event monitored item filter. Examples are 0: Message selects the Message event field 0: ActiveState/0: Id selects the Boolean representation of the Alarm ActiveState. Length is vendor-specific (MAX_EVENT_FIELD_SELECTIONS). See Constants of Array Lengths Hint: MaxSize is initialized by a predefined fixed size |
|
|
B |
Timeout |
TIME |
Time to response. |
|
|
VAR_OUTPUT |
||||
|
B |
Done |
BOOL |
FB has completed its task. |
|
|
B |
Busy |
BOOL |
The FB is not finished and new output values are to be expected. |
|
|
B |
Error |
BOOL |
Signals that an error has occurred within the FB. |
|
|
B |
ErrorID |
DWORD |
Error code |
|
|
B |
EventItemHdl |
DWORD |
Event Item Handle. The handle can be used to process the published events with UA_EventItemOperate and remove them from the subscription with UA_EventItemRemove. |
|
|
VAR_IN_OUT |
||||
|
B |
EventFields |
ARRAY OFVendor specific |
Vendor specific list of variables used to receive the events field data for one event occurrence. Vendor specific. |
|
|
B |
EventProcessed |
BOOL |
Indicates that the values of the event item have been changed. |
|
|
B |
RemainingEventCount |
UINT |
Number of remaining events available for processing |
|
|
B |
FieldErrorIDs |
ARRAY OF DWORD |
Contains an error code for each valid element of the EventFieldSelection array. Length is vendor-specific (MAX_EVENT_FIELD_SELECTIONS). See Constants of Array Lengths – including the “Overflow bit” indication. |
|
|
Notes: - |
||||
|
|
|
UA_EventItemAdd |
|
|
||
|
BOOL |
|
Execute |
|
Done |
|
BOOL |
|
DWORD |
|
SubscriptionHdl |
|
Busy |
|
BOOL |
|
ARRAY OF DWORD |
|
NodeHdl |
|
Error |
|
BOOL |
|
ARRAY OF UANodeId |
|
EventType |
|
ErrorID |
|
DWORD |
|
UINT |
|
EventFieldSelectionCount |
|
EventItemHdl |
|
DWORD |
|
ARRAY OF UARelativePath |
|
EventFieldSelection |
|
|
|
|
|
TIME |
|
Timeout |
|
|
|
|
|
|
|
|
|
|
|
|
|
ARRAY OF Vendor specific |
|
EventFields |
|
EventFields |
|
ARRAY OF Vendor specific |
|
BOOL |
|
EventProcessed |
|
EventProcessed |
|
BOOL |
|
UINT |
|
RemainingEventCount |
|
RemainingEventCount |
|
UINT |
|
ARRAY OF DWORD |
|
FieldErrorIDs |
|
FieldErrorIDs |
|
ARRAY OF DWORD |
|
|
|
|
|
|
|
|