Dataflow Runtime API  3.1.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 (const size_t poolSize, const size_t smallPoolSize=0U)
 Constructor. More...
 
virtual ~RuntimeStatisticsEvents (void)
 Destructor. More...
 
void updateAverageEventsPerSecond (const uint32_t averageEventsPerSecond)
 Update the average events per second. More...
 
void setEventsAvailable (const size_t eventsAvailable)
 Set the current available events, which will also update the minimum available events. More...
 
void setEventsAvailableSmall (const size_t eventsAvailableSmall)
 Set the current available small events, which will also update the minimum available small events. More...
 
void reset (void)
 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 ( const size_t  poolSize,
const size_t  smallPoolSize = 0U 
)
inlineexplicit

Constructor.

◆ ~RuntimeStatisticsEvents()

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

Destructor.

Member Function Documentation

◆ reset()

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

Resets the event statistics.

◆ setEventsAvailable()

void imt::base::dff::runtime::RuntimeStatisticsEvents::setEventsAvailable ( const size_t  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 ( const size_t  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 ( const uint32_t  averageEventsPerSecond)
inline

Update the average events per second.

Parameters
averageEventsPerSecondAverage events per second.

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