tim::component::monotonic_raw_clock Struct Reference

clock that increments monotonically, tracking the time since an arbitrary point like CLOCK_MONOTONIC. However, this clock is unaffected by frequency or time adjustments. It should not be compared to other system time sources. More...

#include "timemory/components/timing/components.hpp"

Collaboration diagram for tim::component::monotonic_raw_clock:

Public Types
using	ratio_t = std::nano
using	value_type = int64_t
using	base_type = base< monotonic_raw_clock, value_type >

Public Member Functions
double	get () const noexcept
double	get_display () const noexcept
void	start () noexcept
void	stop () noexcept

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static value_type	record ()

Detailed Description

clock that increments monotonically, tracking the time since an arbitrary point like CLOCK_MONOTONIC. However, this clock is unaffected by frequency or time adjustments. It should not be compared to other system time sources.

Definition at line 180 of file components.hpp.

Member Typedef Documentation

base_type

using tim::component::monotonic_raw_clock::base_type = base<monotonic_raw_clock, value_type>

Definition at line 184 of file components.hpp.

ratio_t

using tim::component::monotonic_raw_clock::ratio_t = std::nano

Definition at line 182 of file components.hpp.

value_type

using tim::component::monotonic_raw_clock::value_type = int64_t

Definition at line 183 of file components.hpp.

Member Function Documentation

description()

static std::string tim::component::monotonic_raw_clock::description ( )

inlinestatic

Definition at line 187 of file components.hpp.

    {
        return "Wall-clock timer unaffected by frequency or time adjustments in system "
               "time-of-day clock";
    }

get()

double tim::component::monotonic_raw_clock::get ( ) const

inlinenoexcept

Definition at line 196 of file components.hpp.

    {
        auto val = load();
        return static_cast<double>(val / static_cast<double>(ratio_t::den) *
                                   base_type::get_unit());
    }

References tim::component::base< Tp, Value >::get_unit(), and tim::component::base< monotonic_raw_clock >::load().

Referenced by get_display().

get_display()

double tim::component::monotonic_raw_clock::get_display ( ) const

inlinenoexcept

Definition at line 202 of file components.hpp.

{ return get(); }

References get().

label()

static std::string tim::component::monotonic_raw_clock::label ( )

inlinestatic

Definition at line 186 of file components.hpp.

{ return "monotonic_raw_clock"; }

record()

static value_type tim::component::monotonic_raw_clock::record ( )

inlinestatic

Definition at line 192 of file components.hpp.

    {
        return tim::get_clock_monotonic_raw_now<int64_t, ratio_t>();
    }

Referenced by start(), and stop().

start()

void tim::component::monotonic_raw_clock::start ( )

inlinenoexcept

Definition at line 203 of file components.hpp.

{ value = record(); }

References record().

stop()

void tim::component::monotonic_raw_clock::stop ( )

inlinenoexcept

Definition at line 204 of file components.hpp.

    {
        value = (record() - value);
        accum += value;
    }

References record().

---

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

• timemory/components/timing/components.hpp