Sierra Toolkit  Version of the Day
stk_classic::diag::TimerSet Class Reference

Class TimerSet implements a set of timer classifications. A time classification consists of a bit mask set TimerMask. More...

#include <Timer.hpp>

Public Member Functions

 TimerSet (TimerMask enabled_timer_mask)
 
TimerMask getEnabledTimerMask () const
 
void setEnabledTimerMask (TimerMask timer_mask)
 
bool shouldRecord (TimerMask timer_mask) const
 

Detailed Description

Class TimerSet implements a set of timer classifications. A time classification consists of a bit mask set TimerMask.

Definition at line 117 of file Timer.hpp.

Member Function Documentation

◆ getEnabledTimerMask()

TimerMask stk_classic::diag::TimerSet::getEnabledTimerMask ( ) const
inline

Member function getEnabledTimerMask returns the timer enable bit mask.

Returns
a TimerMask value of the timer enable bit mask.

Definition at line 145 of file Timer.hpp.

◆ setEnabledTimerMask()

void stk_classic::diag::TimerSet::setEnabledTimerMask ( TimerMask  timer_mask)
inline

Member function setEnabledTimerMask set the timer enable bit mask to timer_mask.

Parameters
timer_maska TimerMask value to set the timer enable bit mask to.

Definition at line 157 of file Timer.hpp.

◆ shouldRecord()

bool stk_classic::diag::TimerSet::shouldRecord ( TimerMask  timer_mask) const
inline

Member function shouldRecord returns true if any of the specified timer bit masks are set in the enable timer bit mask.

Parameters
timer_maska TimerMask value to test the enable timer bit mask against.

Definition at line 169 of file Timer.hpp.


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