UaMonitoredItemEvent Class Reference

Implements a UA monitored item for events. Derived from UaMonitoredItem and EventCallback It is not possible to create plane copies of this class. It is not possible to use the default constructor. More...

#include <uamonitoreditem.h>

Inheritance diagram for UaMonitoredItemEvent:
Collaboration diagram for UaMonitoredItemEvent:

List of all members.

Public Member Functions

 UaMonitoredItemEvent (const UaNodeId &nodeId, const EventManagerArray &eventManagers, OpcUa_MonitoringMode MonitoringMode, OpcUa_Int32 ClientHandle, OpcUa_Double SamplingInterval, OpcUa_EventFilter *pEventFilter, UaSubscription *pUaSubscription)
 ~UaMonitoredItemEvent ()
MonitoredItemType type () const
OpcUa_Boolean hasChanged ()
void setMonitoringMode (OpcUa_MonitoringMode monitoringMode)
void setEventItemHandle (OpcUa_UInt32 eventItemHandle, OpcUa_UInt32 eventManagerIndex)
void getEventItemHandles (UaUInt32Array &eventItemHandles)
void setEventManagerInvalid (OpcUa_UInt32 eventManagerIndex)
void getEventManagers (EventManagerArray &eventManagers)
OpcUa_UInt32 addEventManager (EventManager *pEventManager)
OpcUa_UInt32 getEventCount ()
void getEvents (OpcUa_UInt32 &eventCount, EventFieldsArray &events)
void setEventFilter (OpcUa_EventFilter *pEventFilter)
void newEvent (UaVariantArray &eventFields, OpcUa_Boolean detach)
void invalidateEventManager (OpcUa_UInt32 eventManagerIndex)

Detailed Description

Implements a UA monitored item for events. Derived from UaMonitoredItem and EventCallback It is not possible to create plane copies of this class. It is not possible to use the default constructor.

UaMonitoredItemEvent


Constructor & Destructor Documentation

UaMonitoredItemEvent::UaMonitoredItemEvent ( const UaNodeId nodeId,
const EventManagerArray eventManagers,
OpcUa_MonitoringMode  MonitoringMode,
OpcUa_Int32  ClientHandle,
OpcUa_Double  SamplingInterval,
OpcUa_EventFilter *  pEventFilter,
UaSubscription pUaSubscription 
)

construction

Parameters:
nodeIdThe Id of the given Node.
eventManagersa list of EventManager interfaces for an event notifier
MonitoringModethe mode for monitoring items.
ClientHandlea handle to the client.
SamplingIntervalthe value in MS for a Interval of a Variable
pEventFilterthe new event filter the monitored item will attach.
pUaSubscriptionThe subscription of the given Node.
UaMonitoredItemEvent::~UaMonitoredItemEvent (  )

destruction


Member Function Documentation

OpcUa_UInt32 UaMonitoredItemEvent::addEventManager ( EventManager pEventManager )

Add an EventManager and return the event manager index.

Returns:
Event manager index
OpcUa_UInt32 UaMonitoredItemEvent::getEventCount (  )

Get the current event count from the monitored item.

void UaMonitoredItemEvent::getEventItemHandles ( UaUInt32Array &  eventItemHandles )

Get the EventItem handles for the EventManagers.

Parameters:
eventItemHandlesa handle to the event item.
void UaMonitoredItemEvent::getEventManagers ( EventManagerArray eventManagers )

Get the related EventManagers.

Parameters:
eventManagersa list of EventManager interfaces for an event notifier
void UaMonitoredItemEvent::getEvents ( OpcUa_UInt32 &  eventCount,
EventFieldsArray events 
)

Get Events from the monitored item.

Parameters:
eventCountthe counted events.
eventsa fieldlist of events that can occur.
OpcUa_Boolean UaMonitoredItemEvent::hasChanged (  ) [virtual]

Check if there are events available for the item.

Returns:
true if changed false if not.

Implements UaMonitoredItem.

void UaMonitoredItemEvent::invalidateEventManager ( OpcUa_UInt32  eventManagerIndex ) [virtual]

Invalidate the event manager in the monitored item.

Implements EventCallback.

void UaMonitoredItemEvent::newEvent ( UaVariantArray &  eventFields,
OpcUa_Boolean  detach 
) [virtual]

Send new event.

Parameters:
eventFieldsa field of events.
detachIndicates if the new Event will be detached or not

Implements EventCallback.

void UaMonitoredItemEvent::setEventFilter ( OpcUa_EventFilter *  pEventFilter )

Set event filter of item.

Parameters:
pEventFilterthe new event filter the monitored item will attach.
void UaMonitoredItemEvent::setEventItemHandle ( OpcUa_UInt32  eventItemHandle,
OpcUa_UInt32  eventManagerIndex 
)

Set the EventItem handle for an EventManager.

Parameters:
eventItemHandlea handle to the event item.
eventManagerIndexan Index of different EventManagers.
void UaMonitoredItemEvent::setEventManagerInvalid ( OpcUa_UInt32  eventManagerIndex )

Set EventManager invalid.

Parameters:
eventManagerIndexan Index of different EventManagers.
void UaMonitoredItemEvent::setMonitoringMode ( OpcUa_MonitoringMode  monitoringMode ) [virtual]

Set the Monitoring Mode

Parameters:
monitoringModethe Monitoring Mode

Reimplemented from UaMonitoredItem.

MonitoredItemType UaMonitoredItemEvent::type (  ) const [inline, virtual]

Get the type of monitored item

Returns:
the type of monitored item

Implements UaMonitoredItem.


The documentation for this class was generated from the following files:
  • /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/uamodule/uamonitoreditem.h
  • /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/uamodule/uamonitoreditem.cpp