C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
EventManagerUaNode Class Reference

Implements the EventManager interface for NodeManagerUaNode based node managers This class implements the EventManager interface for nodes managed by the SDK in a NodeManagerUaNode based node manager. More...

#include <eventmanageruanode.h>

Inherits EventManagerBase.

Inherited by NodeManagerBase.

Public Member Functions

 EventManagerUaNode ()
 Construction.
 
virtual ~EventManagerUaNode ()
 Destruction.
 
virtual UaStatus OnEnable (const ServiceContext &serviceContext, OpcUa::ConditionType *pCondition)
 Event handlers for Condition method Enable called from UA client. More...
 
virtual UaStatus OnDisable (const ServiceContext &serviceContext, OpcUa::ConditionType *pCondition)
 Event handlers for Condition method Disable called from UA client. More...
 
virtual UaStatus OnAddComment (const ServiceContext &serviceContext, OpcUa::ConditionType *pCondition, const UaByteString &EventId, const UaLocalizedText &Comment)
 Event handlers for Condition method AddComment called from UA client. More...
 
virtual UaStatus OnRespond (const ServiceContext &serviceContext, OpcUa::ConditionType *pCondition, OpcUa_UInt32 selectedResponse)
 Event handlers for DialogConditionType method Respond called from UA client. More...
 
virtual UaStatus OnAcknowledge (const ServiceContext &serviceContext, OpcUa::AcknowledgeableConditionType *pCondition, const UaByteString &EventId, const UaLocalizedText &Comment)
 Event handlers for AcknowledgeableConditionType method Acknowledge called from UA client. More...
 
virtual UaStatus OnConfirm (const ServiceContext &serviceContext, OpcUa::AcknowledgeableConditionType *pCondition, const UaByteString &EventId, const UaLocalizedText &Comment)
 Event handlers for AcknowledgeableConditionType method Confirm called from UA client. More...
 
virtual UaStatus OnOneShotShelve (const ServiceContext &serviceContext, OpcUa::AlarmConditionType *pCondition)
 Event handlers for AlarmConditionType method OneShotShelve called from UA client. More...
 
virtual UaStatus OnTimedShelve (const ServiceContext &serviceContext, OpcUa::AlarmConditionType *pCondition, OpcUa_Double ShelvingTime)
 Event handlers for AlarmConditionType method TimedShelve called from UA client. More...
 
virtual UaStatus OnUnshelve (const ServiceContext &serviceContext, OpcUa::AlarmConditionType *pCondition)
 Event handlers for AlarmConditionType method Unshelve called from UA client. More...
 
virtual UaStatus OnPlaceInService (const ServiceContext &serviceContext, OpcUa::AlarmConditionType *pCondition)
 Event handlers for AlarmConditionType method PlaceInService called from UA client. More...
 
virtual UaStatus OnRemoveFromService (const ServiceContext &serviceContext, OpcUa::AlarmConditionType *pCondition)
 Event handlers for AlarmConditionType method RemoveFromService called from UA client. More...
 
virtual UaStatus OnReset (const ServiceContext &serviceContext, OpcUa::AlarmConditionType *pCondition)
 Event handlers for AlarmConditionType method Reset called from UA client. More...
 
virtual UaStatus OnSilence (const ServiceContext &serviceContext, OpcUa::AlarmConditionType *pCondition)
 Event handlers for AlarmConditionType method Silence called from UA client. More...
 
virtual UaStatus OnSuppress (const ServiceContext &serviceContext, OpcUa::AlarmConditionType *pCondition)
 Event handlers for AlarmConditionType method Suppress called from UA client. More...
 
virtual UaStatus OnUnsuppress (const ServiceContext &serviceContext, OpcUa::AlarmConditionType *pCondition)
 Event handlers for AlarmConditionType method Unsuppress called from UA client. More...
 
- Public Member Functions inherited from EventManagerBase
 EventManagerBase ()
 Constructs an EventManagerBase object providing a base implementation of the EventManager interface. More...
 
virtual ~EventManagerBase ()
 Destroys the EventManagerBase object. More...
 
virtual void shutDownEM ()
 Shut down the event manager instance. More...
 
virtual void fireEvent (UaEventData *pEventData)
 Fire an event with the passed event data to interested clients. More...
 
virtual bool beforeSendEvent (UaEventData *pEventData, Session *pSession)
 Checks if the user is allowed to receive the event. More...
 
virtual void registerEventNotifier (const UaNodeId &parentNotifier, const UaNodeId &newNotifier)
 Add an event notifier to the event notifier tree. More...
 
virtual void registerEventSource (const UaNodeId &parentNotifier, const UaNodeId &newSource)
 Add an event source to the event notifier tree. More...
 
virtual void unregisterEventNotifier (const UaNodeId &notifier)
 Removes an event notifier and all of its notifier children and event sources from the event notifier tree. More...
 
virtual void unregisterEventSource (const UaNodeId &parentNotifier, const UaNodeId &eventSource)
 Removes an event source from the event notifier. More...
 
virtual OpcUa_Boolean isNotifier (const UaNodeId &eventNotifier) const
 Checks whether the passed NodeId is the NodeId of an event notifier object. More...
 
virtual OpcUa_Boolean isEventManagerRootNotifier (const UaNodeId &notifier) const
 Checks whether the passed NodeId is a root notifier for this EventManager. More...
 
virtual OpcUa_Boolean inNotifierTree (const UaNodeId &eventNotifier, const UaNodeId &sourceNode, UaEventData *pEventData) const
 Checks whether the passed sourceNode matches the event notifier or is part of the event notifier tree below the eventNotifier. More...
 
virtual UaStatus beginEventTransaction (EventManagerCallback *, const ServiceContext &, OpcUa_UInt32, OpcUa_UInt32, EventTransactionType, OpcUa_Handle &)
 Begins a transaction for modifying the list of event monitored items. More...
 
virtual UaStatus beginStartMonitoring (OpcUa_Handle, OpcUa_UInt32, OpcUa_UInt32, EventCallback *, const EventMonitoringContextCreate &)
 Start monitoring of an event notifier. More...
 
virtual UaStatus beginModifyMonitoring (OpcUa_Handle, OpcUa_UInt32, OpcUa_UInt32, OpcUa_UInt32, const EventMonitoringContext &)
 Notify EventManager about modifying monitoring parameters of an event notifier. More...
 
virtual UaStatus beginStopMonitoring (OpcUa_Handle hEventManagerContext, OpcUa_UInt32, OpcUa_UInt32, OpcUa_UInt32)
 Notify EventManager about stopping monitoring of an event notifier. More...
 
virtual UaStatus finishEventTransaction (OpcUa_Handle)
 Finishes the transaction for changing the list of event monitored items. More...
 
virtual UaStatus beginConditionRefresh (const ServiceContext &serviceContext, OpcUa_UInt32 hEventItem, const UaByteString &, const UaByteString &)
 This method triggers a refresh for all conditions of interest in the EventManager. More...
 
virtual UaStatus sendRefreshRequired (OpcUa_UInt32 hEventItem, const UaByteString &eventId)
 This method triggers a RefreshRequired event for the passed event item This event forces the clients to synchronize with the current Condition states by calling ConditionRefresh This method needs to be implemented in every EventManager that is part of a system that provides condition objects. More...
 
UaStatus sendRefreshRequired (const UaByteString &eventId)
 This method triggers a RefreshRequired event for all event items managed by the EventManager This event forces the clients to synchronize with the current Condition states by calling ConditionRefresh This method needs to be implemented in every EventManager that is part of a system that provides condition objects. More...
 
- Public Member Functions inherited from EventManager
 EventManager ()
 construction
 
virtual ~EventManager ()
 destruction
 

Additional Inherited Members

- Public Types inherited from EventManager
enum  EventTransactionType { MONITOR_BEGIN, MONITOR_MODIFY, MONITOR_STOP, INVALID }
 EventTransactionType enumeration. More...
 
- Static Public Member Functions inherited from EventManagerBase
static void buildEventId (const UaByteString &userEventId, UaByteString &clientEventId)
 Build a unique EventId that can be send to the client and include a user specific part if provided. More...
 
static void getUserEventId (const UaByteString &clientEventId, UaByteString &userEventId)
 Get the user part of a unique EventId that was sent to the client. More...
 
static void registerEventType (const UaNodeId &superType, const UaNodeId &newType)
 Adds a custom event type to the event type tree. More...
 
static OpcUa_UInt32 registerEventField (const UaQualifiedName &fieldName)
 Add a custom event field to assign a unique index for selection of the field of the custom type. More...
 
static OpcUa_UInt32 registerEventField (const UaQualifiedNameArray &path)
 Add a custom event field to assign a unique index for selection of the field of the custom type. More...
 
static OpcUa_UInt32 registerEventField (const UaString &fieldName)
 Add a custom event field to assign a unique index for selection of the field of the custom type. More...
 
static void unregisterEventType (const UaNodeId &typeToRemove)
 Removes a custom event type from the event type tree. More...
 
static void unregisterEventField (OpcUa_UInt32 fieldIndex)
 Removes a custom event field with the unique index assigned in EventManagerBase::registerEventField(). More...
 
static OpcUa_UInt32 getFieldIndex (const OpcUa_SimpleAttributeOperand &selectClause, OpcUa_StatusCode &fieldResult)
 Internal SDK method to get the index of a registered event field. More...
 
static OpcUa_Boolean isOfType (const UaNodeId &eventType, const UaNodeId &typeToEvaluate)
 Internal SDK method used to evaluate the event type with the event filter. More...
 
static void clearStaticMembers ()
 Internal SDK method to clean up static members. More...
 

Detailed Description

Implements the EventManager interface for NodeManagerUaNode based node managers This class implements the EventManager interface for nodes managed by the SDK in a NodeManagerUaNode based node manager.

It handles all active event monitored items and all event filtering and event field selection.

Member Function Documentation

UaStatus EventManagerUaNode::OnAcknowledge ( const ServiceContext serviceContext,
OpcUa::AcknowledgeableConditionType pCondition,
const UaByteString EventId,
const UaLocalizedText Comment 
)
virtual

Event handlers for AcknowledgeableConditionType method Acknowledge called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected acknowledgeable condition object
[in]EventIdThe EventId of the event the acknowledge is related to
[in]CommentThe comment provied by the client
UaStatus EventManagerUaNode::OnAddComment ( const ServiceContext serviceContext,
OpcUa::ConditionType pCondition,
const UaByteString EventId,
const UaLocalizedText Comment 
)
virtual

Event handlers for Condition method AddComment called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected condition object
[in]EventIdThe EventId of the event the comment is related to
[in]CommentThe comment provied by the client
UaStatus EventManagerUaNode::OnConfirm ( const ServiceContext serviceContext,
OpcUa::AcknowledgeableConditionType pCondition,
const UaByteString EventId,
const UaLocalizedText Comment 
)
virtual

Event handlers for AcknowledgeableConditionType method Confirm called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected acknowledgeable condition object
[in]EventIdThe EventId of the event the confirm is related to
[in]CommentThe comment provied by the client
UaStatus EventManagerUaNode::OnDisable ( const ServiceContext serviceContext,
OpcUa::ConditionType pCondition 
)
virtual

Event handlers for Condition method Disable called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected condition object
UaStatus EventManagerUaNode::OnEnable ( const ServiceContext serviceContext,
OpcUa::ConditionType pCondition 
)
virtual

Event handlers for Condition method Enable called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected condition object
UaStatus EventManagerUaNode::OnOneShotShelve ( const ServiceContext serviceContext,
OpcUa::AlarmConditionType pCondition 
)
virtual

Event handlers for AlarmConditionType method OneShotShelve called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected alarm condition object
UaStatus EventManagerUaNode::OnPlaceInService ( const ServiceContext serviceContext,
OpcUa::AlarmConditionType pCondition 
)
virtual

Event handlers for AlarmConditionType method PlaceInService called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected alarm condition object
UaStatus EventManagerUaNode::OnRemoveFromService ( const ServiceContext serviceContext,
OpcUa::AlarmConditionType pCondition 
)
virtual

Event handlers for AlarmConditionType method RemoveFromService called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected alarm condition object
UaStatus EventManagerUaNode::OnReset ( const ServiceContext serviceContext,
OpcUa::AlarmConditionType pCondition 
)
virtual

Event handlers for AlarmConditionType method Reset called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected alarm condition object
UaStatus EventManagerUaNode::OnRespond ( const ServiceContext serviceContext,
OpcUa::ConditionType pCondition,
OpcUa_UInt32  selectedResponse 
)
virtual

Event handlers for DialogConditionType method Respond called from UA client.

Returns
Status code.
UaStatus EventManagerUaNode::OnSilence ( const ServiceContext serviceContext,
OpcUa::AlarmConditionType pCondition 
)
virtual

Event handlers for AlarmConditionType method Silence called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected alarm condition object
UaStatus EventManagerUaNode::OnSuppress ( const ServiceContext serviceContext,
OpcUa::AlarmConditionType pCondition 
)
virtual

Event handlers for AlarmConditionType method Suppress called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected alarm condition object
UaStatus EventManagerUaNode::OnTimedShelve ( const ServiceContext serviceContext,
OpcUa::AlarmConditionType pCondition,
OpcUa_Double  ShelvingTime 
)
virtual

Event handlers for AlarmConditionType method TimedShelve called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected alarm condition object
[in]ShelvingTimeThe time interval used for the timed shelve
UaStatus EventManagerUaNode::OnUnshelve ( const ServiceContext serviceContext,
OpcUa::AlarmConditionType pCondition 
)
virtual

Event handlers for AlarmConditionType method Unshelve called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected alarm condition object
UaStatus EventManagerUaNode::OnUnsuppress ( const ServiceContext serviceContext,
OpcUa::AlarmConditionType pCondition 
)
virtual

Event handlers for AlarmConditionType method Unsuppress called from UA client.

Returns
Status code.
Parameters
[in]serviceContextThe client service context including the session object used for the call
[in]pConditionThe affected alarm condition object

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