Uwpolling_NODE::Uwpolling_NODE_Timer Class Reference

#include <uwpolling_NODE.h>

Inheritance diagram for Uwpolling_NODE::Uwpolling_NODE_Timer:

Collaboration diagram for Uwpolling_NODE::Uwpolling_NODE_Timer:

Public Member Functions
	Uwpolling_NODE_Timer (Uwpolling_NODE *m)
virtual	~Uwpolling_NODE_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_NODE *UWPOLLING_TIMER_STATUS	timer_status

Detailed Description

Class that describes the timer in the AUV

Constructor & Destructor Documentation

Uwpolling_NODE_Timer()

Uwpolling_NODE::Uwpolling_NODE_Timer::Uwpolling_NODE_Timer ( Uwpolling_NODE *  m )

inline

Constructor of the Uwpolling_NODE_Timer class

Parameters

Uwpolling_AUV*

a pointer to an object of type Uwpolling_AUV

~Uwpolling_NODE_Timer()

virtual Uwpolling_NODE::Uwpolling_NODE_Timer::~Uwpolling_NODE_Timer ( )

inlinevirtual

Destructor of the Uwpolling_NODE_Timer class

Member Function Documentation

freeze()

virtual void Uwpolling_NODE::Uwpolling_NODE_Timer::freeze ( )

inlinevirtual

Freeze the timer

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

getCounter()

int Uwpolling_NODE::Uwpolling_NODE_Timer::getCounter ( )

inline

Returns the counter of the timer

Returns

the value of the counter of the timer

References counter.

getDuration()

double Uwpolling_NODE::Uwpolling_NODE_Timer::getDuration ( )

inline

Returns the counter of the timer

Returns

the value of the counter of the timer

References left_duration.

Referenced by Uwpolling_NODE::stateWaitPoll().

incrCounter()

void Uwpolling_NODE::Uwpolling_NODE_Timer::incrCounter ( )

inline

Increments the counter of the timer

References counter.

isActive()

bool Uwpolling_NODE::Uwpolling_NODE_Timer::isActive ( )

inline

Checks if the timer is ACTIVE

Returns

true or false

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

isExpired()

bool Uwpolling_NODE::Uwpolling_NODE_Timer::isExpired ( )

inline

Checks if the timer is EXPIRED

Returns

true or false

References timer_status, and Uwpolling_NODE::UWPOLLING_EXPIRED.

isFrozen()

bool Uwpolling_NODE::Uwpolling_NODE_Timer::isFrozen ( )

inline

Checks if the timer is FROZEN

Returns

true or false

References timer_status, and Uwpolling_NODE::UWPOLLING_FROZEN.

isIdle()

bool Uwpolling_NODE::Uwpolling_NODE_Timer::isIdle ( )

inline

Checks if the timer is IDLE

Returns

true or false

References timer_status, and Uwpolling_NODE::UWPOLLING_IDLE.

isRunning()

bool Uwpolling_NODE::Uwpolling_NODE_Timer::isRunning ( )

inline

Checks if the timer is RUNNING

Returns

true or false

References timer_status, and Uwpolling_NODE::UWPOLLING_RUNNING.

resetCounter()

void Uwpolling_NODE::Uwpolling_NODE_Timer::resetCounter ( )

inline

Resets the counter of the timer

schedule()

virtual void Uwpolling_NODE::Uwpolling_NODE_Timer::schedule ( double  val )

inlinevirtual

Schedules a timer

Parameters

double

the duration of the timer

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

Referenced by Uwpolling_NODE::Phy2MacEndTx(), Uwpolling_NODE::stateRxPoll(), Uwpolling_NODE::stateRxTrigger(), and Uwpolling_NODE::stateWaitPoll().

stop()

virtual void Uwpolling_NODE::Uwpolling_NODE_Timer::stop ( )

inlinevirtual

stops the timer

References timer_status, and Uwpolling_NODE::UWPOLLING_IDLE.

unFreeze()

virtual void Uwpolling_NODE::Uwpolling_NODE_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_NODE::UWPOLLING_FROZEN, and Uwpolling_NODE::UWPOLLING_RUNNING.

Member Data Documentation

counter

int Uwpolling_NODE::Uwpolling_NODE_Timer::counter

protected

counter of the timer

Referenced by getCounter(), and incrCounter().

left_duration

double Uwpolling_NODE::Uwpolling_NODE_Timer::left_duration

protected

Left duration of the timer

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

start_time

double Uwpolling_NODE::Uwpolling_NODE_Timer::start_time

protected

Start Time of the timer

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

timer_status

Uwpolling_NODE* UWPOLLING_TIMER_STATUS Uwpolling_NODE::Uwpolling_NODE_Timer::timer_status

protected

< Pointer to an object of type Uwpolling_AUV Timer status

Referenced by Uwpolling_NODE::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_NODE.h