PLCnext API Documentation 25.0.2.69
StoredNotification.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/JRsc/Commons/JRsc.hpp"
10#include "Arp/Base/Rsc/Commons/RscSerializable.hpp"
11#include <vector>
12#include "Arp/Base/Rsc/Commons/RscString.hxx"
13
14// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
15
17{
18
19using namespace Arp;
20using namespace Arp::Base::Rsc::Commons;
21using namespace Arp::Base::Rsc::Commons::Services;
22using namespace Arp::Base::JRsc::Commons;
23
27class ARP_EXPORT StoredNotification : public RscSerializable
28{
29public: // construction/destruction
31 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);
32
33public: // Properties
37 uint64 Id = 0;
38
44
49
54
59
64
68 std::vector<RscString<512>> Payload;
69
73 std::vector<RscString<512>> PayloadXml;
74
75public: // Rsc operations
76 void Serialize(RscWriter& writer)const;
77 void Deserialize(RscReader& reader);
78 void Serialize(JRscWriter& writer)const;
79 void Deserialize(JRscReader& reader);
80 static size_t GetFieldCount(void);
81};
82
83} // end of namespace Arp::Services::NotificationLogger::Services
Any custom struct type which is intended to be marshalled in a Rsc serialization context,...
Definition: RscSerializable.hpp:35
Reads marshaled data of RSC services.
Definition: RscReader.hpp:34
Writes marshalled data of RSC services.
Definition: RscWriter.hpp:34
Data structure for notifications from the NotificationLogger
Definition: StoredNotification.hpp:28
std::vector< RscString< 512 > > PayloadXml
Payload as XML
Definition: StoredNotification.hpp:73
RscString< 512 > NotificationName
Name of the notification
Definition: StoredNotification.hpp:48
RscString< 512 > SenderName
Nme of the sender
Definition: StoredNotification.hpp:53
RscString< 512 > Severity
Severity
Definition: StoredNotification.hpp:63
std::vector< RscString< 512 > > Payload
Formatted payload
Definition: StoredNotification.hpp:68
RscString< 512 > Archive
name of the archive the notification was retreived from. If the same notification was stored in multi...
Definition: StoredNotification.hpp:43
StoredNotification(void)
Constructs an StoredNotification instance.
RscString< 512 > TimeStamp
timestamp when the notification was sent
Definition: StoredNotification.hpp:58
std::uint64_t uint64
The Arp unsigned integer type of 8 byte size.
Definition: PrimitiveTypes.hpp:37
Namespace for the JSON RSC extension
Namespace for services of the NotificationLogger
Root namespace for the PLCnext API