A C++ wrapper around the POSIX struct timespec coupled to a specific CLOCK type. More...

#include <types.hxx>

Inheritance diagram for cosmos::TimeSpec< CLOCK >:

Public Member Functions
	TimeSpec (time_t seconds, long nano_seconds=0)

	TimeSpec (const std::chrono::milliseconds ms)

	TimeSpec (const std::chrono::nanoseconds ns)

	TimeSpec (const no_init_t)
	Deliberately don't initialize the members for performance reasons.

bool	isZero () const

void	reset ()

time_t	getSeconds () const

long	getNanoseconds () const

void	setSeconds (const time_t seconds)

void	setNanoseconds (const long nano_seconds)

void	addSeconds (const time_t seconds)

void	addNanoseconds (const long nano_seconds)

TimeSpec &	setAsMilliseconds (const size_t milliseconds)

TimeSpec &	set (const std::chrono::milliseconds ms)

TimeSpec &	set (const std::chrono::nanoseconds ns)

size_t	toMilliseconds () const
	Converts the time representation into a single milliseconds value.

	operator std::chrono::milliseconds () const

bool	operator< (const TimeSpec &other) const

bool	operator>= (const TimeSpec &other) const

bool	operator== (const TimeSpec &other) const

bool	operator!= (const TimeSpec &other) const

bool	operator<= (const TimeSpec &other) const

TimeSpec	operator- (const TimeSpec &other) const

TimeSpec	operator+ (const TimeSpec &other) const

Static Protected Attributes
static constexpr long	NANOSECOND_BASE {1000 * 1000 * 1000}

Detailed Description

template<ClockType CLOCK>
class cosmos::TimeSpec< CLOCK >

A C++ wrapper around the POSIX struct timespec coupled to a specific CLOCK type.

Definition at line 56 of file types.hxx.

Constructor & Destructor Documentation

◆ TimeSpec() [1/5]

template<ClockType CLOCK>

cosmos::TimeSpec< CLOCK >::TimeSpec	(	time_t	seconds,
		long	nano_seconds = 0 )

inlineexplicit

Definition at line 59 of file types.hxx.

                                                                 {
                this->tv_sec = seconds;
                this->tv_nsec = nano_seconds;
        }

◆ TimeSpec() [2/5]

template<ClockType CLOCK>

cosmos::TimeSpec< CLOCK >::TimeSpec ( const std::chrono::milliseconds ms )

inlineexplicit

Definition at line 64 of file types.hxx.

                                                          {
                set(ms);
        }

◆ TimeSpec() [3/5]

template<ClockType CLOCK>

cosmos::TimeSpec< CLOCK >::TimeSpec ( const std::chrono::nanoseconds ns )

inlineexplicit

Definition at line 68 of file types.hxx.

                                                         {
                set(ns);
        }

◆ TimeSpec() [4/5]

template<ClockType CLOCK>

cosmos::TimeSpec< CLOCK >::TimeSpec ( )

inline

Definition at line 72 of file types.hxx.

72{ reset(); }

◆ TimeSpec() [5/5]

template<ClockType CLOCK>

cosmos::TimeSpec< CLOCK >::TimeSpec ( const no_init_t )

inlineexplicit

Deliberately don't initialize the members for performance reasons.

Definition at line 75 of file types.hxx.

                                           {
 
        }

Member Function Documentation

◆ addNanoseconds()

template<ClockType CLOCK>

void cosmos::TimeSpec< CLOCK >::addNanoseconds ( const long nano_seconds )

inline

Definition at line 92 of file types.hxx.

                                                     {
                this->tv_nsec += nano_seconds;
        }

◆ addSeconds()

template<ClockType CLOCK>

void cosmos::TimeSpec< CLOCK >::addSeconds ( const time_t seconds )

inline

Definition at line 88 of file types.hxx.

                                              {
                this->tv_sec += seconds;
        }

◆ getNanoseconds()

template<ClockType CLOCK>

long cosmos::TimeSpec< CLOCK >::getNanoseconds ( ) const

inline

Definition at line 83 of file types.hxx.

83{ return this->tv_nsec; }

◆ getSeconds()

template<ClockType CLOCK>

time_t cosmos::TimeSpec< CLOCK >::getSeconds ( ) const

inline

Definition at line 82 of file types.hxx.

82{ return this->tv_sec; }

◆ isZero()

template<ClockType CLOCK>

bool cosmos::TimeSpec< CLOCK >::isZero ( ) const

inline

Definition at line 79 of file types.hxx.

79{ return this->tv_sec == 0 && this->tv_nsec == 0; }

◆ operator std::chrono::milliseconds()

template<ClockType CLOCK>

cosmos::TimeSpec< CLOCK >::operator std::chrono::milliseconds ( ) const

inlineexplicit

Definition at line 122 of file types.hxx.

                                                        {
                return std::chrono::milliseconds{toMilliseconds()};
        }

◆ operator!=()

template<ClockType CLOCK>

bool cosmos::TimeSpec< CLOCK >::operator!= ( const TimeSpec< CLOCK > & other ) const

inline

Definition at line 148 of file types.hxx.

148{ return !(*this == other); }

◆ operator+()

template<ClockType CLOCK>

TimeSpec cosmos::TimeSpec< CLOCK >::operator+ ( const TimeSpec< CLOCK > & other ) const

inline

Definition at line 168 of file types.hxx.

                                                        {
                TimeSpec ret;
 
                ret.tv_sec = this->tv_sec + other.tv_sec;
                ret.tv_nsec = this->tv_nsec + other.tv_nsec;
 
                if (ret.tv_nsec >= NANOSECOND_BASE) {
                        ++ret.tv_sec;
                        ret.tv_nsec -= NANOSECOND_BASE;
                }
 
                return ret;
        }

◆ operator-()

template<ClockType CLOCK>

TimeSpec cosmos::TimeSpec< CLOCK >::operator- ( const TimeSpec< CLOCK > & other ) const

inline

Definition at line 154 of file types.hxx.

                                                        {
                TimeSpec ret;
 
                ret.tv_sec = this->tv_sec - other.tv_sec;
                ret.tv_nsec = this->tv_nsec - other.tv_nsec;
 
                if (ret.tv_nsec < 0) {
                        --ret.tv_sec;
                        ret.tv_nsec += NANOSECOND_BASE;
                }
 
                return ret;
        }

◆ operator<()

template<ClockType CLOCK>

bool cosmos::TimeSpec< CLOCK >::operator< ( const TimeSpec< CLOCK > & other ) const

inline

Definition at line 126 of file types.hxx.

                                                    {
                if (this->tv_sec < other.tv_sec)
                        return true;
                else if (this->tv_sec != other.tv_sec)
                        return false;
 
                // so seconds are equal
                if (this->tv_nsec < other.tv_nsec)
                        return true;
 
                return false;
        }

◆ operator<=()

template<ClockType CLOCK>

bool cosmos::TimeSpec< CLOCK >::operator<= ( const TimeSpec< CLOCK > & other ) const

inline

Definition at line 150 of file types.hxx.

                                                     {
                return *this < other || *this == other;
        }

◆ operator==()

template<ClockType CLOCK>

bool cosmos::TimeSpec< CLOCK >::operator== ( const TimeSpec< CLOCK > & other ) const

inline

Definition at line 143 of file types.hxx.

                                                     {
                return this->tv_sec == other.tv_sec &&
                        this->tv_nsec == other.tv_nsec;
        }

◆ operator>=()

template<ClockType CLOCK>

bool cosmos::TimeSpec< CLOCK >::operator>= ( const TimeSpec< CLOCK > & other ) const

inline

Definition at line 139 of file types.hxx.

                                                     {
                return !operator<(other);
        }

◆ reset()

template<ClockType CLOCK>

void cosmos::TimeSpec< CLOCK >::reset ( )

inline

Definition at line 80 of file types.hxx.

80{ this->tv_sec = 0; this->tv_nsec = 0; }

◆ set() [1/2]

template<ClockType CLOCK>

TimeSpec & cosmos::TimeSpec< CLOCK >::set ( const std::chrono::milliseconds ms )

inline

Definition at line 103 of file types.hxx.

                                                      {
                this->tv_sec = ms.count() / 1000;
                this->tv_nsec = (ms.count() % 1000) * 1000 * 1000;
                return *this;
        }

◆ set() [2/2]

template<ClockType CLOCK>

TimeSpec & cosmos::TimeSpec< CLOCK >::set ( const std::chrono::nanoseconds ns )

inline

Definition at line 109 of file types.hxx.

                                                     {
                this->tv_sec = ns.count() / NANOSECOND_BASE;
                this->tv_nsec = (ns.count() % NANOSECOND_BASE);
                return *this;
        }

◆ setAsMilliseconds()

template<ClockType CLOCK>

TimeSpec & cosmos::TimeSpec< CLOCK >::setAsMilliseconds ( const size_t milliseconds )

inline

Definition at line 96 of file types.hxx.

                                                               {
                auto left_ms = milliseconds % 1000;
                this->tv_sec = (milliseconds - left_ms) / 1000;
                this->tv_nsec = left_ms * 1000 * 1000;
                return *this;
        }

◆ setNanoseconds()

template<ClockType CLOCK>

void cosmos::TimeSpec< CLOCK >::setNanoseconds ( const long nano_seconds )

inline

Definition at line 86 of file types.hxx.

86{ this->tv_nsec = nano_seconds; }

◆ setSeconds()

template<ClockType CLOCK>

void cosmos::TimeSpec< CLOCK >::setSeconds ( const time_t seconds )

inline

Definition at line 85 of file types.hxx.

85{ this->tv_sec = seconds; }

◆ toMilliseconds()

template<ClockType CLOCK>

size_t cosmos::TimeSpec< CLOCK >::toMilliseconds ( ) const

inline

Converts the time representation into a single milliseconds value.

Definition at line 116 of file types.hxx.

                                      {
                size_t ret = this->tv_sec * 1000;
                ret += (this->tv_nsec / 1000 / 1000);
                return ret;
        }

Member Data Documentation

◆ NANOSECOND_BASE

template<ClockType CLOCK>

long cosmos::TimeSpec< CLOCK >::NANOSECOND_BASE {1000 * 1000 * 1000}

staticconstexprprotected

Definition at line 184 of file types.hxx.

184{1000 * 1000 * 1000};

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

include/time/types.hxx

Public Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TimeSpec() [1/5]

◆ TimeSpec() [2/5]

◆ TimeSpec() [3/5]

◆ TimeSpec() [4/5]

◆ TimeSpec() [5/5]

Member Function Documentation

◆ addNanoseconds()

◆ addSeconds()

◆ getNanoseconds()

◆ getSeconds()

◆ isZero()

◆ operator std::chrono::milliseconds()

◆ operator!=()

◆ operator+()

◆ operator-()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>=()

◆ reset()

◆ set() [1/2]

◆ set() [2/2]

◆ setAsMilliseconds()

◆ setNanoseconds()

◆ setSeconds()

◆ toMilliseconds()

Member Data Documentation

◆ NANOSECOND_BASE