CCountdownTimer Class Reference

CCountdownTimer. More...

#include <CountdownTimer.h>

Inheritance diagram for CCountdownTimer:

List of all members.

Public Member Functions
	CCountdownTimer (uint64 InitialTime)
	CCountdownTimer.
virtual	~CCountdownTimer ()
	CCountdownTimer.
void	Reset ()
	Reset.
void	Reset (uint64 duration)
	Reset.
int64	GetTimeRemaining ()
	GetTimeRemaining.
bool	IsExpired ()
	IsExpired.
void	Pause ()
	Pause.
void	Resume ()
	Resume.

---

Detailed Description

CCountdownTimer.

Description: Basic timer class.

Limitations: This class is not thread safe!

---

Constructor & Destructor Documentation

CCountdownTimer::CCountdownTimer (  uint64  uiInitialTime  )

CCountdownTimer. Description: Initializes the timer's interal attributes. Returns: None Limitations: None

CCountdownTimer::~CCountdownTimer (   )  [virtual]

CCountdownTimer. Description: Returns: None Limitations: None

---

Member Function Documentation

int64 CCountdownTimer::GetTimeRemaining (   )

GetTimeRemaining. Description: This function returns the time remaining Returns: uint32: The number of milliseconds remaining on the clock. If the time has expired, this value may be negative. Limitations: None.

bool CCountdownTimer::IsExpired (   )

IsExpired. Description: This function test to see if the countdown timer has expired. Returns: bool: True if the timer has expired, or false if time remains on the clock. Limitations: None

void CCountdownTimer::Pause (   )

Pause. Description: Returns: void Limitations: None

void CCountdownTimer::Reset (  uint64  duration  )

Reset. Description: Resets the countdown timer using the new duration value. Parameters: duration  is the amount of time to put on the timer. Returns: void Limitations: None.

void CCountdownTimer::Reset (   )

Reset. Description: Resets the countdown timer. Returns: void Limitations: None. Reimplemented from CTimer.

void CCountdownTimer::Resume (   )

Resume. Description: Returns: void Limitations: None

---

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

• Common/CountdownTimer.h
• Common/CountdownTimer.cpp

---

Copyright (c) 2005 Matt Bruns, Pat Hammond, Kevin Markussen, Travis Service, Brain Shaver