UA Server SDK C++ Bundle  1.4.0.258
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
EventItem Class Reference

Helper class for the EventManager interface implementation in EventManagerBase. More...

#include <eventmanagerhelper.h>

Public Member Functions

 EventItem (EventCallback *pEventCallback, EventManagerBase *pEventManagerBase, const UaNodeId &eventNotifier, Session *pSession)
 Constructs an event item object. More...
 
 ~EventItem ()
 Destroys the event item object.
 
UaStatus updateFilter (const OpcUa_EventFilter *pEventFilter, OpcUa_UInt32 eventManagerIndex, OpcUa_EventFilterResult *pEventFilterResult, OpcUa_Boolean &hasFilterError)
 Update the event filter. More...
 
OpcUa_Boolean applyFilter (UaEventData *pEventData)
 Applies the filter tree to the current event data.
 
void fireEvent (UaEventData *pEventData)
 Fire an event. More...
 
void fireRefreshEvent (const UaByteString &eventId, OpcUa_Boolean isStart)
 
void fireRefreshRequiredEvent (const UaByteString &eventId)
 

Public Attributes

EventCallbackm_pEventCallback
 Callback pointer for new Events.
 
EventFilter m_EventFilter
 Event filter used for the event item.
 
OpcUa_UInt32 m_hEventItem
 Handle of the event item.
 
OpcUa_UInt32 m_eventManagerIndex
 Index of the event manager used by the event receiver to identify the event manager.
 
bool m_isRefreshActive
 

Detailed Description

Helper class for the EventManager interface implementation in EventManagerBase.

This class is used to represent an event monitored item in the EventManagerBase.

Constructor & Destructor Documentation

EventItem::EventItem ( EventCallback pEventCallback,
EventManagerBase pEventManagerBase,
const UaNodeId eventNotifier,
Session pSession 
)

Constructs an event item object.

Parameters
[in]pEventCallbackCallback interface for the event monitored item
[in]pEventManagerBaseEventManagerBase interface
[in]eventNotifierNodeId of the event notifier for the event monitored item
[in]pSessionSession context for the event monitored item

Member Function Documentation

void EventItem::fireEvent ( UaEventData pEventData)

Fire an event.

Parameters
pEventDataEvent data that is used to apply the filter and to provide the requested event fields.
UaStatus EventItem::updateFilter ( const OpcUa_EventFilter *  pEventFilter,
OpcUa_UInt32  eventManagerIndex,
OpcUa_EventFilterResult *  pEventFilterResult,
OpcUa_Boolean &  hasFilterError 
)

Update the event filter.

Parameters
[in]pEventFilterEvent filter from the UA client for the event monitored item
[in]eventManagerIndexIndex of the event manager used by the event receiver to identify the event manager
[in,out]pEventFilterResultFilter result structure used to provide detailed filter errors to the client
[in,out]hasFilterErrorFlag indicating if one or more filter error results are set in the pEventFilterResult parameter

The documentation for this class was generated from the following files: