PLCnext API Documentation  22.3.0.20
MessageWithArchiveNamePayload.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 
7 #pragma once
8 
9 #include "Arp/System/Nm/SpecializedPayload.hpp"
10 
11 namespace Arp { namespace System { namespace NmPayload { namespace NotificationLogger
12 {
13 
16 class MessageWithArchiveNamePayload : public Arp::System::Nm::SpecializedPayload<MessageWithArchiveNamePayload>
17 {
18 public:
19  using SpecializedPayload::SpecializedPayload;
20 
24  MessageWithArchiveNamePayload(const String& message, const String& archiveName);
25 
27  String GetArchiveName() const;
28 
29 private:
30  // Do not change the order of the field initialization!
31  const size_t indexArchiveName = this->AddField<String>();
32 };
33 
34 }}}} // namespace Arp::System::NmPayload::NotificationLogger
Payload class for a message containing an archive name
Definition: MessageWithArchiveNamePayload.hpp:16
MessageWithArchiveNamePayload(const String &message, const String &archiveName)
Creates a payload object
Base class for custom Payload classes
Definition: SpecializedPayload.hpp:42
Root namespace for the PLCnext API
System components used by the System, Device, Plc or Io domains.