PLCnext API Documentation 23.6.0.37
NetloadLimiterStatisticResult.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/Hardware/Nim/Services/LimiterStatistic.hpp"
9#include "Arp/Hardware/Nim/Services/NetloadLimiterErrorCode.hpp"
10#include "Arp/System/Rsc/Services/IRscSerializable.hpp"
11#include "Arp/System/Rsc/Services/RscReader.hpp"
12#include "Arp/System/Rsc/Services/RscWriter.hpp"
13
14// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
15
16namespace Arp { namespace Hardware { namespace Nim { namespace Services
17{
18
19using namespace Arp;
20using namespace Arp::System::Rsc::Services;
21
26{
27public:
32
37
42
47
52
53 void Serialize(RscWriter& writer)const override
54 {
55 writer.Write(this->NetworkInterfaceId);
56 writer.Write(this->ErrorCode);
57 writer.Write(this->DurationSinceLastReset);
58 writer.Write(this->PacketLimiterStatistic);
59 writer.Write(this->ByteLimiterStatistic);
60 }
61
62 void Deserialize(RscReader& reader)override
63 {
64 reader.Read(this->NetworkInterfaceId);
65 reader.Read(this->ErrorCode);
66 reader.Read(this->DurationSinceLastReset);
67 reader.Read(this->PacketLimiterStatistic);
68 reader.Read(this->ByteLimiterStatistic);
69 }
70
71 static constexpr size_t GetFieldCount(void)
72 {
73 return 5;
74 }
75};
76
77}}}} // end of namespace Arp::Hardware::Nim::Services
Statistical values for the NetloadLimiter
Definition: LimiterStatistic.hpp:24
Result for reading the NetloadLimiter statistics.
Definition: NetloadLimiterStatisticResult.hpp:26
LimiterStatistic PacketLimiterStatistic
Statistic values of the packet limiter.
Definition: NetloadLimiterStatisticResult.hpp:46
void Deserialize(RscReader &reader) override
Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.
Definition: NetloadLimiterStatisticResult.hpp:62
LimiterStatistic ByteLimiterStatistic
Statistic values of the byte limiter.
Definition: NetloadLimiterStatisticResult.hpp:51
uint8 NetworkInterfaceId
Id of the related interface.
Definition: NetloadLimiterStatisticResult.hpp:31
void Serialize(RscWriter &writer) const override
Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.
Definition: NetloadLimiterStatisticResult.hpp:53
uint64 DurationSinceLastReset
Time passed since last reset (microseconds).
Definition: NetloadLimiterStatisticResult.hpp:41
NetloadLimiterErrorCode ErrorCode
Error code.
Definition: NetloadLimiterStatisticResult.hpp:36
Marshalls structure or class data types. Serialize and Deserialize have to marshal fields in the same...
Definition: IRscSerializable.hpp:20
Reads data from Rsc
Definition: RscReader.hpp:27
T Read(void)
Reads an element of T from Rsc. With data tagging enabled RscType of T is validated.
Definition: RscReader.hpp:166
Writes data to Rsc.
Definition: RscWriter.hpp:32
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:178
std::uint64_t uint64
The Arp unsigned integer type of 8 byte size.
Definition: PrimitiveTypes.hpp:40
std::uint8_t uint8
The Arp unsigned integer type of 1 byte size.
Definition: PrimitiveTypes.hpp:28
NetloadLimiterErrorCode
This enum contains the error codes for the operations of the netload limiter services.
Definition: NetloadLimiterErrorCode.hpp:19
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API