 |
C++ Based OPC UA Client/Server/PubSub SDK
1.7.6.537
|
|
C++ Based OPC UA Client/Server/PubSub SDK
1.7.6.537
|
Event data class for the OPC UA event type AuditHistoryEventDeleteEventType. More...
#include <opcua_auditeventtypedata.h>
Inherits OpcUa::AuditHistoryDeleteEventTypeData.
Public Member Functions | |
| AuditHistoryEventDeleteEventTypeData () | |
| Constructs an instance of the event data class AuditHistoryEventDeleteEventTypeData. | |
| virtual | ~AuditHistoryEventDeleteEventTypeData () |
| Destroys the AuditHistoryEventDeleteEventTypeData object. | |
| virtual void | getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
| Get the field value for the passed index. More... | |
| void | setEventIds (const UaByteStringArray &EventIds) |
| Set the event field value EventIds. More... | |
| void | setEventIdsStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value EventIds. More... | |
| void | getEventIds (UaByteStringArray &EventIds) |
| Get the event field value EventIds. More... | |
| virtual void | getEventIdsValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value EventIds for delivering the event data. More... | |
| void | setOldValues (const UaHistoryEventFieldList &OldValues) |
| Set the event field value OldValues. More... | |
| UaHistoryEventFieldList | getOldValues () |
| Get the event field value OldValues. More... | |
| void | setOldValuesStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value OldValues. More... | |
| virtual void | getOldValuesValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value OldValues for delivering the event data. More... | |
 Public Member Functions inherited from OpcUa::AuditHistoryDeleteEventTypeData | |
| AuditHistoryDeleteEventTypeData () | |
| Constructs an instance of the event data class AuditHistoryDeleteEventTypeData. | |
| virtual | ~AuditHistoryDeleteEventTypeData () |
| Destroys the AuditHistoryDeleteEventTypeData object. | |
| void | setUpdatedNode (const UaNodeId &UpdatedNode) |
| Set the event field value UpdatedNode. More... | |
| void | setUpdatedNodeStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value UpdatedNode. More... | |
| UaNodeId | getUpdatedNode () |
| Get the event field value UpdatedNode. More... | |
| virtual void | getUpdatedNodeValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value UpdatedNode for delivering the event data. More... | |
| Public Member Functions inherited from OpcUa::AuditHistoryUpdateEventTypeData | |
| AuditHistoryUpdateEventTypeData () | |
| Constructs an instance of the event data class AuditHistoryUpdateEventTypeData. | |
| virtual | ~AuditHistoryUpdateEventTypeData () |
| Destroys the AuditHistoryUpdateEventTypeData object. | |
| void | setParameterDataTypeId (const UaNodeId &ParameterDataTypeId) |
| Set the event field value ParameterDataTypeId. More... | |
| void | setParameterDataTypeIdStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value ParameterDataTypeId. More... | |
| UaNodeId | getParameterDataTypeId () |
| Get the event field value ParameterDataTypeId. More... | |
| virtual void | getParameterDataTypeIdValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value ParameterDataTypeId for delivering the event data. More... | |
| Public Member Functions inherited from OpcUa::AuditUpdateEventTypeData | |
| AuditUpdateEventTypeData () | |
| Constructs an instance of the event data class AuditUpdateEventTypeData. | |
| virtual | ~AuditUpdateEventTypeData () |
| Destroys the AuditUpdateEventTypeData 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 NodeAccessInfo * | getEventAccessInfo () 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 ReferenceCounter * | getConditionDataReferenceCounter () |
| 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 AuditHistoryEventDeleteEventType. | |
| 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::AuditHistoryDeleteEventTypeData | |
| static void | createTypes () |
| Create the type nodes for the event type AuditHistoryDeleteEventType. | |
| 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::AuditHistoryUpdateEventTypeData | |
| static void | createTypes () |
| Create the type nodes for the event type AuditHistoryUpdateEventType. | |
| 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::AuditUpdateEventTypeData | |
| static void | createTypes () |
| Create the type nodes for the event type AuditUpdateEventType. | |
| 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. | |
Event data class for the OPC UA event type AuditHistoryEventDeleteEventType.
This class provides the functionality necessary to create an event of type AuditHistoryEventDeleteEventType, to set the values of the event fields and to send the event to interested clients through EventManagerBase::fireEvent().
Event Fields of the AuditHistoryEventDeleteEventType:
| Browse Name | DataType | TypeDefinition | Modelling Rule | See Also |
|---|---|---|---|---|
| EventIds | ByteString | PropertyType | Mandatory | getEventIds, setEventIds |
| OldValues | HistoryEventFieldList | PropertyType | Mandatory | getOldValues, setOldValues |
This is a subtype of AuditHistoryDeleteEventTypeData and is used for categorization of history delete related Events.
This type follows all behaviour of its parent type. It inherits all Properties of the AuditHistoryDeleteEventTypeData.
See also AuditHistoryEventDeleteEventType for a documentation of the complete Information Model.
| void OpcUa::AuditHistoryEventDeleteEventTypeData::getEventIds | ( | UaByteStringArray & | EventIds | ) |
Get the event field value EventIds.
Reflects the EventIds parameter of the call.
|
virtual |
Get the event field value EventIds 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
Reflects the EventIds parameter of the call.
|
virtual |
Get the field value for the passed index.
| index | The index of the selected field. |
| pSession | The session context for the method call. |
| data | The data for the selected field. |
Reimplemented from OpcUa::AuditHistoryDeleteEventTypeData.
| UaHistoryEventFieldList OpcUa::AuditHistoryEventDeleteEventTypeData::getOldValues | ( | ) |
Get the event field value OldValues.
Identifies the value that contained history before the delete.
A server should report all deleted values. It is acceptable for a server that does not have this information to report a null value. The OldValues will contain will contain an Event with the appropriate fields, each with appropriately encoded values.
|
virtual |
Get the event field value OldValues 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
Identifies the value that contained history before the delete.
A server should report all deleted values. It is acceptable for a server that does not have this information to report a null value. The OldValues will contain will contain an Event with the appropriate fields, each with appropriately encoded values.
| void OpcUa::AuditHistoryEventDeleteEventTypeData::setEventIds | ( | const UaByteStringArray & | EventIds | ) |
Set the event field value EventIds.
Reflects the EventIds parameter of the call.
| void OpcUa::AuditHistoryEventDeleteEventTypeData::setEventIdsStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value EventIds.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
| void OpcUa::AuditHistoryEventDeleteEventTypeData::setOldValues | ( | const UaHistoryEventFieldList & | OldValues | ) |
Set the event field value OldValues.
Identifies the value that contained history before the delete.
A server should report all deleted values. It is acceptable for a server that does not have this information to report a null value. The OldValues will contain will contain an Event with the appropriate fields, each with appropriately encoded values.
| void OpcUa::AuditHistoryEventDeleteEventTypeData::setOldValuesStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value OldValues.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.