PLCnext API Documentation 25.0.2.69
StorageFileIntegrityCheckPayload.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/System/Nm/LongStringPayloadField.hpp"
9#include "Arp/System/Nm/SpecializedPayload.hpp"
10#include <tuple>
11
12namespace Arp { namespace System { namespace NmPayload { namespace NotificationLogger
13{
14
17class ARP_CXX_SYMBOL_EXPORT StorageFileIntegrityCheckPayload : public Arp::System::Nm::SpecializedPayload<StorageFileIntegrityCheckPayload>
18{
19
20public:
22 using ArgumentsType = std::tuple<const char*, const char*, const char*, const char*>;
26 const String& archiveName, const String& filePath, const String& backupFilePath, const String& message);
27 String GetArchiveName() const;
28 String GetFilePath() const;
29 String GetBackupFilePath() const;
30 String GetMessage() const;
31
32private:
33 String BuildFormatString() const;
34
35private:
36 // Do not change the order of the field initialization!
37 const size_t indexArchiveName = this->AddField<String>();
38 const size_t indexFilePath = this->AddField<String>();
39 const size_t indexBackupFilePath = this->AddField<String>();
41};
42
43}}}} // end of namespace Arp::System::NmPayload::NotificationLogger
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
Payload class for a message regarding the a failed integrity check of a NotificationLogger archive
Definition: StorageFileIntegrityCheckPayload.hpp:18
std::tuple< const char *, const char *, const char *, const char * > ArgumentsType
ArgumentsType to be used with NonBlockingNotificationRegistration3
Definition: StorageFileIntegrityCheckPayload.hpp:22
Definition: LongStringPayloadField.hpp:19
Base class for custom Payload classes
Definition: SpecializedPayload.hpp:44
SpecializedPayload(const Notification &notification)
Creates a view on a Notification object
Definition: SpecializedPayload.hpp:211
Root namespace for the PLCnext API