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

#include <uwpolling_NODE.h>

Inheritance diagram for Uwpolling_NODE::Uwpolling_NODE_Timer:
Inheritance graph
[legend]
Collaboration diagram for Uwpolling_NODE::Uwpolling_NODE_Timer:
Collaboration graph
[legend]

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.

Definition at line 153 of file uwpolling_NODE.h.

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

Definition at line 160 of file uwpolling_NODE.h.

◆ ~Uwpolling_NODE_Timer()

virtual Uwpolling_NODE::Uwpolling_NODE_Timer::~Uwpolling_NODE_Timer ( )
inlinevirtual

Destructor of the Uwpolling_NODE_Timer class.

Definition at line 174 of file uwpolling_NODE.h.

Member Function Documentation

◆ freeze()

virtual void Uwpolling_NODE::Uwpolling_NODE_Timer::freeze ( )
inlinevirtual

Freeze the timer.

Definition at line 182 of file uwpolling_NODE.h.

◆ getCounter()

int Uwpolling_NODE::Uwpolling_NODE_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_NODE.h.

◆ getDuration()

double Uwpolling_NODE::Uwpolling_NODE_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_NODE.h.

◆ incrCounter()

void Uwpolling_NODE::Uwpolling_NODE_Timer::incrCounter ( )
inline

Increments the counter of the timer.

Definition at line 294 of file uwpolling_NODE.h.

◆ isActive()

bool Uwpolling_NODE::Uwpolling_NODE_Timer::isActive ( )
inline

Checks if the timer is ACTIVE.

Returns
true or false

Definition at line 275 of file uwpolling_NODE.h.

◆ isExpired()

bool Uwpolling_NODE::Uwpolling_NODE_Timer::isExpired ( )
inline

Checks if the timer is EXPIRED.

Returns
true or false

Definition at line 255 of file uwpolling_NODE.h.

◆ isFrozen()

bool Uwpolling_NODE::Uwpolling_NODE_Timer::isFrozen ( )
inline

Checks if the timer is FROZEN.

Returns
true or false

Definition at line 265 of file uwpolling_NODE.h.

◆ isIdle()

bool Uwpolling_NODE::Uwpolling_NODE_Timer::isIdle ( )
inline

Checks if the timer is IDLE.

Returns
true or false

Definition at line 235 of file uwpolling_NODE.h.

◆ isRunning()

bool Uwpolling_NODE::Uwpolling_NODE_Timer::isRunning ( )
inline

Checks if the timer is RUNNING.

Returns
true or false

Definition at line 245 of file uwpolling_NODE.h.

◆ resetCounter()

void Uwpolling_NODE::Uwpolling_NODE_Timer::resetCounter ( )
inline

Resets the counter of the timer.

Definition at line 285 of file uwpolling_NODE.h.

◆ schedule()

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

Schedules a timer.

Parameters
doublethe duration of the timer

Definition at line 222 of file uwpolling_NODE.h.

◆ stop()

virtual void Uwpolling_NODE::Uwpolling_NODE_Timer::stop ( )
inlinevirtual

stops the timer

Definition at line 211 of file uwpolling_NODE.h.

◆ 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

Definition at line 198 of file uwpolling_NODE.h.

Member Data Documentation

◆ counter

int Uwpolling_NODE::Uwpolling_NODE_Timer::counter
protected

counter of the timer

Definition at line 322 of file uwpolling_NODE.h.

◆ left_duration

double Uwpolling_NODE::Uwpolling_NODE_Timer::left_duration
protected

Left duration of the timer.

Definition at line 321 of file uwpolling_NODE.h.

◆ start_time

double Uwpolling_NODE::Uwpolling_NODE_Timer::start_time
protected

Start Time of the timer.

Definition at line 320 of file uwpolling_NODE.h.

◆ 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

Definition at line 325 of file uwpolling_NODE.h.

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