C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
OpcUa::AuditActivateSessionEventTypeData Class Reference

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

#include <opcua_auditeventtypedata.h>

Inherits OpcUa::AuditSessionEventTypeData.

Public Member Functions

 AuditActivateSessionEventTypeData ()
 Constructs an instance of the event data class AuditActivateSessionEventTypeData.
 
virtual ~AuditActivateSessionEventTypeData ()
 Destroys the AuditActivateSessionEventTypeData object.
 
virtual void getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
 Get the field value for the passed index. More...
 
void setClientSoftwareCertificates (const UaSignedSoftwareCertificates &ClientSoftwareCertificates)
 Set the event field value ClientSoftwareCertificates. More...
 
void setClientSoftwareCertificatesStatus (OpcUa_StatusCode status)
 Set a status code for the event field value ClientSoftwareCertificates. More...
 
void getClientSoftwareCertificates (UaSignedSoftwareCertificates &ClientSoftwareCertificates)
 Get the event field value ClientSoftwareCertificates. More...
 
virtual void getClientSoftwareCertificatesValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value ClientSoftwareCertificates for delivering the event data. More...
 
void setSecureChannelId (const UaString &SecureChannelId)
 Set the event field value SecureChannelId. More...
 
void setSecureChannelIdStatus (OpcUa_StatusCode status)
 Set a status code for the event field value SecureChannelId. More...
 
UaString getSecureChannelId ()
 Get the event field value SecureChannelId. More...
 
virtual void getSecureChannelIdValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value SecureChannelId for delivering the event data. More...
 
void setUserIdentityToken (const UaExtensionObject &UserIdentityToken)
 Set the event field value UserIdentityToken. More...
 
void setUserIdentityTokenStatus (OpcUa_StatusCode status)
 Set a status code for the event field value UserIdentityToken. More...
 
UaExtensionObject getUserIdentityToken ()
 Get the event field value UserIdentityToken. More...
 
virtual void getUserIdentityTokenValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value UserIdentityToken for delivering the event data. More...
 
- Public Member Functions inherited from OpcUa::AuditSessionEventTypeData
 AuditSessionEventTypeData ()
 Constructs an instance of the event data class AuditSessionEventTypeData.
 
virtual ~AuditSessionEventTypeData ()
 Destroys the AuditSessionEventTypeData object.
 
void setSessionId (const UaNodeId &SessionId)
 Set the event field value SessionId. More...
 
void setSessionIdStatus (OpcUa_StatusCode status)
 Set a status code for the event field value SessionId. More...
 
UaNodeId getSessionId ()
 Get the event field value SessionId. More...
 
virtual void getSessionIdValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value SessionId for delivering the event data. More...
 
- Public Member Functions inherited from OpcUa::AuditSecurityEventTypeData
 AuditSecurityEventTypeData ()
 Constructs an instance of the event data class AuditSecurityEventTypeData.
 
virtual ~AuditSecurityEventTypeData ()
 Destroys the AuditSecurityEventTypeData object.
 
void setStatusCodeId (OpcUa_StatusCode StatusCodeId)
 Set the event field value StatusCodeId.
 
void setStatusCodeIdStatus (OpcUa_StatusCode status)
 Set a status code for the event field value StatusCodeId. More...
 
OpcUa_StatusCode getStatusCodeId ()
 Get the event field value StatusCodeId.
 
virtual void getStatusCodeIdValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value StatusCodeId for delivering the event data. More...
 
- 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 AuditActivateSessionEventType.
 
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::AuditSessionEventTypeData
static void createTypes ()
 Create the type nodes for the event type AuditSessionEventType.
 
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::AuditSecurityEventTypeData
static void createTypes ()
 Create the type nodes for the event type AuditSecurityEventType.
 
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 AuditActivateSessionEventType.

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

Event Fields of the AuditActivateSessionEventType:

Browse Name DataType TypeDefinition Modelling Rule See Also
ClientSoftwareCertificates SignedSoftwareCertificate PropertyType Mandatory getClientSoftwareCertificates, setClientSoftwareCertificates
SecureChannelId String PropertyType Mandatory getSecureChannelId, setSecureChannelId
UserIdentityToken UserIdentityToken PropertyType Mandatory getUserIdentityToken, setUserIdentityToken

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

This EventType inherits all Properties of the AuditSessionEventTypeData. The SourceName for Events of this type should be “Session/ActivateSession”.

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

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

Member Function Documentation

void OpcUa::AuditActivateSessionEventTypeData::getClientSoftwareCertificates ( UaSignedSoftwareCertificates ClientSoftwareCertificates)

Get the event field value ClientSoftwareCertificates.

The clientSoftwareCertificates parameter of the ActivateSession Service call.

void OpcUa::AuditActivateSessionEventTypeData::getClientSoftwareCertificatesValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value ClientSoftwareCertificates 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 clientSoftwareCertificates parameter of the ActivateSession Service call.

void OpcUa::AuditActivateSessionEventTypeData::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::AuditSessionEventTypeData.

UaString OpcUa::AuditActivateSessionEventTypeData::getSecureChannelId ( )

Get the event field value SecureChannelId.

Uniquely identifies the SecureChannel.

The application shall use the same identifier in all AuditEvents related to the Session Service Set ( AuditCreateSessionEventTypeData, AuditActivateSessionEventTypeData and their subtypes) and the SecureChannel Service Set ( AuditChannelEventTypeData and its subtypes).

void OpcUa::AuditActivateSessionEventTypeData::getSecureChannelIdValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value SecureChannelId 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

Uniquely identifies the SecureChannel.

The application shall use the same identifier in all AuditEvents related to the Session Service Set ( AuditCreateSessionEventTypeData, AuditActivateSessionEventTypeData and their subtypes) and the SecureChannel Service Set ( AuditChannelEventTypeData and its subtypes).

UaExtensionObject OpcUa::AuditActivateSessionEventTypeData::getUserIdentityToken ( )

Get the event field value UserIdentityToken.

The userIdentityToken parameter of the ActivateSession Service call.

For Username/Password tokens the password should not be included.

void OpcUa::AuditActivateSessionEventTypeData::getUserIdentityTokenValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value UserIdentityToken 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 userIdentityToken parameter of the ActivateSession Service call.

For Username/Password tokens the password should not be included.

void OpcUa::AuditActivateSessionEventTypeData::setClientSoftwareCertificates ( const UaSignedSoftwareCertificates ClientSoftwareCertificates)

Set the event field value ClientSoftwareCertificates.

The clientSoftwareCertificates parameter of the ActivateSession Service call.

void OpcUa::AuditActivateSessionEventTypeData::setClientSoftwareCertificatesStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value ClientSoftwareCertificates.

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

void OpcUa::AuditActivateSessionEventTypeData::setSecureChannelId ( const UaString SecureChannelId)

Set the event field value SecureChannelId.

Uniquely identifies the SecureChannel.

The application shall use the same identifier in all AuditEvents related to the Session Service Set ( AuditCreateSessionEventTypeData, AuditActivateSessionEventTypeData and their subtypes) and the SecureChannel Service Set ( AuditChannelEventTypeData and its subtypes).

void OpcUa::AuditActivateSessionEventTypeData::setSecureChannelIdStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value SecureChannelId.

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

void OpcUa::AuditActivateSessionEventTypeData::setUserIdentityToken ( const UaExtensionObject UserIdentityToken)

Set the event field value UserIdentityToken.

The userIdentityToken parameter of the ActivateSession Service call.

For Username/Password tokens the password should not be included.

void OpcUa::AuditActivateSessionEventTypeData::setUserIdentityTokenStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value UserIdentityToken.

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: