PLCnext API Documentation 25.0.2.69
StoredNotification2.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 StoredNotification2 : public RscSerializable
28{
29public: // construction/destruction
31 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);
32
33public: // Properties
37 uint64 Id = 0;
38
43 std::vector<RscString<64>> Archives;
44
49
54
59
64
69
74
78 std::vector<RscString<512>> Payload;
79
83 std::vector<RscString<512>> PayloadXml;
84
85public: // Rsc operations
86 void Serialize(RscWriter& writer)const;
87 void Deserialize(RscReader& reader);
88 void Serialize(JRscWriter& writer)const;
89 void Deserialize(JRscReader& reader);
90 static size_t GetFieldCount(void);
91};
92
93} // 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
Contains a static string with string lentgh up to N characters. The string shall be null terminated.
Definition: RscString.hxx:24
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: StoredNotification2.hpp:28
RscString< 512 > NotificationName
Name of the notification
Definition: StoredNotification2.hpp:48
std::vector< RscString< 512 > > PayloadXml
Payload as XML
Definition: StoredNotification2.hpp:83
RscString< 32 > TimeStamp
Timestamp when the notification was sent
Definition: StoredNotification2.hpp:58
RscString< 32 > RedundancyRole
Redundancy role (Primary, Backup)
Definition: StoredNotification2.hpp:73
StoredNotification2(void)
Constructs an StoredNotification2 instance.
RscString< 32 > Severity
Severity
Definition: StoredNotification2.hpp:63
RscString< 32 > RedundancyType
Redundancy type (First, Second)
Definition: StoredNotification2.hpp:68
std::vector< RscString< 64 > > Archives
Names of the archives the notification was retreived from.
Definition: StoredNotification2.hpp:43
std::vector< RscString< 512 > > Payload
Formatted payload
Definition: StoredNotification2.hpp:78
RscString< 512 > SenderName
Name of the sender
Definition: StoredNotification2.hpp:53
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