UWAloha::UWAlohaTimer Class Reference

#include <uwaloha.h>

Inheritance diagram for UWAloha::UWAlohaTimer:

Collaboration diagram for UWAloha::UWAlohaTimer:

Public Member Functions
	UWAlohaTimer (UWAloha *m)
virtual	~UWAlohaTimer ()
virtual void	freeze ()
virtual void	unFreeze ()
virtual void	stop ()
virtual void	schedule (double val)
bool	isIdle ()
bool	isRunning ()
bool	isExpired ()
bool	isFrozen ()
bool	isActive ()
void	resetCounter ()
void	incrCounter ()
int	getCounter ()
double	getDuration ()

Protected Attributes
double	start_time
double	left_duration
int	counter
UWAloha *UWALOHA_TIMER_STATUS	timer_status

Detailed Description

Base class of all the timer used in this protocol.

This is a derived class of TimerHandler.

Definition at line 168 of file uwaloha.h.

Constructor & Destructor Documentation

UWAlohaTimer()

UWAloha::UWAlohaTimer::UWAlohaTimer ( UWAloha *  m )

inline

Constructor of UWAlohaTimer Class.

Definition at line 175 of file uwaloha.h.

~UWAlohaTimer()

virtual UWAloha::UWAlohaTimer::~UWAlohaTimer ( )

inlinevirtual

Destructor of UWAlohaTimer Class.

Definition at line 189 of file uwaloha.h.

Member Function Documentation

freeze()

virtual void UWAloha::UWAlohaTimer::freeze ( )

inlinevirtual

It freezes or in another word, it stops the timer for some time.

Suppose, for some reason we want to stop a timer for some period and we want to run this timer from where it was stopped. This function stops the timer and save the left time duration it must run.

Definition at line 201 of file uwaloha.h.

getCounter()

int UWAloha::UWAlohaTimer::getCounter ( )

inline

It provides, how many times a timer ran.

Returns

number of times a timer ran (int).

Definition at line 322 of file uwaloha.h.

getDuration()

double UWAloha::UWAlohaTimer::getDuration ( )

inline

This methods provide the duration of a timer.

Returns

left time duration of a timer (double).

Definition at line 332 of file uwaloha.h.

incrCounter()

void UWAloha::UWAlohaTimer::incrCounter ( )

inline

Increment the timer counter.

It helps to know the statics of the timer.

Definition at line 312 of file uwaloha.h.

isActive()

bool UWAloha::UWAlohaTimer::isActive ( )

inline

It tells whether the timer is active or not.

Returns

1 if the timer is active and 0 if it is not.

Definition at line 292 of file uwaloha.h.

isExpired()

bool UWAloha::UWAlohaTimer::isExpired ( )

inline

Tells whether the timer is expired or not.

Returns

1 if the timer expired and 0 if it is not.

Definition at line 272 of file uwaloha.h.

isFrozen()

bool UWAloha::UWAlohaTimer::isFrozen ( )

inline

It tells whether the timer is in freeze mode or not.

Returns

1 if the timer is in freeze mode and 0 if it is not.

Definition at line 282 of file uwaloha.h.

isIdle()

bool UWAloha::UWAlohaTimer::isIdle ( )

inline

It tells whether the timer is in Idle state or not.

Returns

1 if the timer is idle and 0 if it is not.

Definition at line 252 of file uwaloha.h.

isRunning()

bool UWAloha::UWAlohaTimer::isRunning ( )

inline

This method tells whether the timer is in Running state or not.

Returns

1 if the timer is running and 0 if it is not.

Definition at line 262 of file uwaloha.h.

resetCounter()

void UWAloha::UWAlohaTimer::resetCounter ( )

inline

Reset the timer counter.

Definition at line 302 of file uwaloha.h.

schedule()

virtual void UWAloha::UWAlohaTimer::schedule ( double  val )

inlinevirtual

Schedule the time, i.e., how long a timer is going to run.

Parameters

double

time

Definition at line 239 of file uwaloha.h.

stop()

virtual void UWAloha::UWAlohaTimer::stop ( )

inlinevirtual

Stop the timer any way.

Definition at line 228 of file uwaloha.h.

unFreeze()

virtual void UWAloha::UWAlohaTimer::unFreeze ( )

inlinevirtual

It starts the timer from where it was stopped.

To run any freeze timer, we can use unfreeze method.

Definition at line 215 of file uwaloha.h.

Member Data Documentation

counter

int UWAloha::UWAlohaTimer::counter

protected

How many times a timer ran.

Definition at line 342 of file uwaloha.h.

left_duration

double UWAloha::UWAlohaTimer::left_duration

protected

How long a timer is going to run more.

Definition at line 340 of file uwaloha.h.

start_time

double UWAloha::UWAlohaTimer::start_time

protected

Start time of a timer.

Definition at line 338 of file uwaloha.h.

timer_status

UWAloha* UWALOHA_TIMER_STATUS UWAloha::UWAlohaTimer::timer_status

protected

< Pointer of UWAloha module.

Set the status of the timer.

Definition at line 346 of file uwaloha.h.

---

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

• uwaloha.h