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

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

~uwUFetch_timer()

virtual uwUFetch_AUV::uwUFetch_timer::~uwUFetch_timer ( )

inlinevirtual

Destructor of uwUFetch_timer class

Member Function Documentation

freeze()

virtual void uwUFetch_AUV::uwUFetch_timer::freeze ( )

inlinevirtual

Freeze the timer

References left_duration, start_time, timer_status, uwUFetch_AUV::UWUFETCH_TIMER_STATUS_FROZEN, and uwUFetch_AUV::UWUFETCH_TIMER_STATUS_RUNNING.

getCounter()

int uwUFetch_AUV::uwUFetch_timer::getCounter ( )

inline

Counter value

Returns

int counter

References counter.

getDuration()

double uwUFetch_AUV::uwUFetch_timer::getDuration ( )

inline

Left duration of the timer

Returns

double left_duration

References left_duration.

incrCounter()

void uwUFetch_AUV::uwUFetch_timer::incrCounter ( )

inline

Increment the counter by one value

References counter.

isActive()

bool uwUFetch_AUV::uwUFetch_timer::isActive ( )

inline

Verify if the timer is ACTIVE

Returns

: bool true ACTIVE

References isFroozen(), isRunning(), and timer_status.

Here is the call graph for this function:

isExpired()

bool uwUFetch_AUV::uwUFetch_timer::isExpired ( )

inline

Verify if the timer is EXPIRED

Returns

: bool true EXPIRED

References timer_status, and uwUFetch_AUV::UWUFETCH_TIMER_STATUS_EXPIRED.

isFroozen()

bool uwUFetch_AUV::uwUFetch_timer::isFroozen ( )

inline

Verify if the timer is FROZEN

Returns

: bool true FROZEN

References timer_status, and uwUFetch_AUV::UWUFETCH_TIMER_STATUS_FROZEN.

Referenced by isActive().

isIdle()

bool uwUFetch_AUV::uwUFetch_timer::isIdle ( )

inline

Verify if the timer is IDLE

Returns

: bool true IDLE

References timer_status, and uwUFetch_AUV::UWUFETCH_TIMER_STATUS_IDLE.

isRunning()

bool uwUFetch_AUV::uwUFetch_timer::isRunning ( )

inline

Verify if the timer is RUNNING

Returns

: bool true RUNNING

References timer_status, and uwUFetch_AUV::UWUFETCH_TIMER_STATUS_RUNNING.

Referenced by isActive().

resetCounter()

void uwUFetch_AUV::uwUFetch_timer::resetCounter ( )

inline

Reset the counter that scan the timer

schedule()

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

inlinevirtual

Schedule a timer

Parameters

val	duration of the timer

References left_duration, start_time, timer_status, and uwUFetch_AUV::UWUFETCH_TIMER_STATUS_RUNNING.

Referenced by uwUFetch_AUV::state_wait_first_DATA(), uwUFetch_AUV::state_wait_first_DATA_without(), uwUFetch_AUV::state_wait_RTS(), and uwUFetch_AUV::stateIdle_AUV().

stop()

virtual void uwUFetch_AUV::uwUFetch_timer::stop ( )

inlinevirtual

Stop the timer

References timer_status, and uwUFetch_AUV::UWUFETCH_TIMER_STATUS_IDLE.

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

References left_duration, start_time, timer_status, uwUFetch_AUV::UWUFETCH_TIMER_STATUS_FROZEN, and uwUFetch_AUV::UWUFETCH_TIMER_STATUS_RUNNING.

Member Data Documentation

counter

int uwUFetch_AUV::uwUFetch_timer::counter

protected

Counter of the timer

Referenced by getCounter(), and incrCounter().

left_duration

double uwUFetch_AUV::uwUFetch_timer::left_duration

protected

Left duration of the timer

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

start_time

double uwUFetch_AUV::uwUFetch_timer::start_time

protected

Time to start the timer

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

timer_status

uwUFetch_AUV* UWUFETCH_TIMER_STATUS uwUFetch_AUV::uwUFetch_timer::timer_status

protected

< Pointer to an object of type uwUFetch_AUV Timer status

Referenced by uwUFetch_AUV::uwUFetch_TRIGGER_timer::expire(), freeze(), isActive(), isExpired(), isFroozen(), isIdle(), isRunning(), schedule(), stop(), and unFreeze().

---

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

• DESERT_Framework/DESERT/data_link/uwUFetch/uwUFetch_AUV.h