Generic clock which can use several backends (real clock backend and a mock of clock) More...

#include <PGenericClock.h>

Public Member Functions
PClockMode::PClockMode	getMode () const
	Get the mode of the PGenericClock (NO_MOCK, MOCK or MOCK_RECORD)

time_t	now ()
	Get the current time of the clock.

	PGenericClock ()
	Default constructor of PGenericClock.

void	resetMockIndex ()
	Reset the mock clock to initial state.

void	setMockPrefix (const std::string &mockPrefix)
	Set the mock prefix to load and save the mock with a custom file.

void	setMode (PClockMode::PClockMode mode)
	Set the mode of the PGenericClock (NO_MOCK, MOCK or MOCK_RECORD)

void	sleep (EllapsedTime ellapsedTime) const
	Sleep for a given ellapsed time.

virtual	~PGenericClock ()
	Destructor of PGenericClock.

Protected Member Functions
void	copyPGenericClock (const PGenericClock< _TBackend, _TMockBackend > &other)
	Copy function of PGenericClock.

Private Member Functions
void	initialisationPGenericClock ()
	Initialisation function of the class PGenericClock.

PGenericClock &	operator= (const PGenericClock< _TBackend, _TMockBackend > &other)
	Definition of equal operator of PGenericClock.

	PGenericClock (const PGenericClock< _TBackend, _TMockBackend > &other)
	Copy constructor of PGenericClock.

Private Attributes
_TBackend	p_clockBackend
	Instance of the clock backend (necessary for some clock backends)

_TMockBackend	p_mockBackend
	Instance of the clock backend (necessary for some clock backends)

PClockMode::PClockMode	p_mode
	Mode of the Clock (no mock, mock, mock_record)

Detailed Description

template<typename _TBackend, typename _TMockBackend>
class PGenericClock< _TBackend, _TMockBackend >

Generic clock which can use several backends (real clock backend and a mock of clock)

Definition at line 16 of file PGenericClock.h.

Constructor & Destructor Documentation

◆ PGenericClock() [1/2]

template<typename _TBackend, typename _TMockBackend>

PGenericClock< _TBackend, _TMockBackend >::PGenericClock ( )

Default constructor of PGenericClock.

Definition at line 16 of file PGenericClock_impl.h.

                                                      {
        initialisationPGenericClock();
}

References initialisationPGenericClock().

Referenced by copyPGenericClock(), operator=(), and PGenericClock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~PGenericClock()

template<typename _TBackend, typename _TMockBackend>

PGenericClock< _TBackend, _TMockBackend >::~PGenericClock ( )

virtual

Destructor of PGenericClock.

Definition at line 30 of file PGenericClock_impl.h.

                                                       {
        
}

◆ PGenericClock() [2/2]

template<typename _TBackend, typename _TMockBackend>

PGenericClock< _TBackend, _TMockBackend >::PGenericClock ( const PGenericClock< _TBackend, _TMockBackend > & other )

private

Copy constructor of PGenericClock.

Parameters

other : class to copy

Definition at line 24 of file PGenericClock_impl.h.

                                                                                                           {
        copyPGenericClock(other);
}

References copyPGenericClock(), and PGenericClock().

Here is the call graph for this function:

Member Function Documentation

◆ copyPGenericClock()

template<typename _TBackend, typename _TMockBackend>

void PGenericClock< _TBackend, _TMockBackend >::copyPGenericClock ( const PGenericClock< _TBackend, _TMockBackend > & other )

protected

Copy function of PGenericClock.

Parameters

other : class to copy

Definition at line 108 of file PGenericClock_impl.h.

                                                                                                                    {
        p_mode = other.p_mode;
}

References p_mode, and PGenericClock().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMode()

template<typename _TBackend, typename _TMockBackend>

PClockMode::PClockMode PGenericClock< _TBackend, _TMockBackend >::getMode ( ) const

Get the mode of the PGenericClock (NO_MOCK, MOCK or MOCK_RECORD)

Returns: mode of the PGenericClock

Definition at line 56 of file PGenericClock_impl.h.

                                                                           {
        return p_mode;
}

References p_mode.

◆ initialisationPGenericClock()

template<typename _TBackend, typename _TMockBackend>

void PGenericClock< _TBackend, _TMockBackend >::initialisationPGenericClock ( )

private

Initialisation function of the class PGenericClock.

Definition at line 114 of file PGenericClock_impl.h.

                                                                         {
        p_mode = PClockMode::NO_MOCK;
}

References PClockMode::NO_MOCK, and p_mode.

Referenced by PGenericClock().

Here is the caller graph for this function:

◆ now()

template<typename _TBackend, typename _TMockBackend>

time_t PGenericClock< _TBackend, _TMockBackend >::now ( )

Get the current time of the clock.

Returns: current time of the clock (the unit is given by the used backend, second for clock, ns for system_clock, etc)

Definition at line 64 of file PGenericClock_impl.h.

                                                   {
        if(p_mode == PClockMode::NO_MOCK){
                return p_clockBackend.now();
        }else if(p_mode == PClockMode::MOCK){
                return p_mockBackend.now();
        }else{
                time_t currentTime = p_clockBackend.now();
                p_mockBackend.setCurrentTime(currentTime);
                return currentTime;
        }
}

References PClockMode::MOCK, PClockMode::NO_MOCK, p_clockBackend, p_mockBackend, and p_mode.

◆ operator=()

template<typename _TBackend, typename _TMockBackend>

PGenericClock< _TBackend, _TMockBackend > & PGenericClock< _TBackend, _TMockBackend >::operator= ( const PGenericClock< _TBackend, _TMockBackend > & other )

private

Definition of equal operator of PGenericClock.

Parameters

other : class to copy

Returns: copied class

Definition at line 39 of file PGenericClock_impl.h.

                                                                                                                                                   {
        copyPGenericClock(other);
        return *this;
}

References copyPGenericClock(), and PGenericClock().

Here is the call graph for this function:

◆ resetMockIndex()

template<typename _TBackend, typename _TMockBackend>

void PGenericClock< _TBackend, _TMockBackend >::resetMockIndex ( )

Reset the mock clock to initial state.

Definition at line 98 of file PGenericClock_impl.h.

                                                            {
        if(p_mode == PClockMode::MOCK){
                p_mockBackend.resetIndex();
        }
}

References PClockMode::MOCK, p_mockBackend, and p_mode.

◆ setMockPrefix()

template<typename _TBackend, typename _TMockBackend>

void PGenericClock< _TBackend, _TMockBackend >::setMockPrefix ( const std::string & mockPrefix )

Set the mock prefix to load and save the mock with a custom file.

Parameters

mockPrefix : mock prefix

Definition at line 92 of file PGenericClock_impl.h.

                                                                                       {
        p_mockBackend.setMockPrefix(mockPrefix);
}

References p_mockBackend.

◆ setMode()

template<typename _TBackend, typename _TMockBackend>

void PGenericClock< _TBackend, _TMockBackend >::setMode ( PClockMode::PClockMode mode )

Set the mode of the PGenericClock (NO_MOCK, MOCK or MOCK_RECORD)

Parameters

mode	: mode of the PGenericClock

Definition at line 48 of file PGenericClock_impl.h.

                                                                              {
        p_mode = mode;
}

References p_mode.

◆ sleep()

template<typename _TBackend, typename _TMockBackend>

void PGenericClock< _TBackend, _TMockBackend >::sleep ( EllapsedTime ellapsedTime ) const

Sleep for a given ellapsed time.

Parameters

ellapsedTime : time to sleep (the unit is given by the used backend, second for clock, ns for system_clock, etc)

Definition at line 80 of file PGenericClock_impl.h.

                                                                                  {
        if(p_mode == PClockMode::NO_MOCK || p_mode == PClockMode::MOCK_RECORD){
                p_clockBackend.sleep(ellapsedTime);
        }else if(p_mode == PClockMode::MOCK){
                p_mockBackend.sleep(ellapsedTime);
        }
}

References PClockMode::MOCK, PClockMode::MOCK_RECORD, PClockMode::NO_MOCK, p_clockBackend, p_mockBackend, and p_mode.

Member Data Documentation

◆ p_clockBackend

template<typename _TBackend, typename _TMockBackend>

_TBackend PGenericClock< _TBackend, _TMockBackend >::p_clockBackend

private

Instance of the clock backend (necessary for some clock backends)

Definition at line 39 of file PGenericClock.h.

Referenced by now(), and sleep().

◆ p_mockBackend

template<typename _TBackend, typename _TMockBackend>

_TMockBackend PGenericClock< _TBackend, _TMockBackend >::p_mockBackend

private

Instance of the clock backend (necessary for some clock backends)

Definition at line 41 of file PGenericClock.h.

Referenced by now(), resetMockIndex(), setMockPrefix(), and sleep().

◆ p_mode

template<typename _TBackend, typename _TMockBackend>

PClockMode::PClockMode PGenericClock< _TBackend, _TMockBackend >::p_mode

private

Mode of the Clock (no mock, mock, mock_record)

Definition at line 37 of file PGenericClock.h.

Referenced by copyPGenericClock(), getMode(), initialisationPGenericClock(), now(), resetMockIndex(), setMode(), and sleep().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/clock/PhoenixClock/src/PGenericClock.h
/builds/CTA-LAPP/PHOENIX_LIBS2/clock/PhoenixClock/src/PGenericClock_impl.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PGenericClock() [1/2]

◆ ~PGenericClock()

◆ PGenericClock() [2/2]

Member Function Documentation

◆ copyPGenericClock()

◆ getMode()

◆ initialisationPGenericClock()

◆ now()

◆ operator=()

◆ resetMockIndex()

◆ setMockPrefix()

◆ setMode()

◆ sleep()

Member Data Documentation

◆ p_clockBackend

◆ p_mockBackend

◆ p_mode