C++ Based OPC UA Client/Server/PubSub SDK  1.7.4.520
OpcUa::AuditDeleteReferencesEventTypeData Class Reference

Event data class for the OPC UA event type AuditDeleteReferencesEventType. More...

#include <opcua_auditeventtypedata.h>

Inherits OpcUa::AuditNodeManagementEventTypeData.

Public Member Functions

 AuditDeleteReferencesEventTypeData ()
 Constructs an instance of the event data class AuditDeleteReferencesEventTypeData.
 
virtual ~AuditDeleteReferencesEventTypeData ()
 Destroys the AuditDeleteReferencesEventTypeData object.
 
virtual void getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
 Get the field value for the passed index. More...
 
void setReferencesToDelete (const UaDeleteReferencesItems &ReferencesToDelete)
 Set the event field value ReferencesToDelete. More...
 
void setReferencesToDeleteStatus (OpcUa_StatusCode status)
 Set a status code for the event field value ReferencesToDelete. More...
 
void getReferencesToDelete (UaDeleteReferencesItems &ReferencesToDelete)
 Get the event field value ReferencesToDelete. More...
 
virtual void getReferencesToDeleteValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value ReferencesToDelete for delivering the event data. More...
 
- Public Member Functions inherited from OpcUa::AuditNodeManagementEventTypeData
 AuditNodeManagementEventTypeData ()
 Constructs an instance of the event data class AuditNodeManagementEventTypeData.
 
virtual ~AuditNodeManagementEventTypeData ()
 Destroys the AuditNodeManagementEventTypeData object.
 
- Public Member Functions inherited from OpcUa::AuditEventTypeData
 AuditEventTypeData ()
 Constructs an instance of the event data class AuditEventTypeData.
 
virtual ~AuditEventTypeData ()
 Destroys the AuditEventTypeData object.
 
void setActionTimeStamp (const UaDateTime &ActionTimeStamp)
 Set the event field value ActionTimeStamp. More...
 
void setActionTimeStampStatus (OpcUa_StatusCode status)
 Set a status code for the event field value ActionTimeStamp. More...
 
UaDateTime getActionTimeStamp ()
 Get the event field value ActionTimeStamp. More...
 
virtual void getActionTimeStampValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value ActionTimeStamp for delivering the event data. More...
 
void setClientAuditEntryId (const UaString &ClientAuditEntryId)
 Set the event field value ClientAuditEntryId. More...
 
void setClientAuditEntryIdStatus (OpcUa_StatusCode status)
 Set a status code for the event field value ClientAuditEntryId. More...
 
UaString getClientAuditEntryId ()
 Get the event field value ClientAuditEntryId. More...
 
virtual void getClientAuditEntryIdValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value ClientAuditEntryId for delivering the event data. More...
 
void setClientUserId (const UaString &ClientUserId)
 Set the event field value ClientUserId. More...
 
void setClientUserIdStatus (OpcUa_StatusCode status)
 Set a status code for the event field value ClientUserId. More...
 
UaString getClientUserId ()
 Get the event field value ClientUserId. More...
 
virtual void getClientUserIdValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value ClientUserId for delivering the event data. More...
 
void setServerId (const UaString &ServerId)
 Set the event field value ServerId. More...
 
void setServerIdStatus (OpcUa_StatusCode status)
 Set a status code for the event field value ServerId. More...
 
UaString getServerId ()
 Get the event field value ServerId. More...
 
virtual void getServerIdValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value ServerId for delivering the event data. More...
 
void setStatus (OpcUa_Boolean Status)
 Set the event field value Status. More...
 
void setStatusStatus (OpcUa_StatusCode status)
 Set a status code for the event field value Status. More...
 
OpcUa_Boolean getStatus ()
 Get the event field value Status. More...
 
virtual void getStatusValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value Status for delivering the event data. More...
 
- Public Member Functions inherited from BaseEventTypeData
 BaseEventTypeData ()
 Constructs a BaseEventTypeData object.
 
virtual ~BaseEventTypeData ()
 Destroys the BaseEventTypeData object.
 
virtual void prepareNewEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &userEventId)
 Initializes the event data fields EventId, Time and ReceiveTime with valid values for the next event. More...
 
virtual UaByteString getEventId () const
 Get the EventId event field. More...
 
virtual UaNodeId getEventTypeId () const
 Get the EventType event field. More...
 
virtual void setSource (const UaNode *pNode)
 Set the SourceNode and SourceName by passing in a node pointer for the source node.
 
virtual void setSourceNode (const UaNodeId &sourceNode)
 Set the SourceNode event field. More...
 
virtual UaNodeId getSourceNode () const
 Get the SourceNode event field. More...
 
virtual void setSourceName (const UaString &sourceName)
 Set the SourceName event field. More...
 
virtual UaString getSourceName () const
 Get the SourceName event field. More...
 
virtual void setTime (const UaDateTime &time)
 Set the Time event field. More...
 
virtual UaDateTime getTime () const
 Get the Time event field. More...
 
virtual void setReceiveTime (const UaDateTime &receiveTime)
 Set the ReceiveTime event field. More...
 
virtual UaDateTime getReceiveTime () const
 Get the ReceiveTime event field. More...
 
virtual void setMessage (const UaLocalizedText &message)
 Set the Message event field. More...
 
virtual UaLocalizedText getMessage () const
 Get the Message event field. More...
 
virtual void getMessageValue (Session *pSession, UaVariant &data)
 Get the message field value. More...
 
virtual void setSeverity (OpcUa_UInt16 severity)
 Set the Severity event field. More...
 
virtual OpcUa_UInt16 getSeverity () const
 Get the Severity event field. More...
 
virtual void setLocalTime (const UaTimeZoneDataType &localTime)
 Set the LocalTime event field. More...
 
virtual UaTimeZoneDataType getLocalTime () const
 Get the LocalTime event field. More...
 
- 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.
 
const NodeAccessInfogetEventAccessInfo () const
 Returns the access info associated with this UaEventData. More...
 
void useEventAccessInfoFrom (const UaEventData *pOther)
 Set the access info from another node to this node. More...
 
void setEventAccessInfo (NodeAccessInfo *pAccessInfo)
 Set access info for this UaEventData. More...
 
void attachEventAccessInfo (NodeAccessInfo *pAccessInfo)
 Set access info for this UaEventData. More...
 
virtual ReferenceCountergetConditionDataReferenceCounter ()
 Get the ReferenceCounter interface necessary for condition event data classes.
 

Static Public Member Functions

static void createTypes ()
 Create the type nodes for the event type AuditDeleteReferencesEventType.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
static void registerEventFields ()
 Registers all event type fields with the EventManagerBase.
 
- Static Public Member Functions inherited from OpcUa::AuditNodeManagementEventTypeData
static void createTypes ()
 Create the type nodes for the event type AuditNodeManagementEventType.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
static void registerEventFields ()
 Registers all event type fields with the EventManagerBase.
 
- Static Public Member Functions inherited from OpcUa::AuditEventTypeData
static void createTypes ()
 Create the type nodes for the event type AuditEventType.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
static void registerEventFields ()
 Registers all event type fields with the EventManagerBase.
 
- Static Public Member Functions inherited from BaseEventTypeData
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.
 

Additional Inherited Members

- Public Attributes inherited from BaseEventTypeData
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

Event data class for the OPC UA event type AuditDeleteReferencesEventType.

This class provides the functionality necessary to create an event of type AuditDeleteReferencesEventType, to set the values of the event fields and to send the event to interested clients through EventManagerBase::fireEvent().

Event Fields of the AuditDeleteReferencesEventType:

Browse Name DataType TypeDefinition Modelling Rule See Also
ReferencesToDelete DeleteReferencesItem PropertyType Mandatory getReferencesToDelete, setReferencesToDelete

This is a subtype of AuditNodeManagementEventTypeData and is used for Events generated from calling the DeleteReferences Service defined in Part 4 of the OPC UA Specification.

This EventType inherits all Properties of the AuditNodeManagementEventTypeData. The SourceName for Events of this type should be ‚ÄúNodeManagement/DeleteReferences‚ÄĚ.

The additional Properties defined for this EventType reflect parameters of the Service call that triggers the Event.

See also AuditDeleteReferencesEventType for a documentation of the complete Information Model.

Member Function Documentation

void OpcUa::AuditDeleteReferencesEventTypeData::getFieldData ( OpcUa_UInt32  index,
Session pSession,
OpcUa_Variant data 
)
virtual

Get the field value for the passed index.

Parameters
indexThe index of the selected field.
pSessionThe session context for the method call.
dataThe data for the selected field.

Reimplemented from OpcUa::AuditNodeManagementEventTypeData.

void OpcUa::AuditDeleteReferencesEventTypeData::getReferencesToDelete ( UaDeleteReferencesItems ReferencesToDelete)

Get the event field value ReferencesToDelete.

The referencesToDelete parameter of the DeleteReferences Service call.

void OpcUa::AuditDeleteReferencesEventTypeData::getReferencesToDeleteValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value ReferencesToDelete for delivering the event data.

This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client

The referencesToDelete parameter of the DeleteReferences Service call.

void OpcUa::AuditDeleteReferencesEventTypeData::setReferencesToDelete ( const UaDeleteReferencesItems ReferencesToDelete)

Set the event field value ReferencesToDelete.

The referencesToDelete parameter of the DeleteReferences Service call.

void OpcUa::AuditDeleteReferencesEventTypeData::setReferencesToDeleteStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value ReferencesToDelete.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.


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