UwCsmaAloha_Trigger_SINK::GenericTimer Class Reference

#include <uw-csma-aloha-trigger-sink.h>

Inheritance diagram for UwCsmaAloha_Trigger_SINK::GenericTimer:

Collaboration diagram for UwCsmaAloha_Trigger_SINK::GenericTimer:

Public Member Functions
	GenericTimer (UwCsmaAloha_Trigger_SINK *m)
virtual	~GenericTimer ()
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
UwCsmaAloha_Trigger_SINK *UW_CS_ALOHA_TRIG_SINK_TIMER_STATUS	timer_status

Detailed Description

Class that describes the timers in the node.

Definition at line 124 of file uw-csma-aloha-trigger-sink.h.

Constructor & Destructor Documentation

GenericTimer()

UwCsmaAloha_Trigger_SINK::GenericTimer::GenericTimer ( UwCsmaAloha_Trigger_SINK *  m )

inline

Constructor of the GenericTimer class.

Parameters

CsmaAloha*

a pointer to an object of type CsmaAloha*

Definition at line 131 of file uw-csma-aloha-trigger-sink.h.

~GenericTimer()

virtual UwCsmaAloha_Trigger_SINK::GenericTimer::~GenericTimer ( )

inlinevirtual

Destructor of the GenericTimer class.

Definition at line 145 of file uw-csma-aloha-trigger-sink.h.

Member Function Documentation

freeze()

virtual void UwCsmaAloha_Trigger_SINK::GenericTimer::freeze ( )

inlinevirtual

Freezes the timer.

Definition at line 153 of file uw-csma-aloha-trigger-sink.h.

getCounter()

int UwCsmaAloha_Trigger_SINK::GenericTimer::getCounter ( )

inline

Returns the counter of the timer.

Returns

the value of the counter of the timer

Definition at line 274 of file uw-csma-aloha-trigger-sink.h.

getDuration()

double UwCsmaAloha_Trigger_SINK::GenericTimer::getDuration ( )

inline

Returns the left duration of the timer.

Returns

left duration of the timer

Definition at line 284 of file uw-csma-aloha-trigger-sink.h.

incrCounter()

void UwCsmaAloha_Trigger_SINK::GenericTimer::incrCounter ( )

inline

Increments the counter of the timer.

Definition at line 264 of file uw-csma-aloha-trigger-sink.h.

isActive()

bool UwCsmaAloha_Trigger_SINK::GenericTimer::isActive ( )

inline

Checks if the timer is ACTIVE.

Returns

true or false

Definition at line 245 of file uw-csma-aloha-trigger-sink.h.

isExpired()

bool UwCsmaAloha_Trigger_SINK::GenericTimer::isExpired ( )

inline

Checks if the timer is EXPIRED.

Returns

true or false

Definition at line 225 of file uw-csma-aloha-trigger-sink.h.

isFrozen()

bool UwCsmaAloha_Trigger_SINK::GenericTimer::isFrozen ( )

inline

Checks if the timer is FROZEN.

Returns

true or false

Definition at line 235 of file uw-csma-aloha-trigger-sink.h.

isIdle()

bool UwCsmaAloha_Trigger_SINK::GenericTimer::isIdle ( )

inline

checks if the timer is IDLE

Returns

bool true or false

Definition at line 205 of file uw-csma-aloha-trigger-sink.h.

isRunning()

bool UwCsmaAloha_Trigger_SINK::GenericTimer::isRunning ( )

inline

checks if the timer is RUNNING

Returns

true or false

Definition at line 215 of file uw-csma-aloha-trigger-sink.h.

resetCounter()

void UwCsmaAloha_Trigger_SINK::GenericTimer::resetCounter ( )

inline

Resets the counter of the timer.

Definition at line 255 of file uw-csma-aloha-trigger-sink.h.

schedule()

virtual void UwCsmaAloha_Trigger_SINK::GenericTimer::schedule ( double  val )

inlinevirtual

schedule a timer

Parameters

double

the duration of the timer

Definition at line 192 of file uw-csma-aloha-trigger-sink.h.

stop()

virtual void UwCsmaAloha_Trigger_SINK::GenericTimer::stop ( )

inlinevirtual

stops the timer

Definition at line 181 of file uw-csma-aloha-trigger-sink.h.

unFreeze()

virtual void UwCsmaAloha_Trigger_SINK::GenericTimer::unFreeze ( )

inlinevirtual

unFreezes is used to resume the timer starting from the point where it was freezed

Definition at line 168 of file uw-csma-aloha-trigger-sink.h.

Member Data Documentation

counter

int UwCsmaAloha_Trigger_SINK::GenericTimer::counter

protected

counter of the timer

Definition at line 294 of file uw-csma-aloha-trigger-sink.h.

left_duration

double UwCsmaAloha_Trigger_SINK::GenericTimer::left_duration

protected

Left duration of the timer.

Definition at line 292 of file uw-csma-aloha-trigger-sink.h.

start_time

double UwCsmaAloha_Trigger_SINK::GenericTimer::start_time

protected

Start Time of the timer.

Definition at line 290 of file uw-csma-aloha-trigger-sink.h.

timer_status

UwCsmaAloha_Trigger_SINK* UW_CS_ALOHA_TRIG_SINK_TIMER_STATUS UwCsmaAloha_Trigger_SINK::GenericTimer::timer_status

protected

< Pointer to an object of type CsmaAloha

Timer status

Definition at line 299 of file uw-csma-aloha-trigger-sink.h.

---

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

• uw-csma-aloha-trigger-sink.h