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

UaMonitoredItemEvent. More...

#include <uamonitoreditem.h>

Inherits UaMonitoredItem, and EventCallback.

Public Member Functions

 UaMonitoredItemEvent (const UaNodeId &nodeId, const EventManagerArray &eventManagers, OpcUa_MonitoringMode MonitoringMode, OpcUa_Int32 ClientHandle, OpcUa_Double SamplingInterval, OpcUa_EventFilter *pEventFilter, UaSubscription *pUaSubscription)
 construction More...
 
 ~UaMonitoredItemEvent ()
 destruction
 
MonitoredItemType type () const
 Get the type of monitored item. More...
 
OpcUa_Boolean hasChanged ()
 Check if there are events available for the item. More...
 
void setMonitoringMode (OpcUa_MonitoringMode monitoringMode)
 Set the Monitoring Mode. More...
 
void setEventItemHandle (OpcUa_UInt32 eventItemHandle, OpcUa_UInt32 eventManagerIndex)
 Set the EventItem handle for an EventManager. More...
 
void getEventItemHandles (UaUInt32Array &eventItemHandles)
 Get the EventItem handles for the EventManagers. More...
 
void setEventManagerInvalid (OpcUa_UInt32 eventManagerIndex)
 Set EventManager invalid. More...
 
void getEventManagers (EventManagerArray &eventManagers)
 Get the related EventManagers. More...
 
OpcUa_UInt32 addEventManager (EventManager *pEventManager)
 Add an EventManager and return the event manager index. More...
 
OpcUa_UInt32 getEventCount ()
 Get the current event count from the monitored item.
 
void setEventFilter (OpcUa_EventFilter *pEventFilter)
 Set event filter of item. More...
 
virtual void reset ()
 Deletes all queued events and resets flags to the state of creation.
 
void newEvent (UaVariantArray &eventFields, OpcUa_Boolean detach)
 Send new event. More...
 
void invalidateEventManager (OpcUa_UInt32 eventManagerIndex)
 Invalidate the event manager in the monitored item.
 
- Public Member Functions inherited from UaMonitoredItem
 UaMonitoredItem (const UaNodeId &nodeId, OpcUa_MonitoringMode MonitoringMode, OpcUa_Int32 ClientHandle, OpcUa_Double SamplingInterval, UaSubscription *pUaSubscription)
 construction More...
 
virtual ~UaMonitoredItem ()
 destruction
 
void setClientHandle (OpcUa_Int32 clientHandle)
 Set the client handle of the monitored item. More...
 
OpcUa_Int32 clientHandle () const
 Get the client handle of the monitored item. More...
 
OpcUa_MonitoringMode monitoringMode () const
 Get the monitoring mode of the monitored item. More...
 
void setSamplingInterval (OpcUa_Double samplingInterval)
 Set the sampling rate of the monitored item. More...
 
OpcUa_Double samplingInterval () const
 Get the sampling rate of the monitored item. More...
 
UaNodeId nodeId () const
 NodeId of the node monitored with this item. More...
 
void setLinks (std::list< OpcUa_UInt32 > *pLinks)
 Sets the triggering links of the monitored item. More...
 
std::list< OpcUa_UInt32 > * links ()
 Returns the triggering links of the monitored item. More...
 
OpcUa_Boolean wasTriggered () const
 Check if the item triggered. More...
 
void resetTriggeredStatus ()
 Sets the triggered status of the monitored item to false.
 
OpcUa_TimestampsToReturn timestampsToReturn () const
 Timestamps to return with a datavalue.
 
void setTimestampsToReturn (OpcUa_TimestampsToReturn timestampsToReturn)
 Sets which timestamps shall be returned with a data value.
 
- Public Member Functions inherited from EventCallback
 EventCallback ()
 construction
 
virtual ~EventCallback ()
 destruction
 

Additional Inherited Members

- Public Types inherited from UaMonitoredItem
enum  MonitoredItemType { DATA, EVENT }
 MonitoredItem type enumeration. More...
 
- Protected Attributes inherited from UaMonitoredItem
UaSubscriptionm_pUaSubscription
 Parent subscription for the monitored item.
 

Detailed Description

UaMonitoredItemEvent.

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.

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.

Member Function Documentation

OpcUa_UInt32 UaMonitoredItemEvent::addEventManager ( EventManager pEventManager)

Add an EventManager and return the event manager index.

Returns
Event manager index
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
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::newEvent ( UaVariantArray &  eventFields,
OpcUa_Boolean  detach 
)
virtual

Send new event.

Parameters
eventFieldsa field of events.
detachIndicates if the event data contained in the eventFields can 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
inlinevirtual

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: