Uwpolling_SINK::Uwpolling_SINK_Timer Class Reference

#include <uwpolling_SINK.h>

Inheritance diagram for Uwpolling_SINK::Uwpolling_SINK_Timer:

Collaboration diagram for Uwpolling_SINK::Uwpolling_SINK_Timer:

Public Member Functions
	Uwpolling_SINK_Timer (Uwpolling_SINK *m)
virtual	~Uwpolling_SINK_Timer ()
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
Uwpolling_SINK *UWPOLLING_TIMER_STATUS	timer_status

Detailed Description

Class that describes the timer in the SINK

Constructor & Destructor Documentation

Uwpolling_SINK_Timer()

Uwpolling_SINK::Uwpolling_SINK_Timer::Uwpolling_SINK_Timer ( Uwpolling_SINK *  m )

inline

Constructor of the Uwpolling_SINK_Timer class

Parameters

Uwpolling_SINK*

a pointer to an object of type Uwpolling_AUV

~Uwpolling_SINK_Timer()

virtual Uwpolling_SINK::Uwpolling_SINK_Timer::~Uwpolling_SINK_Timer ( )

inlinevirtual

Destructor of the Uwpolling_SINK_Timer class

Member Function Documentation

freeze()

virtual void Uwpolling_SINK::Uwpolling_SINK_Timer::freeze ( )

inlinevirtual

Freeze the timer

References left_duration, start_time, timer_status, Uwpolling_SINK::UWPOLLING_FROZEN, and Uwpolling_SINK::UWPOLLING_RUNNING.

getCounter()

int Uwpolling_SINK::Uwpolling_SINK_Timer::getCounter ( )

inline

Returns the counter of the timer

Returns

the value of the counter of the timer

References counter.

getDuration()

double Uwpolling_SINK::Uwpolling_SINK_Timer::getDuration ( )

inline

Returns the counter of the timer

Returns

the value of the counter of the timer

References left_duration.

incrCounter()

void Uwpolling_SINK::Uwpolling_SINK_Timer::incrCounter ( )

inline

Increments the counter of the timer

References counter.

isActive()

bool Uwpolling_SINK::Uwpolling_SINK_Timer::isActive ( )

inline

Checks if the timer is ACTIVE

Returns

true or false

References timer_status, Uwpolling_SINK::UWPOLLING_FROZEN, and Uwpolling_SINK::UWPOLLING_RUNNING.

isExpired()

bool Uwpolling_SINK::Uwpolling_SINK_Timer::isExpired ( )

inline

Checks if the timer is EXPIRED

Returns

true or false

References timer_status, and Uwpolling_SINK::UWPOLLING_EXPIRED.

isFrozen()

bool Uwpolling_SINK::Uwpolling_SINK_Timer::isFrozen ( )

inline

Checks if the timer is FROZEN

Returns

true or false

References timer_status, and Uwpolling_SINK::UWPOLLING_FROZEN.

isIdle()

bool Uwpolling_SINK::Uwpolling_SINK_Timer::isIdle ( )

inline

Checks if the timer is IDLE

Returns

true or false

References timer_status, and Uwpolling_SINK::UWPOLLING_IDLE.

isRunning()

bool Uwpolling_SINK::Uwpolling_SINK_Timer::isRunning ( )

inline

Checks if the timer is RUNNING

Returns

true or false

References timer_status, and Uwpolling_SINK::UWPOLLING_RUNNING.

resetCounter()

void Uwpolling_SINK::Uwpolling_SINK_Timer::resetCounter ( )

inline

Resets the counter of the timer

schedule()

virtual void Uwpolling_SINK::Uwpolling_SINK_Timer::schedule ( double  val )

inlinevirtual

Schedules a timer

Parameters

double

the duration of the timer

References left_duration, start_time, timer_status, and Uwpolling_SINK::UWPOLLING_RUNNING.

Referenced by Uwpolling_SINK::Phy2MacEndRx(), Uwpolling_SINK::stateRxData(), Uwpolling_SINK::stateRxTrigger(), and Uwpolling_SINK::stateWaitData().

stop()

virtual void Uwpolling_SINK::Uwpolling_SINK_Timer::stop ( )

inlinevirtual

stops the timer

References timer_status, and Uwpolling_SINK::UWPOLLING_IDLE.

unFreeze()

virtual void Uwpolling_SINK::Uwpolling_SINK_Timer::unFreeze ( )

inlinevirtual

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

References left_duration, start_time, timer_status, Uwpolling_SINK::UWPOLLING_FROZEN, and Uwpolling_SINK::UWPOLLING_RUNNING.

Member Data Documentation

counter

int Uwpolling_SINK::Uwpolling_SINK_Timer::counter

protected

counter of the timer

Referenced by getCounter(), and incrCounter().

left_duration

double Uwpolling_SINK::Uwpolling_SINK_Timer::left_duration

protected

Left duration of the timer

Referenced by freeze(), getDuration(), schedule(), and unFreeze().

start_time

double Uwpolling_SINK::Uwpolling_SINK_Timer::start_time

protected

Start Time of the timer

Referenced by freeze(), schedule(), and unFreeze().

timer_status

Uwpolling_SINK* UWPOLLING_TIMER_STATUS Uwpolling_SINK::Uwpolling_SINK_Timer::timer_status

protected

< Pointer to an object of type Uwpolling_SINK Timer status

Referenced by Uwpolling_SINK::BackOffTimer::expire(), freeze(), isActive(), isExpired(), isFrozen(), isIdle(), isRunning(), schedule(), stop(), and unFreeze().

---

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

• DESERT_Framework/DESERT/data_link/uwpolling/uwpolling_SINK.h