stk::diag::TimerSet Class Reference

Class TimerSet implements a set of timer classifications. More...

#include <Timer.hpp>

List of all members.

Public Member Functions
	TimerSet (TimerMask enabled_timer_mask)
TimerMask	getEnabledTimerMask () const
	Member function getEnabledTimerMask returns the timer enable bit mask.
void	setEnabledTimerMask (TimerMask timer_mask)
	Member function setEnabledTimerMask set the timer enable bit mask to timer_mask.
bool	shouldRecord (TimerMask timer_mask) const
	Member function shouldRecord returns true if any of the specified timer bit masks are set in the enable timer bit mask.

---

Detailed Description

Class TimerSet implements a set of timer classifications.

A time classification consists of a bit mask set TimerMask

Definition at line 107 of file Timer.hpp.

---

Member Function Documentation

TimerMask stk::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 135 of file Timer.hpp.

void stk::diag::TimerSet::setEnabledTimerMask

(

TimerMask

timer_mask

)

[inline]

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

Parameters:

timer_mask

a TimerMask value to set the timer enable bit mask to.

Definition at line 147 of file Timer.hpp.

bool stk::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_mask

a TimerMask value to test the enable timer bit mask against.

Definition at line 159 of file Timer.hpp.

---

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

• Timer.hpp