UaEventData Class Reference

UaEventData. More...

#include <uaeventdata.h>

Inherited by BaseEventTypeData.

Public Member Functions
	UaEventData ()
	construction
virtual	~UaEventData ()
	destruction
virtual void	getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)=0
	Get the field value for the passed index.
virtual UaNodeId	getConditionNodeId ()
	Returns the condition NodeId if the event data is related to a condition object.
virtual UaNodeId	getConditionBranchNodeId ()
	Returns the condition branch NodeId if the event data is related to a condition object.
virtual OpcUa_Boolean	getConditionRetain ()
	Returns the Retain flag if the event data is related to a condition object.
virtual void	lockEventData ()
	Lock the event data for data update and event handling.
virtual void	unlockEventData ()
	Unlock the event data after data update or event handling.
void	setEventUserData (OpcUa_Handle pEventUserData)
	Sets the user specific event data to the EventData object.
OpcUa_Handle	getEventUserData () const
	Returns the user specific event data.

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

Detailed Description

UaEventData.

Used for filed indices and data. It is not possible to create plane copies of this Class.

Member Function Documentation

virtual UaNodeId UaEventData::getConditionBranchNodeId ( )

inlinevirtual

Returns the condition branch NodeId if the event data is related to a condition object.

Returns a null NodeId if the event data is related to a simple event.

Reimplemented in OpcUa::ConditionType, and OpcUa::ConditionTypeData.

virtual UaNodeId UaEventData::getConditionNodeId ( )

inlinevirtual

Returns the condition NodeId if the event data is related to a condition object.

Returns a null NodeId if the event data is related to a simple event.

Reimplemented in OpcUa::ConditionType, and OpcUa::ConditionTypeData.

virtual OpcUa_Boolean UaEventData::getConditionRetain ( )

inlinevirtual

Returns the Retain flag if the event data is related to a condition object.

Returns a OpcUa_False if the event data is related to a simple event.

Reimplemented in OpcUa::ConditionType, and OpcUa::ConditionTypeData.

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

pure 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.

Implemented in OpcUa::ConditionTypeBase, OpcUa::DialogConditionTypeBase, OpcUa::AlarmConditionTypeBase, BaseEventTypeData, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::AcknowledgeableConditionTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::TripAlarmTypeBase, OpcUa::ConditionTypeData, OpcUa::GeneralModelChangeEventTypeData, OpcUa::DeviceFailureEventTypeData, OpcUa::ExclusiveLimitAlarmTypeData, OpcUa::AlarmConditionTypeData, OpcUa::DialogConditionTypeData, OpcUa::AcknowledgeableConditionTypeData, OpcUa::ExclusiveDeviationAlarmTypeData, OpcUa::LimitAlarmTypeData, OpcUa::NonExclusiveDeviationAlarmTypeData, OpcUa::NonExclusiveLimitAlarmTypeData, OpcUa::OffNormalAlarmTypeData, OpcUa::DiscreteAlarmTypeData, OpcUa::ExclusiveLevelAlarmTypeData, OpcUa::ExclusiveRateOfChangeAlarmTypeData, OpcUa::NonExclusiveLevelAlarmTypeData, OpcUa::NonExclusiveRateOfChangeAlarmTypeData, OpcUa::TripAlarmTypeData, OpcUa::BaseModelChangeEventTypeData, and OpcUa::SystemEventTypeData.

virtual void UaEventData::lockEventData ( )

inlinevirtual

Lock the event data for data update and event handling.

This method is used for event data objects maintaining a state for conditions since there may be concurrent access to the condition data by a condition update and a condition refresh triggered by a client. This method is also used during the event processing in the SDK. The method is implemented by condition related event data classes.

Reimplemented in OpcUa::ConditionTypeBase, and OpcUa::ConditionTypeData.

void UaEventData::setEventUserData

(

OpcUa_Handle

pEventUserData

)

Sets the user specific event data to the EventData object.

This data is not used by the SDK

virtual void UaEventData::unlockEventData ( )

inlinevirtual

Unlock the event data after data update or event handling.

This method is used for event data objects maintaining a state for conditions since there may be concurrent access to the condition data by a condition update and a condition refresh triggered by a client. This method is also used during the event processing in the SDK. The method is implemented by condition related event data classes.

Reimplemented in OpcUa::ConditionTypeBase, and OpcUa::ConditionTypeData.

---

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

• /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uaeventdata.h
• /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uaeventdata.cpp