Timer Class Reference

List of all members.

---

Detailed Description

Timer object.

The Timer class is used for keeping time intervals.

It may be used to perform some periodic actions. For example to print simulation statistics each second:

  Timer t(1000);

  while (1)
  {
    // simulation...

    if (t.elapsed())
    {
      // print statistics...
    }
  }

One timer's tick is equal to one millisecond.

To change timer's interval the following code can be used:

  Timer t; // default interval - 1 second
  t = Timer(2000); // 2 seconds
  t = Timer(500);  // 1/2 second

Public Types

• typedef long tick_type

  Tick type.
  

Public Member Functions

• Timer ()

  Default interval.
  

• Timer (tick_type ms)

  Set timer's interval.
  

• tick_type interval () const

  Get timer's interval.
  

• bool elapsed () const

  Check timer.
  

• void force ()

  Force timer.
  

---

Member Typedef Documentation

typedef long tick_type

Tick type.

---

Constructor & Destructor Documentation

Timer

(

)

Default interval.

This constructor initializes the timer's interval by one second.

Timer

(

tick_type

ms

)

[explicit]

Set timer's interval.

This constructor initializes the timer's interval by ms milliseconds.

Parameters:

[in]

ms

Timer's interval in milliseconds.

---

Member Function Documentation

Timer::tick_type interval

(

)

const

Get timer's interval.

This method returns the current timer's interval.

Returns:

Timer's interval in milliseconds.

bool elapsed

(

)

const

Check timer.

This method checks the timer's interval is elapsed.

Returns:

true if timer's interval is elapsed, otherwise false.

void force

(

)

Force timer.

This method forces the timer, so next elapsed() method call will return true.

---