PLCnext API Documentation 25.0.2.69
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Services::NotificationLogger::Services::StoredNotification Class Reference

Data structure for notifications from the NotificationLogger More...

#include <StoredNotification.hpp>

Inheritance diagram for Arp::Services::NotificationLogger::Services::StoredNotification:
Inheritance graph

Public Member Functions

 StoredNotification (void)
 Constructs an StoredNotification instance.
 
 StoredNotification (uint64 id, const RscString< 512 > &archive, const RscString< 512 > &notificationName, const RscString< 512 > &senderName, const RscString< 512 > &timeStamp, const RscString< 512 > &severity, const std::vector< RscString< 512 > > &payload, const std::vector< RscString< 512 > > &payloadXml)
 Constructs an StoredNotification instance.
 
void Serialize (RscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
void Serialize (JRscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter. More...
 
void Deserialize (JRscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader. More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable
 RscSerializable (void)=default
 The default constructor.
 

Static Public Member Functions

static size_t GetFieldCount (void)
 Returns the count of fields More...
 

Public Attributes

uint64 Id = 0
 Id of the notification
 
RscString< 512 > Archive
 name of the archive the notification was retreived from. If the same notification was stored in multiple archives this field contains a comma separated list of the archives
 
RscString< 512 > NotificationName
 Name of the notification
 
RscString< 512 > SenderName
 Nme of the sender
 
RscString< 512 > TimeStamp
 timestamp when the notification was sent
 
RscString< 512 > Severity
 Severity
 
std::vector< RscString< 512 > > Payload
 Formatted payload
 
std::vector< RscString< 512 > > PayloadXml
 Payload as XML
 

Detailed Description

Data structure for notifications from the NotificationLogger

Member Function Documentation

◆ Deserialize() [1/2]

void Arp::Services::NotificationLogger::Services::StoredNotification::Deserialize ( JRscReader &  reader)

Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader.

Parameters
readerReference to RscReader.

◆ Deserialize() [2/2]

void Arp::Services::NotificationLogger::Services::StoredNotification::Deserialize ( RscReader reader)

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters
readerReference to RscReader.

◆ GetFieldCount()

size_t Arp::Services::NotificationLogger::Services::StoredNotification::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ Serialize() [1/2]

void Arp::Services::NotificationLogger::Services::StoredNotification::Serialize ( JRscWriter &  writer) const

Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter.

Parameters
writerReference to RscWriter

◆ Serialize() [2/2]

void Arp::Services::NotificationLogger::Services::StoredNotification::Serialize ( RscWriter writer) const

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters
writerReference to RscWriter

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