#include <uaeventdata.h>

Inherits UaEventData.

Inherited by OpcUa::BaseEventType, OpcUa::BaseModelChangeEventTypeData, OpcUa::ConditionTypeData, and OpcUa::SystemEventTypeData.

Public Member Functions
	BaseEventTypeData ()
	Constructs a BaseEventTypeData object.

virtual	~BaseEventTypeData ()
	Destroys the BaseEventTypeData object.

virtual void	initializeFromEventData (BaseEventTypeData *pEventData)

virtual void	getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
	Get the field value for the passed index. More...

virtual void	prepareNewEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &userEventId)
	Send event with current event field data to the subscribed clients After setting the changed states of the event this method is used to trigger the event notification that contains the snapshot of the new state of the condition. More...

virtual void	setSource (const UaNode *pNode)
	Set the SourceNode and SoruceName by passing in a node pointer for the source node.

virtual void	setSourceNode (const UaNodeId &sourceNode)
	Set the SourceNode event field.

virtual UaNodeId	getSourceNode () const
	Get the SourceNode event field.

virtual void	setSourceName (const UaString &sourceName)
	Set the SourceName event field.

virtual UaString	getSourceName () const
	Get the SourceName event field.

virtual void	setTime (const UaDateTime &time)
	Set the Time event field.

virtual UaDateTime	getTime () const
	Get the Time event field.

virtual void	setReceiveTime (const UaDateTime &receiveTime)
	Set the ReceiveTime event field.

virtual UaDateTime	getReceiveTime () const
	Get the ReceiveTime event field.

virtual void	setMessage (const UaLocalizedText &message)
	Set the Message event field.

virtual UaLocalizedText	getMessage () const
	Get the Message event field.

virtual void	getMessageValue (Session *pSession, UaVariant &data)
	Get the message field value. More...

virtual void	setSeverity (OpcUa_UInt16 severity)
	Set the Severity event field.

virtual OpcUa_UInt16	getSeverity () const
	Get the Severity event field.

Public Member Functions inherited from UaEventData
	UaEventData ()
	construction

virtual	~UaEventData ()
	destruction

virtual UaNodeId	getConditionNodeId ()
	Returns the condition NodeId if the event data is related to a condition object. More...

virtual UaNodeId	getConditionBranchNodeId ()
	Returns the condition branch NodeId if the event data is related to a condition object. More...

virtual OpcUa_Boolean	getConditionRetain ()
	Returns the Retain flag if the event data is related to a condition object. More...

virtual void	lockEventData ()
	Lock the event data for data update and event handling. More...

virtual void	unlockEventData ()
	Unlock the event data after data update or event handling. More...

void	setEventUserData (OpcUa_Handle pEventUserData)
	Sets the user specific event data to the EventData object. More...

OpcUa_Handle	getEventUserData () const
	Returns the user specific event data.

virtual ReferenceCounter *	getConditionDataReferenceCounter ()
	Get the ReferenceCounter interface necessary for condition event data classes.

Static Public Member Functions
static void	registerEventFields ()
	Registers all event type fields with the EventManagerBase.

Static Public Member Functions inherited from UaEventData
static void	registerEventFields ()
	Registers all event type fields with the EventManagerBase.

Public Attributes
UaVariant	m_EventId
	Field 01 - EventId.

UaNodeId	m_EventTypeId
	Field 02 - EventType.

UaVariant	m_SourceNode
	Field 03 - SourceNode.

UaVariant	m_SourceName
	Field 04 - SourceName.

UaVariant	m_Time
	Field 05 - Time.

UaVariant	m_ReceiveTime
	Field 06 - ReceiveTime.

UaVariant	m_LocalTime
	Field 07 - LocalTime.

UaVariant	m_Message
	Field 08 - Message.

UaVariant	m_Severity
	Field 09 - Severity.

Detailed Description

BaseEventTypeData.

Derived from UaEventData. It is not possible to create plane copies of this Class.

Member Function Documentation

void BaseEventTypeData::getFieldData	(	OpcUa_UInt32	index,
		Session *	pSession,
		OpcUa_Variant &	data
	)

virtual

Get the field value for the passed index.

Parameters

index	The index of the selected field.
pSession	The session context for the field access
data	The data for the selected field.

Implements UaEventData.

void BaseEventTypeData::getMessageValue	(	Session *	pSession,
		UaVariant &	data
	)

virtual

Get the message field value.

This method can be overwritten by a derived class to provide a language specific message text.

Parameters

pSession	The session context for the field access
data	The data for the message field.

void BaseEventTypeData::prepareNewEvent	(	const UaDateTime &	time,
		const UaDateTime &	receiveTime,
		const UaByteString &	userEventId
	)

virtual

Send event with current event field data to the subscribed clients After setting the changed states of the event this method is used to trigger the event notification that contains the snapshot of the new state of the condition.

Parameters

[in]	time	Time provides the time the Event occurred. This value is set as close to the event generator as possible. It often comes from the underlying system or device.
[in]	receiveTime	ReceiveTime provides the time the OPC UA Server received the Event from the underlying device or another Server.
[in]	userEventId	The server is responsible for generating a unique EventId for every event sent to the client. The SDK uses this parameter userEventId as part of the EventId but adds a unique part. The EventId is provided by the client in calls back to the server like in an alarm acknowledgment. The user specific part can be extracted from the EventId provided by the client by using EventManagerBase::getUserEventId()

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

D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uaeventdata.h
D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uaeventdata.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation