PLCnext API Documentation 25.0.2.69
MessageWithArchiveNamePayload.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6
7#pragma once
8
10#include "Arp/System/Nm/SpecializedPayload.hpp"
11#include <tuple>
12
13namespace Arp { namespace System { namespace NmPayload { namespace NotificationLogger
14{
15
18class ARP_CXX_SYMBOL_EXPORT MessageWithArchiveNamePayload : public Arp::System::Nm::SpecializedPayload<MessageWithArchiveNamePayload>
19{
20public:
22 using ArgumentsType = std::tuple<const char*, const char*>;
24 explicit MessageWithArchiveNamePayload(const ArgumentsType& args);
25 MessageWithArchiveNamePayload(const String& message, const String& archiveName);
26 String GetArchiveName() const;
27
28private:
29 // Do not change the order of the field initialization!
30 const size_t indexArchiveName = this->AddField<String>();
31};
32
33}}}} // 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 containing an archive name
Definition: MessageWithArchiveNamePayload.hpp:19
std::tuple< const char *, const char * > ArgumentsType
ArgumentsType to be used with NonBlockingNotificationRegistration3
Definition: MessageWithArchiveNamePayload.hpp:22
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