DESERT 3.5.1
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Uwpolling_AUV::Uwpolling_AUV_Timer Class Reference

#include <uwpolling_AUV.h>

Inheritance diagram for Uwpolling_AUV::Uwpolling_AUV_Timer:
Inheritance graph
[legend]
Collaboration diagram for Uwpolling_AUV::Uwpolling_AUV_Timer:
Collaboration graph
[legend]

Public Member Functions

 Uwpolling_AUV_Timer (Uwpolling_AUV *m)
 
virtual ~Uwpolling_AUV_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_AUV *UWPOLLING_TIMER_STATUS timer_status
 

Detailed Description

Class that describes the timer in the AUV.

Definition at line 265 of file uwpolling_AUV.h.

Constructor & Destructor Documentation

◆ Uwpolling_AUV_Timer()

Uwpolling_AUV::Uwpolling_AUV_Timer::Uwpolling_AUV_Timer ( Uwpolling_AUV *  m)
inline

Constructor of the Uwpolling_AUV_Timer class.

Parameters
Uwpolling_AUV*a pointer to an object of type Uwpolling_AUV

Definition at line 272 of file uwpolling_AUV.h.

◆ ~Uwpolling_AUV_Timer()

virtual Uwpolling_AUV::Uwpolling_AUV_Timer::~Uwpolling_AUV_Timer ( )
inlinevirtual

Destructor of the Uwpolling_AUV_Timer class.

Definition at line 286 of file uwpolling_AUV.h.

Member Function Documentation

◆ freeze()

virtual void Uwpolling_AUV::Uwpolling_AUV_Timer::freeze ( )
inlinevirtual

Freeze the timer.

Definition at line 294 of file uwpolling_AUV.h.

◆ getCounter()

int Uwpolling_AUV::Uwpolling_AUV_Timer::getCounter ( )
inline

Returns the counter of the timer.

Returns
the value of the counter of the timer

Definition at line 416 of file uwpolling_AUV.h.

◆ getDuration()

double Uwpolling_AUV::Uwpolling_AUV_Timer::getDuration ( )
inline

Returns the left duration of the timer.

Returns
the value of the counter of the timer

Definition at line 426 of file uwpolling_AUV.h.

◆ incrCounter()

void Uwpolling_AUV::Uwpolling_AUV_Timer::incrCounter ( )
inline

Increments the counter of the timer.

Definition at line 406 of file uwpolling_AUV.h.

◆ isActive()

bool Uwpolling_AUV::Uwpolling_AUV_Timer::isActive ( )
inline

Checks if the timer is ACTIVE.

Returns
true or false

Definition at line 387 of file uwpolling_AUV.h.

◆ isExpired()

bool Uwpolling_AUV::Uwpolling_AUV_Timer::isExpired ( )
inline

Checks if the timer is EXPIRED.

Returns
true or false

Definition at line 367 of file uwpolling_AUV.h.

◆ isFrozen()

bool Uwpolling_AUV::Uwpolling_AUV_Timer::isFrozen ( )
inline

Checks if the timer is FROZEN.

Returns
true or false

Definition at line 377 of file uwpolling_AUV.h.

◆ isIdle()

bool Uwpolling_AUV::Uwpolling_AUV_Timer::isIdle ( )
inline

Checks if the timer is IDLE.

Returns
bool true or false

Definition at line 347 of file uwpolling_AUV.h.

◆ isRunning()

bool Uwpolling_AUV::Uwpolling_AUV_Timer::isRunning ( )
inline

Checks if the timer is RUNNING.

Returns
true or false

Definition at line 357 of file uwpolling_AUV.h.

◆ resetCounter()

void Uwpolling_AUV::Uwpolling_AUV_Timer::resetCounter ( )
inline

Resets the counter of the timer.

Definition at line 397 of file uwpolling_AUV.h.

◆ schedule()

virtual void Uwpolling_AUV::Uwpolling_AUV_Timer::schedule ( double  val)
inlinevirtual

Schedules a timer.

Parameters
doublethe duration of the timer

Definition at line 334 of file uwpolling_AUV.h.

◆ stop()

virtual void Uwpolling_AUV::Uwpolling_AUV_Timer::stop ( )
inlinevirtual

stops the timer

Definition at line 323 of file uwpolling_AUV.h.

◆ unFreeze()

virtual void Uwpolling_AUV::Uwpolling_AUV_Timer::unFreeze ( )
inlinevirtual

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

Definition at line 310 of file uwpolling_AUV.h.

Member Data Documentation

◆ counter

int Uwpolling_AUV::Uwpolling_AUV_Timer::counter
protected

counter of the timer

Definition at line 434 of file uwpolling_AUV.h.

◆ left_duration

double Uwpolling_AUV::Uwpolling_AUV_Timer::left_duration
protected

Left duration of the timer.

Definition at line 433 of file uwpolling_AUV.h.

◆ start_time

double Uwpolling_AUV::Uwpolling_AUV_Timer::start_time
protected

Start Time of the timer.

Definition at line 432 of file uwpolling_AUV.h.

◆ timer_status

Uwpolling_AUV* UWPOLLING_TIMER_STATUS Uwpolling_AUV::Uwpolling_AUV_Timer::timer_status
protected

< Pointer to an object of type Uwpolling_AUV

Timer status

Definition at line 437 of file uwpolling_AUV.h.

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