PClockMock Class Reference

Mock of a clock. More...

#include <PClockMock.h>

Public Member Functions
time_t	now ()
	Get the mocked current time.
PClockMock &	operator= (const PClockMock &other)
	Definition of equal operator of PClockMock.
	PClockMock ()
	Default constructor of PClockMock.
	PClockMock (const PClockMock &other)
	Copy constructor of PClockMock.
void	setCurrentTime (time_t currentTime)
	Set the current time to be recorded.
virtual	~PClockMock ()
	Destructor of PClockMock.

Protected Member Functions
void	copyPClockMock (const PClockMock &other)
	Copy function of PClockMock.

Private Member Functions
void	initialisationPClockMock ()
	Initialisation function of the class PClockMock.

Private Attributes
size_t	p_currentTimeIndex
	Index of the current time.
bool	p_isRecordMode
	True if the clock mock is in record mode.
VecTime	p_vecTime
	Vector of recorded time.

Detailed Description

Mock of a clock.

Definition at line 15 of file PClockMock.h.

Constructor & Destructor Documentation

PClockMock() [1/2]

PClockMock::PClockMock

(

)

Default constructor of PClockMock.

Definition at line 28 of file PClockMock.cpp.

                      {
        initialisationPClockMock();
}

References initialisationPClockMock().

Referenced by copyPClockMock(), operator=(), and PClockMock().

Here is the call graph for this function:

Here is the caller graph for this function:

PClockMock() [2/2]

PClockMock::PClockMock

(

const PClockMock &

other

)

Copy constructor of PClockMock.

Parameters

other

: class to copy

Definition at line 35 of file PClockMock.cpp.

                                              {
        copyPClockMock(other);
}

References copyPClockMock(), and PClockMock().

Here is the call graph for this function:

~PClockMock()

PClockMock::~PClockMock ( )

virtual

Destructor of PClockMock.

Definition at line 40 of file PClockMock.cpp.

                       {
        if(p_isRecordMode){
                //Let's save the vector of times
                phoenix_saveClockMock(p_vecTime);
        }
}

References p_isRecordMode, p_vecTime, and phoenix_saveClockMock().

Here is the call graph for this function:

Member Function Documentation

copyPClockMock()

void PClockMock::copyPClockMock ( const PClockMock & other )

protected

Copy function of PClockMock.

Parameters

other

: class to copy

Definition at line 89 of file PClockMock.cpp.

                                                       {
        p_isRecordMode = other.p_isRecordMode;
        p_vecTime = other.p_vecTime;
        p_currentTimeIndex = other.p_currentTimeIndex;
}

References p_currentTimeIndex, p_isRecordMode, p_vecTime, and PClockMock().

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

Here is the call graph for this function:

Here is the caller graph for this function:

initialisationPClockMock()

void PClockMock::initialisationPClockMock ( )

private

Initialisation function of the class PClockMock.

Definition at line 96 of file PClockMock.cpp.

                                         {
        p_isRecordMode = false;
        p_currentTimeIndex = 0lu;
}

References p_currentTimeIndex, and p_isRecordMode.

Referenced by PClockMock().

Here is the caller graph for this function:

now()

time_t PClockMock::now

(

)

Get the mocked current time.

Returns

mocked current time

Definition at line 59 of file PClockMock.cpp.

                      {
        //If we opened the proper mock file
        if(p_vecTime.size() == 0lu){
                if(!phoenix_loadClockMock(p_vecTime)){
                        std::cerr << "PClockMock::now : cannot load clock mock file 'clock.mock'" << std::endl;
                        return 0l;
                }
        }
        //If the current time index is too high, we loop it
        if(p_currentTimeIndex >= p_vecTime.size()){
                p_currentTimeIndex = 0lu;
        }
        time_t currentTime = p_vecTime[p_currentTimeIndex];
        //Then we increment the current time index
        ++p_currentTimeIndex;
        return currentTime;
}

References p_currentTimeIndex, p_vecTime, and phoenix_loadClockMock().

Here is the call graph for this function:

operator=()

PClockMock & PClockMock::operator=

(

const PClockMock &

other

)

Definition of equal operator of PClockMock.

Parameters

other

: class to copy

Returns

copied class

Definition at line 51 of file PClockMock.cpp.

                                                            {
        copyPClockMock(other);
        return *this;
}

References copyPClockMock(), and PClockMock().

Here is the call graph for this function:

setCurrentTime()

void PClockMock::setCurrentTime

(

time_t

currentTime

)

Set the current time to be recorded.

Parameters

currentTime

: current time to be recorded

Definition at line 80 of file PClockMock.cpp.

                                                 {
        p_isRecordMode = true;
        //Let's record the given time
        p_vecTime.push_back(currentTime);
}

References p_isRecordMode, and p_vecTime.

Member Data Documentation

p_currentTimeIndex

size_t PClockMock::p_currentTimeIndex

private

Index of the current time.

Definition at line 36 of file PClockMock.h.

Referenced by copyPClockMock(), initialisationPClockMock(), and now().

p_isRecordMode

bool PClockMock::p_isRecordMode

private

True if the clock mock is in record mode.

Definition at line 32 of file PClockMock.h.

Referenced by copyPClockMock(), initialisationPClockMock(), setCurrentTime(), and ~PClockMock().

p_vecTime

VecTime PClockMock::p_vecTime

private

Vector of recorded time.

Definition at line 34 of file PClockMock.h.

Referenced by copyPClockMock(), now(), setCurrentTime(), and ~PClockMock().

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/clock/PhoenixClock/src/PClockMock.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/clock/PhoenixClock/src/PClockMock.cpp