uwUFetch_AUV::uwUFetch_timer Class Reference

#include <uwUFetch_AUV.h>

Inheritance diagram for uwUFetch_AUV::uwUFetch_timer:

Collaboration diagram for uwUFetch_AUV::uwUFetch_timer:

Public Member Functions
	uwUFetch_timer (uwUFetch_AUV *m)
virtual	~uwUFetch_timer ()
virtual void	freeze ()
virtual void	unFreeze ()
virtual void	stop ()
virtual void	schedule (double val)
bool	isIdle ()
bool	isRunning ()
bool	isFroozen ()
bool	isExpired ()
bool	isActive ()
void	resetCounter ()
void	incrCounter ()
int	getCounter ()
double	getDuration ()

Protected Attributes
double	start_time
double	left_duration
int	counter
uwUFetch_AUV *UWUFETCH_TIMER_STATUS	timer_status

Detailed Description

Class that handle the timers of AUV node.

Definition at line 176 of file uwUFetch_AUV.h.

Constructor & Destructor Documentation

uwUFetch_timer()

uwUFetch_AUV::uwUFetch_timer::uwUFetch_timer ( uwUFetch_AUV *  m )

inline

Constructor of uwUFetch_timer class.

Parameters

m	pointer to uwUFetch_AUV class

Definition at line 183 of file uwUFetch_AUV.h.

~uwUFetch_timer()

virtual uwUFetch_AUV::uwUFetch_timer::~uwUFetch_timer ( )

inlinevirtual

Destructor of uwUFetch_timer class.

Definition at line 197 of file uwUFetch_AUV.h.

Member Function Documentation

freeze()

virtual void uwUFetch_AUV::uwUFetch_timer::freeze ( )

inlinevirtual

Freeze the timer.

Definition at line 203 of file uwUFetch_AUV.h.

getCounter()

int uwUFetch_AUV::uwUFetch_timer::getCounter ( )

inline

Counter value.

Returns

int counter

Definition at line 334 of file uwUFetch_AUV.h.

getDuration()

double uwUFetch_AUV::uwUFetch_timer::getDuration ( )

inline

Left duration of the timer.

Returns

double left_duration

Definition at line 345 of file uwUFetch_AUV.h.

incrCounter()

void uwUFetch_AUV::uwUFetch_timer::incrCounter ( )

inline

Increment the counter by one value.

Definition at line 323 of file uwUFetch_AUV.h.

isActive()

bool uwUFetch_AUV::uwUFetch_timer::isActive ( )

inline

Verify if the timer is ACTIVE.

Returns

: bool true ACTIVE

Definition at line 305 of file uwUFetch_AUV.h.

isExpired()

bool uwUFetch_AUV::uwUFetch_timer::isExpired ( )

inline

Verify if the timer is EXPIRED.

Returns

: bool true EXPIRED

Definition at line 294 of file uwUFetch_AUV.h.

isFroozen()

bool uwUFetch_AUV::uwUFetch_timer::isFroozen ( )

inline

Verify if the timer is FROZEN.

Returns

: bool true FROZEN

Definition at line 283 of file uwUFetch_AUV.h.

isIdle()

bool uwUFetch_AUV::uwUFetch_timer::isIdle ( )

inline

Verify if the timer is IDLE.

Returns

: bool true IDLE

Definition at line 261 of file uwUFetch_AUV.h.

isRunning()

bool uwUFetch_AUV::uwUFetch_timer::isRunning ( )

inline

Verify if the timer is RUNNING.

Returns

: bool true RUNNING

Definition at line 272 of file uwUFetch_AUV.h.

resetCounter()

void uwUFetch_AUV::uwUFetch_timer::resetCounter ( )

inline

Reset the counter that scan the timer.

Definition at line 314 of file uwUFetch_AUV.h.

schedule()

virtual void uwUFetch_AUV::uwUFetch_timer::schedule ( double  val )

inlinevirtual

Schedule a timer.

Parameters

val	duration of the timer

Definition at line 247 of file uwUFetch_AUV.h.

stop()

virtual void uwUFetch_AUV::uwUFetch_timer::stop ( )

inlinevirtual

Stop the timer.

Definition at line 235 of file uwUFetch_AUV.h.

unFreeze()

virtual void uwUFetch_AUV::uwUFetch_timer::unFreeze ( )

inlinevirtual

unFreeze are used after a freezing of the timer.

In this case the timer restart from the timer where was freezed

check the state of the timer before sheduling the event. If the timer is set, then the call are aborted

Definition at line 219 of file uwUFetch_AUV.h.

Member Data Documentation

counter

int uwUFetch_AUV::uwUFetch_timer::counter

protected

Counter of the timer.

Definition at line 353 of file uwUFetch_AUV.h.

left_duration

double uwUFetch_AUV::uwUFetch_timer::left_duration

protected

Left duration of the timer.

Definition at line 352 of file uwUFetch_AUV.h.

start_time

double uwUFetch_AUV::uwUFetch_timer::start_time

protected

Time to start the timer.

Definition at line 351 of file uwUFetch_AUV.h.

timer_status

uwUFetch_AUV* UWUFETCH_TIMER_STATUS uwUFetch_AUV::uwUFetch_timer::timer_status

protected

< Pointer to an object of type uwUFetch_AUV

Timer status

Definition at line 355 of file uwUFetch_AUV.h.

---

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

• uwUFetch_AUV.h