Dataflow Runtime API  4.0.1.0
Public Member Functions | List of all members
imt::base::dff::runtime::RuntimeStatisticsEvents Class Reference

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

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

Public Member Functions

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

Detailed Description

Holds the data for the event usage statistics.

Constructor & Destructor Documentation

◆ RuntimeStatisticsEvents()

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

Constructor.

◆ ~RuntimeStatisticsEvents()

virtual imt::base::dff::runtime::RuntimeStatisticsEvents::~RuntimeStatisticsEvents ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ reset()

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

Resets the event statistics.

◆ 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.

◆ 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.

◆ updateAverageEventsPerSecond()

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

Update the average events per second.

Parameters
averageEventsPerSecondAverage events per second.

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