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.

Definition at line 153 of file uwpolling_SINK.h.

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

Definition at line 160 of file uwpolling_SINK.h.

~Uwpolling_SINK_Timer()

virtual Uwpolling_SINK::Uwpolling_SINK_Timer::~Uwpolling_SINK_Timer ( )

inlinevirtual

Destructor of the Uwpolling_SINK_Timer class.

Definition at line 174 of file uwpolling_SINK.h.

Member Function Documentation

freeze()

virtual void Uwpolling_SINK::Uwpolling_SINK_Timer::freeze ( )

inlinevirtual

Freeze the timer.

Definition at line 182 of file uwpolling_SINK.h.

getCounter()

int Uwpolling_SINK::Uwpolling_SINK_Timer::getCounter ( )

inline

Returns the counter of the timer.

Returns

the value of the counter of the timer

Definition at line 304 of file uwpolling_SINK.h.

getDuration()

double Uwpolling_SINK::Uwpolling_SINK_Timer::getDuration ( )

inline

Returns the counter of the timer.

Returns

the value of the counter of the timer

Definition at line 314 of file uwpolling_SINK.h.

incrCounter()

void Uwpolling_SINK::Uwpolling_SINK_Timer::incrCounter ( )

inline

Increments the counter of the timer.

Definition at line 294 of file uwpolling_SINK.h.

isActive()

bool Uwpolling_SINK::Uwpolling_SINK_Timer::isActive ( )

inline

Checks if the timer is ACTIVE.

Returns

true or false

Definition at line 275 of file uwpolling_SINK.h.

isExpired()

bool Uwpolling_SINK::Uwpolling_SINK_Timer::isExpired ( )

inline

Checks if the timer is EXPIRED.

Returns

true or false

Definition at line 255 of file uwpolling_SINK.h.

isFrozen()

bool Uwpolling_SINK::Uwpolling_SINK_Timer::isFrozen ( )

inline

Checks if the timer is FROZEN.

Returns

true or false

Definition at line 265 of file uwpolling_SINK.h.

isIdle()

bool Uwpolling_SINK::Uwpolling_SINK_Timer::isIdle ( )

inline

Checks if the timer is IDLE.

Returns

true or false

Definition at line 235 of file uwpolling_SINK.h.

isRunning()

bool Uwpolling_SINK::Uwpolling_SINK_Timer::isRunning ( )

inline

Checks if the timer is RUNNING.

Returns

true or false

Definition at line 245 of file uwpolling_SINK.h.

resetCounter()

void Uwpolling_SINK::Uwpolling_SINK_Timer::resetCounter ( )

inline

Resets the counter of the timer.

Definition at line 285 of file uwpolling_SINK.h.

schedule()

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

inlinevirtual

Schedules a timer.

Parameters

double

the duration of the timer

Definition at line 222 of file uwpolling_SINK.h.

stop()

virtual void Uwpolling_SINK::Uwpolling_SINK_Timer::stop ( )

inlinevirtual

stops the timer

Definition at line 211 of file uwpolling_SINK.h.

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

Definition at line 198 of file uwpolling_SINK.h.

Member Data Documentation

counter

int Uwpolling_SINK::Uwpolling_SINK_Timer::counter

protected

counter of the timer

Definition at line 322 of file uwpolling_SINK.h.

left_duration

double Uwpolling_SINK::Uwpolling_SINK_Timer::left_duration

protected

Left duration of the timer.

Definition at line 321 of file uwpolling_SINK.h.

start_time

double Uwpolling_SINK::Uwpolling_SINK_Timer::start_time

protected

Start Time of the timer.

Definition at line 320 of file uwpolling_SINK.h.

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

Definition at line 325 of file uwpolling_SINK.h.

---

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

• uwpolling_SINK.h