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

Data structure for notifications from the NotificationLogger More...

#include <StoredNotification2.hpp>

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

Public Member Functions

 StoredNotification2 (void)
 Constructs an StoredNotification2 instance.
 
 StoredNotification2 (uint64 id, const std::vector< RscString< 64 > > &archives, const RscString< 512 > &notificationName, const RscString< 512 > &senderName, const RscString< 32 > &timeStamp, const RscString< 32 > &severity, const RscString< 32 > &redundancyType, const RscString< 32 > &redundancyRole, const std::vector< RscString< 512 > > &payload, const std::vector< RscString< 512 > > &payloadXml)
 Constructs an StoredNotification2 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
 
std::vector< RscString< 64 > > Archives
 Names of the archives the notification was retreived from. More...
 
RscString< 512 > NotificationName
 Name of the notification
 
RscString< 512 > SenderName
 Name of the sender
 
RscString< 32 > TimeStamp
 Timestamp when the notification was sent
 
RscString< 32 > Severity
 Severity
 
RscString< 32 > RedundancyType
 Redundancy type (First, Second)
 
RscString< 32 > RedundancyRole
 Redundancy role (Primary, Backup)
 
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::StoredNotification2::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::StoredNotification2::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::StoredNotification2::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::StoredNotification2::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::StoredNotification2::Serialize ( RscWriter writer) const

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

Parameters
writerReference to RscWriter

Member Data Documentation

◆ Archives

std::vector<RscString<64> > Arp::Services::NotificationLogger::Services::StoredNotification2::Archives

Names of the archives the notification was retreived from.

Corresponds to Archive of Arp.Services.NotificationLogger.Services.StoredNotification


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