PLCnext API Documentation  21.0.0.35466
NetworkConfigurationChangedPayload.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 
7 #pragma once
8 
9 
10 #include "Arp/System/Nm/SpecializedPayload.hpp"
11 
12 
13 namespace Arp { namespace System { namespace NmPayload { namespace Device
14 {
15 
16 
20  : public Arp::System::Nm::SpecializedPayload<NetworkConfigurationChangedPayload>
21 {
22 public:
23  using SpecializedPayload::SpecializedPayload;
24 
31  uint32 deviceId, const String& parameter, const String& value, bool successful);
32 
34  uint32 GetDeviceId() const;
35 
38 
39  ARP_DEPRECATED("Use GetValue()")
42  String GetValued() const;
43 
45  String GetValue() const;
46 
47 private:
48  static String GetFormatString(bool successful);
49 
50 private:
51  // Do not change the order of the field initialization!
52  size_t indexDeviceId = this->AddField<uint32>();
53  size_t indexChangedParameter = this->AddField<String>();
54  size_t indexValue = this->AddField<String>();
55 };
56 
57 
58 }}}} // namespace Arp::System::NmPayload::Device
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
Payload class for changes of the network configuration
Definition: NetworkConfigurationChangedPayload.hpp:19
Base class for custom Payload classes
Definition: SpecializedPayload.hpp:42
String GetValue() const
Returns the new value of the changed parameter
Root namespace for the PLCnext API
NetworkConfigurationChangedPayload(uint32 deviceId, const String &parameter, const String &value, bool successful)
Creates a payload object
uint32 GetDeviceId() const
Returns the id of the affected device
System components used by the System, Device, Plc or Io domains.
String GetValued() const
Returns the new value of the changed parameter
String GetChangedParameter() const
Returns the name of the changed parameter