Derived from UaEventData. It is not possible to create plane copies of this Class. More...
#include <uaeventdata.h>
Public Member Functions | |
BaseEventTypeData () | |
virtual | ~BaseEventTypeData () |
virtual void | getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
virtual void | prepareNewEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &userEventId) |
virtual void | setSource (const UaNode *pNode) |
virtual void | setSourceNode (const UaNodeId &sourceNode) |
virtual UaNodeId | getSourceNode () |
virtual void | setSourceName (const UaString &sourceName) |
virtual UaString | getSourceName () |
virtual void | setTime (const UaDateTime &time) |
virtual UaDateTime | getTime () |
virtual void | setReceiveTime (const UaDateTime &receiveTime) |
virtual UaDateTime | getReceiveTime () |
virtual void | setMessage (const UaLocalizedText &message) |
virtual UaLocalizedText | getMessage () |
virtual void | getMessageValue (Session *pSession, UaVariant &data) |
virtual void | setSeverity (OpcUa_UInt16 severity) |
virtual OpcUa_UInt16 | getSeverity () |
Static Public Member Functions | |
static void | registerEventFields () |
Public Attributes | |
UaVariant | m_EventId |
UaNodeId | m_EventTypeId |
UaVariant | m_SourceNode |
UaVariant | m_SourceName |
UaVariant | m_Time |
UaVariant | m_ReceiveTime |
UaVariant | m_LocalTime |
UaVariant | m_Message |
UaVariant | m_Severity |
Derived from UaEventData. It is not possible to create plane copies of this Class.
BaseEventTypeData::BaseEventTypeData | ( | ) |
Constructs a BaseEventTypeData object
BaseEventTypeData::~BaseEventTypeData | ( | ) | [virtual] |
Destroys the BaseEventTypeData object
void BaseEventTypeData::getFieldData | ( | OpcUa_UInt32 | index, |
Session * | pSession, | ||
OpcUa_Variant & | data | ||
) | [virtual] |
Get the field value for the passed index.
index | The index of the selected field. |
pSession | The session context for the field access |
data | The data for the selected field. |
Implements UaEventData.
Reimplemented in OpcUa::AcknowledgeableConditionTypeData, OpcUa::AcknowledgeableConditionTypeBase, OpcUa::AlarmConditionTypeData, OpcUa::AlarmConditionTypeBase, OpcUa::ConditionTypeData, OpcUa::ConditionTypeBase, OpcUa::DialogConditionTypeData, OpcUa::DialogConditionTypeBase, OpcUa::DiscreteAlarmTypeData, OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeData, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeData, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeData, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeData, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::LimitAlarmTypeData, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeData, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeData, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveLimitAlarmTypeData, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeData, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::OffNormalAlarmTypeData, OpcUa::OffNormalAlarmTypeBase, OpcUa::SystemEventTypeData, OpcUa::DeviceFailureEventTypeData, OpcUa::TripAlarmTypeData, and OpcUa::TripAlarmTypeBase.
UaLocalizedText BaseEventTypeData::getMessage | ( | ) | [virtual] |
Get the Message event field
Get the message field value. This method can be overwritten by a derived class to provide a language specific message text.
pSession | The session context for the field access |
data | The data for the message field. |
UaDateTime BaseEventTypeData::getReceiveTime | ( | ) | [virtual] |
Get the ReceiveTime event field
OpcUa_UInt16 BaseEventTypeData::getSeverity | ( | ) | [virtual] |
Get the Severity event field
UaString BaseEventTypeData::getSourceName | ( | ) | [virtual] |
Get the SourceName event field
UaNodeId BaseEventTypeData::getSourceNode | ( | ) | [virtual] |
Get the SourceNode event field
UaDateTime BaseEventTypeData::getTime | ( | ) | [virtual] |
Get the Time event 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
[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 acknowledgement. The user specific part can be extracted from the EventId provided by the client by using EventManagerBase::getUserEventId() |
void BaseEventTypeData::registerEventFields | ( | ) | [static] |
Registers all event type fields with the EventManagerBase.
Reimplemented from UaEventData.
Reimplemented in OpcUa::AcknowledgeableConditionTypeBase, OpcUa::AlarmConditionTypeBase, OpcUa::ConditionTypeBase, OpcUa::DialogConditionTypeBase, OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, OpcUa::SystemEventTypeData, OpcUa::DeviceFailureEventTypeData, and OpcUa::TripAlarmTypeBase.
void BaseEventTypeData::setMessage | ( | const UaLocalizedText & | message ) | [virtual] |
Set the Message event field
void BaseEventTypeData::setReceiveTime | ( | const UaDateTime & | receiveTime ) | [virtual] |
Set the ReceiveTime event field
void BaseEventTypeData::setSeverity | ( | OpcUa_UInt16 | severity ) | [virtual] |
Set the Severity event field
void BaseEventTypeData::setSource | ( | const UaNode * | pNode ) | [virtual] |
Set the SourceNode and SoruceName by passing in a node pointer for the source node.
void BaseEventTypeData::setSourceName | ( | const UaString & | sourceName ) | [virtual] |
Set the SourceName event field
void BaseEventTypeData::setSourceNode | ( | const UaNodeId & | sourceNode ) | [virtual] |
Set the SourceNode event field
void BaseEventTypeData::setTime | ( | const UaDateTime & | time ) | [virtual] |
Set the Time event field
Field 01 - EventId
Field 02 - EventType
Field 07 - LocalTime
Field 08 - Message
Field 06 - ReceiveTime
Field 09 - Severity
Field 04 - SourceName
Field 03 - SourceNode
Field 05 - Time