DESERT 3.5.1
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
UWOFDMAloha::UWOFDMAlohaTimer Class Reference

#include <uw-ofdm-aloha.h>

Inheritance diagram for UWOFDMAloha::UWOFDMAlohaTimer:
Inheritance graph
[legend]
Collaboration diagram for UWOFDMAloha::UWOFDMAlohaTimer:
Collaboration graph
[legend]

Public Member Functions

 UWOFDMAlohaTimer (UWOFDMAloha *m)
 
virtual ~UWOFDMAlohaTimer ()
 
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
 
UWOFDMAloha *UWOFDMALOHA_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 177 of file uw-ofdm-aloha.h.

Constructor & Destructor Documentation

◆ UWOFDMAlohaTimer()

UWOFDMAloha::UWOFDMAlohaTimer::UWOFDMAlohaTimer ( UWOFDMAloha *  m)
inline

Constructor of UWOFDMAlohaTimer Class.

Definition at line 184 of file uw-ofdm-aloha.h.

◆ ~UWOFDMAlohaTimer()

virtual UWOFDMAloha::UWOFDMAlohaTimer::~UWOFDMAlohaTimer ( )
inlinevirtual

Destructor of UWOFDMAlohaTimer Class.

Definition at line 198 of file uw-ofdm-aloha.h.

Member Function Documentation

◆ freeze()

virtual void UWOFDMAloha::UWOFDMAlohaTimer::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 210 of file uw-ofdm-aloha.h.

◆ getCounter()

int UWOFDMAloha::UWOFDMAlohaTimer::getCounter ( )
inline

It provides, how many times a timer ran.

Returns
number of times a timer ran (int).

Definition at line 331 of file uw-ofdm-aloha.h.

◆ getDuration()

double UWOFDMAloha::UWOFDMAlohaTimer::getDuration ( )
inline

This methods provide the duration of a timer.

Returns
left time duration of a timer (double).

Definition at line 341 of file uw-ofdm-aloha.h.

◆ incrCounter()

void UWOFDMAloha::UWOFDMAlohaTimer::incrCounter ( )
inline

Increment the timer counter.

It helps to know the statics of the timer.

Definition at line 321 of file uw-ofdm-aloha.h.

◆ isActive()

bool UWOFDMAloha::UWOFDMAlohaTimer::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 301 of file uw-ofdm-aloha.h.

◆ isExpired()

bool UWOFDMAloha::UWOFDMAlohaTimer::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 281 of file uw-ofdm-aloha.h.

◆ isFrozen()

bool UWOFDMAloha::UWOFDMAlohaTimer::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 291 of file uw-ofdm-aloha.h.

◆ isIdle()

bool UWOFDMAloha::UWOFDMAlohaTimer::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 261 of file uw-ofdm-aloha.h.

◆ isRunning()

bool UWOFDMAloha::UWOFDMAlohaTimer::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 271 of file uw-ofdm-aloha.h.

◆ resetCounter()

void UWOFDMAloha::UWOFDMAlohaTimer::resetCounter ( )
inline

Reset the timer counter.

Definition at line 311 of file uw-ofdm-aloha.h.

◆ schedule()

virtual void UWOFDMAloha::UWOFDMAlohaTimer::schedule ( double  val)
inlinevirtual

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

Parameters
doubletime

Definition at line 248 of file uw-ofdm-aloha.h.

◆ stop()

virtual void UWOFDMAloha::UWOFDMAlohaTimer::stop ( )
inlinevirtual

Stop the timer any way.

Definition at line 237 of file uw-ofdm-aloha.h.

◆ unFreeze()

virtual void UWOFDMAloha::UWOFDMAlohaTimer::unFreeze ( )
inlinevirtual

It starts the timer from where it was stopped.

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

Definition at line 224 of file uw-ofdm-aloha.h.

Member Data Documentation

◆ counter

int UWOFDMAloha::UWOFDMAlohaTimer::counter
protected

How many times a timer ran.

Definition at line 352 of file uw-ofdm-aloha.h.

◆ left_duration

double UWOFDMAloha::UWOFDMAlohaTimer::left_duration
protected

How long a timer is going to run more.

Definition at line 350 of file uw-ofdm-aloha.h.

◆ start_time

double UWOFDMAloha::UWOFDMAlohaTimer::start_time
protected

Start time of a timer.

Definition at line 348 of file uw-ofdm-aloha.h.

◆ timer_status

UWOFDMAloha* UWOFDMALOHA_TIMER_STATUS UWOFDMAloha::UWOFDMAlohaTimer::timer_status
protected

< Pointer of UWOFDMAloha module.

Set the status of the timer.

Definition at line 356 of file uw-ofdm-aloha.h.

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