PeriodicTimer Struct Reference

#include "Timer.h"

Public Member Functions
	PeriodicTimer (int32 period, int32 start_time)
bool	Update (const uint32 diff)
void	SetPeriodic (int32 period, int32 start_time)
void	TUpdate (int32 diff)
bool	TPassed () const
void	TReset (int32 diff, int32 period)

Private Attributes
int32	i_period
int32	i_expireTime

Detailed Description

Constructor & Destructor Documentation

PeriodicTimer()

PeriodicTimer::PeriodicTimer ( int32  period, int32  start_time  )

inline

        : i_period(period), i_expireTime(start_time)
    {
    }

Member Function Documentation

SetPeriodic()

void PeriodicTimer::SetPeriodic ( int32  period, int32  start_time  )

inline

    {
        i_expireTime = start_time;
        i_period = period;
    }

References i_expireTime, and i_period.

TPassed()

bool PeriodicTimer::TPassed ( ) const

inline

{ return i_expireTime <= 0; }

References i_expireTime.

TReset()

void PeriodicTimer::TReset ( int32  diff, int32  period  )

inline

{ i_expireTime += period > diff ? period : diff; }

References i_expireTime.

TUpdate()

void PeriodicTimer::TUpdate ( int32  diff )

inline

{ i_expireTime -= diff; }

References i_expireTime.

Update()

bool PeriodicTimer::Update ( const uint32  diff )

inline

    {
        if ((i_expireTime -= diff) > 0)
        {
            return false;
        }
 
        i_expireTime += i_period > int32(diff) ? i_period : diff;
        return true;
    }

References i_expireTime, and i_period.

Member Data Documentation

i_expireTime

int32 PeriodicTimer::i_expireTime

private

Referenced by SetPeriodic(), TPassed(), TReset(), TUpdate(), and Update().

i_period

int32 PeriodicTimer::i_period

private

Referenced by SetPeriodic(), and Update().