Imt.Base C++ API V4.1.1.0
Loading...
Searching...
No Matches
imt::base::dff::runtime::RuntimeStatisticsEvents Class Referencefinal

Holds the data for the event usage statistics. More...

#include <Imt.Base.Dff.Runtime/inc/Imt.Base.Dff.Runtime/RuntimeStatisticsEvents.h>

Public Member Functions

constexpr RuntimeStatisticsEvents (size_t const poolSize, size_t const smallPoolSize=0U) noexcept
 Constructor.
 
void updateAverageEventsPerSecond (uint32_t const averageEventsPerSecond)
 Update the average events per second.
 
void setEventsAvailable (size_t const eventsAvailable)
 Set the current available events, which will also update the minimum available events.
 
void setEventsAvailableSmall (size_t const eventsAvailableSmall)
 Set the current available small events, which will also update the minimum available small events.
 
void reset ()
 Resets the event statistics.
 

Detailed Description

Holds the data for the event usage statistics.

Definition at line 50 of file RuntimeStatisticsEvents.h.

Constructor & Destructor Documentation

◆ RuntimeStatisticsEvents()

constexpr imt::base::dff::runtime::RuntimeStatisticsEvents::RuntimeStatisticsEvents ( size_t const  poolSize,
size_t const  smallPoolSize = 0U 
)
inlineexplicitconstexprnoexcept

Constructor.

Definition at line 57 of file RuntimeStatisticsEvents.h.

Member Function Documentation

◆ reset()

void imt::base::dff::runtime::RuntimeStatisticsEvents::reset ( )
inline

Resets the event statistics.

Definition at line 97 of file RuntimeStatisticsEvents.h.

◆ setEventsAvailable()

void imt::base::dff::runtime::RuntimeStatisticsEvents::setEventsAvailable ( size_t const  eventsAvailable)
inline

Set the current available events, which will also update the minimum available events.

Parameters
eventsAvailableRemaining events available.

Definition at line 80 of file RuntimeStatisticsEvents.h.

◆ setEventsAvailableSmall()

void imt::base::dff::runtime::RuntimeStatisticsEvents::setEventsAvailableSmall ( size_t const  eventsAvailableSmall)
inline

Set the current available small events, which will also update the minimum available small events.

Parameters
eventsAvailableSmallRemaining small events available.

Definition at line 89 of file RuntimeStatisticsEvents.h.

◆ updateAverageEventsPerSecond()

void imt::base::dff::runtime::RuntimeStatisticsEvents::updateAverageEventsPerSecond ( uint32_t const  averageEventsPerSecond)
inline

Update the average events per second.

Parameters
averageEventsPerSecondAverage events per second.

Definition at line 71 of file RuntimeStatisticsEvents.h.


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