PLCnext API Documentation 25.0.2.69
NetworkConfigurationChangedPayload.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6
7#pragma once
8
9
10#include "Arp/System/Core/Arp.h"
11#include "Arp/System/Nm/SpecializedPayload.hpp"
12#include <tuple>
13
14
15namespace Arp { namespace System { namespace NmPayload { namespace Device
16{
17
18
21class ARP_CXX_SYMBOL_EXPORT NetworkConfigurationChangedPayload
22 : public Arp::System::Nm::SpecializedPayload<NetworkConfigurationChangedPayload>
23{
24public:
26 using ArgumentsType = std::tuple<uint32, const char*, const char*, bool>;
30 uint32 deviceId, const String& parameter, const String& value, bool successful);
31 uint32 GetDeviceId() const;
32 String GetChangedParameter() const;
33 ARP_DEPRECATED("Use GetValue()")
34 String GetValued() const;
35 String GetValue() const;
36
37private:
38 static String GetFormatString(bool successful);
39
40private:
41 // Do not change the order of the field initialization!
42 size_t indexDeviceId = this->AddField<uint32>();
43 size_t indexChangedParameter = this->AddField<String>();
44 size_t indexValue = this->AddField<String>();
45};
46
47
48}}}} // namespace Arp::System::NmPayload::Device
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
Payload class for changes of the network configuration
Definition: NetworkConfigurationChangedPayload.hpp:23
std::tuple< uint32, const char *, const char *, bool > ArgumentsType
ArgumentsType to be used with NonBlockingNotificationRegistration3
Definition: NetworkConfigurationChangedPayload.hpp:26
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
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:33
Root namespace for the PLCnext API
class ARP_DEPRECATED("Use Arp::Enum<T> instead.") EnumStrings
Deprecated! The class implements an adapter for enums to define the string literals of the enum entri...
Definition: EnumStrings.hxx:38