PClockNs Class Reference

Nanosecond clock. More...

#include <PClockNs.h>

Public Types
typedef std::chrono::nanoseconds	Nanosecond
typedef std::chrono::steady_clock	SteadyClock
typedef std::chrono::time_point< SteadyClock >	TimeNs

Public Member Functions
std::string	getDateCompactNs () const
	Get the date at nanosecond precision (even if it is not precise at the nanosecond scale, it is normally coherent at this scale) More...
std::string	getDateNs () const
	Get the date at nanosecond precision (even if it is not precise at the nanosecond scale, it is normally coherent at this scale) More...
std::time_t	getFullTimeNs () const
	Get the full time in nanoseconds. More...
std::time_t	getOffsetTimeNs () const
	Get the offset in nanoseconds of the current clock. More...
PClockNs &	operator= (const PClockNs &other)
	Definition of equal operator of PClockNs. More...
	PClockNs ()
	Default constructor of PClockNs. More...
	PClockNs (const PClockNs &other)
	Copy constructor of PClockNs. More...
void	setOffsetTimeNs (std::time_t offsetTimeNs)
	Set the offset in nanoseconds of the current clock. More...
virtual	~PClockNs ()
	Destructor of PClockNs. More...

Protected Member Functions
void	copyPClockNs (const PClockNs &other)
	Copy function of PClockNs. More...

Private Member Functions
void	initialisationPClockNs ()
	Initialisation function of the class PClockNs. More...

Private Attributes
TimeNs	p_baseSteadyClockNs
	Base clock time with a nanosecond precision but since the starting of the CPU. More...
std::time_t	p_baseSystemClockSecond
	Base of the system clock in second. More...
std::time_t	p_offsetTimeNs
	Offset of time with date and nanoseconds. More...

Detailed Description

Nanosecond clock.

Definition at line 16 of file PClockNs.h.

Member Typedef Documentation

Nanosecond

typedef std::chrono::nanoseconds PClockNs::Nanosecond

Definition at line 19 of file PClockNs.h.

SteadyClock

typedef std::chrono::steady_clock PClockNs::SteadyClock

Definition at line 18 of file PClockNs.h.

TimeNs

typedef std::chrono::time_point<SteadyClock> PClockNs::TimeNs

Definition at line 20 of file PClockNs.h.

Constructor & Destructor Documentation

PClockNs() [1/2]

PClockNs::PClockNs

(

)

Default constructor of PClockNs.

Definition at line 43 of file PClockNs.cpp.

                  {
        initialisationPClockNs();
}

References initialisationPClockNs().

Here is the call graph for this function:

PClockNs() [2/2]

PClockNs::PClockNs

(

const PClockNs &

other

)

Copy constructor of PClockNs.

Parameters

other

: class to copy

Definition at line 50 of file PClockNs.cpp.

                                        {
        copyPClockNs(other);
}

References copyPClockNs().

Here is the call graph for this function:

~PClockNs()

PClockNs::~PClockNs ( )

virtual

Destructor of PClockNs.

Definition at line 55 of file PClockNs.cpp.

                   {
        
}

Member Function Documentation

copyPClockNs()

void PClockNs::copyPClockNs ( const PClockNs &  other )

protected

Copy function of PClockNs.

Parameters

other

: class to copy

Definition at line 110 of file PClockNs.cpp.

                                                 {
        p_baseSystemClockSecond = other.p_baseSystemClockSecond;
        p_baseSteadyClockNs = other.p_baseSteadyClockNs;
        p_offsetTimeNs = other.p_offsetTimeNs;
}

References p_baseSteadyClockNs, p_baseSystemClockSecond, and p_offsetTimeNs.

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

Here is the caller graph for this function:

getDateCompactNs()

std::string PClockNs::getDateCompactNs

(

)

const

Get the date at nanosecond precision (even if it is not precise at the nanosecond scale, it is normally coherent at this scale)

Returns

current date in printed in a more compact way

Definition at line 103 of file PClockNs.cpp.

                                          {
        return phoenix_dateCompactNs(getFullTimeNs());
}

References getFullTimeNs(), and phoenix_dateCompactNs().

Referenced by testPClockNs().

Here is the call graph for this function:

Here is the caller graph for this function:

getDateNs()

std::string PClockNs::getDateNs

(

)

const

Get the date at nanosecond precision (even if it is not precise at the nanosecond scale, it is normally coherent at this scale)

Returns

current date

Definition at line 96 of file PClockNs.cpp.

                                   {
        return phoenix_dateNs(getFullTimeNs());
}

References getFullTimeNs(), and phoenix_dateNs().

Referenced by testPClockNs().

Here is the call graph for this function:

Here is the caller graph for this function:

getFullTimeNs()

std::time_t PClockNs::getFullTimeNs

(

)

const

Get the full time in nanoseconds.

Returns

full time in nanoseconds

Definition at line 85 of file PClockNs.cpp.

                                       {
        //Let's get the time in nanoseconds since the start of the PClockNs
        std::time_t ellapsedTimeNsSinceStart = (PClockNs::SteadyClock::now() - p_baseSteadyClockNs).count();
        
        std::time_t fullTimeNs = p_baseSystemClockSecond*1000000000l + ellapsedTimeNsSinceStart;
        return fullTimeNs + p_offsetTimeNs;
}

References p_baseSteadyClockNs, p_baseSystemClockSecond, and p_offsetTimeNs.

Referenced by getDateCompactNs(), getDateNs(), PClockNsBackend::now(), testPClockNs(), and testPClockNsCoherence().

Here is the caller graph for this function:

getOffsetTimeNs()

std::time_t PClockNs::getOffsetTimeNs

(

)

const

Get the offset in nanoseconds of the current clock.

Returns

offset in nanoseconds of the current clock

Definition at line 78 of file PClockNs.cpp.

                                         {
        return p_offsetTimeNs;
}

References p_offsetTimeNs.

Referenced by testPClockNs().

Here is the caller graph for this function:

initialisationPClockNs()

void PClockNs::initialisationPClockNs ( )

private

Initialisation function of the class PClockNs.

Definition at line 117 of file PClockNs.cpp.

                                     {
        p_baseSystemClockSecond = std::time(0);
        p_baseSteadyClockNs = PClockNs::SteadyClock::now();
        p_offsetTimeNs = 0l;
}

References p_baseSteadyClockNs, p_baseSystemClockSecond, and p_offsetTimeNs.

Referenced by PClockNs().

Here is the caller graph for this function:

operator=()

PClockNs & PClockNs::operator=

(

const PClockNs &

other

)

Definition of equal operator of PClockNs.

Parameters

other

: class to copy

Returns

copied class

Definition at line 63 of file PClockNs.cpp.

                                                      {
        copyPClockNs(other);
        return *this;
}

References copyPClockNs().

Here is the call graph for this function:

setOffsetTimeNs()

void PClockNs::setOffsetTimeNs

(

std::time_t

offsetTimeNs

)

Set the offset in nanoseconds of the current clock.

Parameters

offsetTimeNs

: offset in nanoseconds of the current clock

Definition at line 71 of file PClockNs.cpp.

                                                    {
        p_offsetTimeNs = offsetTimeNs;
}

References p_offsetTimeNs.

Referenced by testPClockNs().

Here is the caller graph for this function:

Member Data Documentation

p_baseSteadyClockNs

TimeNs PClockNs::p_baseSteadyClockNs

private

Base clock time with a nanosecond precision but since the starting of the CPU.

Definition at line 44 of file PClockNs.h.

Referenced by copyPClockNs(), getFullTimeNs(), and initialisationPClockNs().

p_baseSystemClockSecond

std::time_t PClockNs::p_baseSystemClockSecond

private

Base of the system clock in second.

Definition at line 42 of file PClockNs.h.

Referenced by copyPClockNs(), getFullTimeNs(), and initialisationPClockNs().

p_offsetTimeNs

std::time_t PClockNs::p_offsetTimeNs

private

Offset of time with date and nanoseconds.

Definition at line 46 of file PClockNs.h.

Referenced by copyPClockNs(), getFullTimeNs(), getOffsetTimeNs(), initialisationPClockNs(), and setOffsetTimeNs().

---

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

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