PTimer Class Reference

Timer which allows to call function every time a defined ellapsed time is out. More...

#include <PTimer.h>

Public Member Functions
time_t	getEllapsedTime () const
	Get the ellapsed time in nanoseconds. More...
bool	isTime (time_t &ellapsedTimeNs, time_t currentTime)
	Returns true if the given ellapsed time between to call is passed. More...
bool	isTime (time_t currentTime)
	Returns true if the given ellapsed time between to call is passed. More...
PTimer &	operator= (const PTimer &other)
	Definition of equal operator of PTimer. More...
	PTimer (const PTimer &other)
	Copy constructor of PTimer. More...
	PTimer (time_t ellapsedTime=1lu)
	Default constructor of PTimer. More...
void	setEllapsedTime (time_t ellapsedTime)
	Set the ellapsed time in nanoseconds. More...
void	setStartTime (time_t startTime)
	Start the current clock. More...
virtual	~PTimer ()
	Destructor of PTimer. More...

Protected Member Functions
void	copyPTimer (const PTimer &other)
	Copy function of PTimer. More...

Private Member Functions
void	initialisationPTimer ()
	Initialisation function of the class PTimer. More...

Private Attributes
time_t	p_ellapsedTime
	Ellapsed time between to isTime() returns true (in nanoseconds) More...
time_t	p_startTime
	Clock of the PTimer. More...

Detailed Description

Timer which allows to call function every time a defined ellapsed time is out.

Definition at line 13 of file PTimer.h.

Constructor & Destructor Documentation

PTimer() [1/2]

PTimer::PTimer

(

time_t

ellapsedTime = 1lu

)

Default constructor of PTimer.

Parameters

ellapsedTime

: ellapsed time between two calls (in nanoseconds)

Definition at line 12 of file PTimer.cpp.

        :p_startTime(0l),
        p_ellapsedTime(ellapsedTime)
{
        initialisationPTimer();
}

References initialisationPTimer().

Here is the call graph for this function:

PTimer() [2/2]

PTimer::PTimer

(

const PTimer &

other

)

Copy constructor of PTimer.

Parameters

other

: class to copy

Definition at line 22 of file PTimer.cpp.

                                  {
        copyPTimer(other);
}

References copyPTimer().

Here is the call graph for this function:

~PTimer()

PTimer::~PTimer ( )

virtual

Destructor of PTimer.

Definition at line 27 of file PTimer.cpp.

               {
        
}

Member Function Documentation

copyPTimer()

void PTimer::copyPTimer ( const PTimer &  other )

protected

Copy function of PTimer.

Parameters

other

: class to copy

Definition at line 87 of file PTimer.cpp.

                                           {
        p_ellapsedTime = other.p_ellapsedTime;
        p_startTime = other.p_startTime;
}

References p_ellapsedTime, and p_startTime.

Referenced by operator=(), and PTimer().

Here is the caller graph for this function:

getEllapsedTime()

time_t PTimer::getEllapsedTime

(

)

const

Get the ellapsed time in nanoseconds.

Returns

ellapsed time in nanoseconds

Definition at line 57 of file PTimer.cpp.

                                    {
        return p_ellapsedTime;
}

References p_ellapsedTime.

Referenced by testCopyPtimer().

Here is the caller graph for this function:

initialisationPTimer()

void PTimer::initialisationPTimer ( )

private

Initialisation function of the class PTimer.

Definition at line 93 of file PTimer.cpp.

                                 {
 
}

Referenced by PTimer().

Here is the caller graph for this function:

isTime() [1/2]

bool PTimer::isTime	(	time_t &	ellapsedTimeNs,
		time_t	currentTime
	)

Returns true if the given ellapsed time between to call is passed.

Parameters

[out]	ellapsedTimeNs	: real ellapsed time in nanoseconds between the call of isTime and the last start of the PTimer (maybe in another isTime)
	currentTime	: current time

Returns

true if the given ellapsed time between to call is passed, false otherwise

Definition at line 75 of file PTimer.cpp.

                                                              {
        ellapsedTimeNs = currentTime - p_startTime;
        bool b(ellapsedTimeNs >= p_ellapsedTime);
        if(b){
                setStartTime(currentTime);
        }
        return b;
}

References p_ellapsedTime, p_startTime, and setStartTime().

Here is the call graph for this function:

isTime() [2/2]

bool PTimer::isTime

(

time_t

currentTime

)

Returns true if the given ellapsed time between to call is passed.

Parameters

currentTime

: current time

Returns

true if the given ellapsed time between to call is passed, false otherwise

Definition at line 65 of file PTimer.cpp.

                                     {
        time_t ellapsedTimeNs(0lu);
        return isTime(ellapsedTimeNs, currentTime);
}

Referenced by testPtimer().

Here is the caller graph for this function:

operator=()

PTimer & PTimer::operator=

(

const PTimer &

other

)

Definition of equal operator of PTimer.

Parameters

other

: class to copy

Returns

copied class

Definition at line 35 of file PTimer.cpp.

                                                {
        copyPTimer(other);
        return *this;
}

References copyPTimer().

Here is the call graph for this function:

setEllapsedTime()

void PTimer::setEllapsedTime

(

time_t

ellapsedTime

)

Set the ellapsed time in nanoseconds.

Parameters

ellapsedTime

: ellapsed time in nanoseconds

Definition at line 50 of file PTimer.cpp.

                                               {
        p_ellapsedTime = ellapsedTime;
}

References p_ellapsedTime.

Referenced by testCopyPtimer().

Here is the caller graph for this function:

setStartTime()

void PTimer::setStartTime

(

time_t

currentTime

)

Start the current clock.

Parameters

currentTime

: current time

Definition at line 43 of file PTimer.cpp.

                                           {
        p_startTime = currentTime;
}

References p_startTime.

Referenced by isTime(), and testPtimer().

Here is the caller graph for this function:

Member Data Documentation

p_ellapsedTime

time_t PTimer::p_ellapsedTime

private

Ellapsed time between to isTime() returns true (in nanoseconds)

Definition at line 37 of file PTimer.h.

Referenced by copyPTimer(), getEllapsedTime(), isTime(), and setEllapsedTime().

p_startTime

time_t PTimer::p_startTime

private

Clock of the PTimer.

Definition at line 35 of file PTimer.h.

Referenced by copyPTimer(), isTime(), and setStartTime().

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixClockMock/tmp_project/PhoenixClock/src/PTimer.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixClockMock/tmp_project/PhoenixClock/src/PTimer.cpp