PLCnext API Documentation 25.0.2.69
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Hardware::Nim::Services::LimiterStatistic Class Reference

Statistical values for the NetloadLimiter More...

#include <LimiterStatistic.hpp>

Inheritance diagram for Arp::Hardware::Nim::Services::LimiterStatistic:
Inheritance graph

Public Member Functions

 LimiterStatistic (void)
 Constructs an LimiterStatistic instance.
 
 LimiterStatistic (uint32 movingAverage, uint32 movingAverageMax, uint32 peak, uint64 limitingDuration, uint32 limitingEventCount)
 Constructs an LimiterStatistic instance.
 
void Serialize (RscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
void Serialize (JRscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter. More...
 
void Deserialize (JRscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader. More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable
 RscSerializable (void)=default
 The default constructor.
 

Static Public Member Functions

static size_t GetFieldCount (void)
 Returns the count of fields More...
 

Public Attributes

uint32 MovingAverage = 0
 Moving average over 1 second (1000 measurement cycles per second).
 
uint32 MovingAverageMax = 0
 Max value of Arp.Hardware.Nim.Services.LimiterStatistic.MovingAverage.
 
uint32 Peak = 0
 Max value of a single 1 milli second measurement cycle.
 
uint64 LimitingDuration = 0
 Sum of time the limiter was limiting since last reset (microseconds).
 
uint32 LimitingEventCount = 0
 Number of limiting events since last reset.
 

Detailed Description

Statistical values for the NetloadLimiter

Member Function Documentation

◆ Deserialize() [1/2]

void Arp::Hardware::Nim::Services::LimiterStatistic::Deserialize ( JRscReader &  reader)

Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader.

Parameters
readerReference to RscReader.

◆ Deserialize() [2/2]

void Arp::Hardware::Nim::Services::LimiterStatistic::Deserialize ( RscReader reader)

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters
readerReference to RscReader.

◆ GetFieldCount()

size_t Arp::Hardware::Nim::Services::LimiterStatistic::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ Serialize() [1/2]

void Arp::Hardware::Nim::Services::LimiterStatistic::Serialize ( JRscWriter &  writer) const

Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter.

Parameters
writerReference to RscWriter

◆ Serialize() [2/2]

void Arp::Hardware::Nim::Services::LimiterStatistic::Serialize ( RscWriter writer) const

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters
writerReference to RscWriter

The documentation for this class was generated from the following files: