PLCnext API Documentation  22.9.0.33
NetloadLimiterSettings.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Rsc/Services/IRscSerializable.hpp"
9 #include "Arp/System/Rsc/Services/RscReader.hpp"
10 #include "Arp/System/Rsc/Services/RscWriter.hpp"
11 
12 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
13 
14 namespace Arp { namespace Hardware { namespace Nim { namespace Services
15 {
16 
17 using namespace Arp;
18 using namespace Arp::System::Rsc::Services;
19 
24 {
25 public:
29  boolean PacketLimiterEnabled = false;
30 
34  boolean ByteLimiterEnabled = false;
35 
40  uint16 PacketLimit = 0;
41 
46  uint32 ByteLimit = 0;
47 
48  void Serialize(RscWriter& writer)const override
49  {
50  writer.Write(this->PacketLimiterEnabled);
51  writer.Write(this->ByteLimiterEnabled);
52  writer.Write(this->PacketLimit);
53  writer.Write(this->ByteLimit);
54  }
55 
56  void Deserialize(RscReader& reader)override
57  {
58  reader.Read(this->PacketLimiterEnabled);
59  reader.Read(this->ByteLimiterEnabled);
60  reader.Read(this->PacketLimit);
61  reader.Read(this->ByteLimit);
62  }
63 
64  static constexpr size_t GetFieldCount(void)
65  {
66  return 4;
67  }
68 };
69 
70 }}}} // end of namespace Arp::Hardware::Nim::Services
This struct contains all settings of the netload limiter. It is used to set and get the current setti...
Definition: NetloadLimiterSettings.hpp:24
void Deserialize(RscReader &reader) override
Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.
Definition: NetloadLimiterSettings.hpp:56
void Serialize(RscWriter &writer) const override
Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.
Definition: NetloadLimiterSettings.hpp:48
Marshalls structure or class data types. Serialize and Deserialize have to marshal fields in the same...
Definition: IRscSerializable.hpp:19
Reads data from Rsc
Definition: RscReader.hpp:26
T Read(void)
Reads an element of T from Rsc. With data tagging enabled RscType of T is validated.
Definition: RscReader.hpp:165
Writes data to Rsc.
Definition: RscWriter.hpp:31
void Write(const T &value)
Writes an element of T from Rsc. Datatag and format is determined deducted by type of T.
Definition: RscWriter.hpp:177
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:31
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:10
Root namespace for the PLCnext API