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

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

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

Public Member Functions

 RuntimeStatisticsCpu ()
 Constructor. More...
 
virtual ~RuntimeStatisticsCpu ()
 Destructor. More...
 
void updateAverageCpuLoad (int16_t const average)
 Update the average value. More...
 
int16_t getAverageCpuLoad () const
 Returns the average cpu load. More...
 
int16_t getMaxCpuLoad () const
 Returns the maximum cpu load. More...
 
void reset ()
 Resets the cpu statistics. More...
 

Static Public Attributes

static int16_t const CPU_LOAD_INVALID = -1
 Constant which represents an invalid cpu load. More...
 

Detailed Description

Holds the data for the cpu usage statistics.

Constructor & Destructor Documentation

◆ RuntimeStatisticsCpu()

imt::base::dff::runtime::RuntimeStatisticsCpu::RuntimeStatisticsCpu ( )
inline

Constructor.

◆ ~RuntimeStatisticsCpu()

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

Destructor.

Member Function Documentation

◆ getAverageCpuLoad()

int16_t imt::base::dff::runtime::RuntimeStatisticsCpu::getAverageCpuLoad ( ) const
inline

Returns the average cpu load.

Returns
CPU load in percent [0..100] or CPU_LOAD_INVALID.

◆ getMaxCpuLoad()

int16_t imt::base::dff::runtime::RuntimeStatisticsCpu::getMaxCpuLoad ( ) const
inline

Returns the maximum cpu load.

Returns
CPU load in percent [0..100] or CPU_LOAD_INVALID.

◆ reset()

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

Resets the cpu statistics.

◆ updateAverageCpuLoad()

void imt::base::dff::runtime::RuntimeStatisticsCpu::updateAverageCpuLoad ( int16_t const  average)
inline

Update the average value.

Parameters
averageCPU load in percent [0..100] or CPU_LOAD_INVALID.

Member Data Documentation

◆ CPU_LOAD_INVALID

int16_t const imt::base::dff::runtime::RuntimeStatisticsCpu::CPU_LOAD_INVALID = -1
static

Constant which represents an invalid cpu load.


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