tim::component::monotonic_clock Struct Reference

clock that increments monotonically, tracking the time since an arbitrary point, and will continue to increment while the system is asleep. More...

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

Collaboration diagram for tim::component::monotonic_clock:

Public Types
using	ratio_t = std::nano
using	value_type = int64_t
using	base_type = base< monotonic_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, and will continue to increment while the system is asleep.

Definition at line 144 of file components.hpp.

Member Typedef Documentation

base_type

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

Definition at line 148 of file components.hpp.

ratio_t

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

Definition at line 146 of file components.hpp.

value_type

using tim::component::monotonic_clock::value_type = int64_t

Definition at line 147 of file components.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 151 of file components.hpp.

    {
        return "Wall-clock timer which will continue to increment even while the system "
               "is asleep";
    }

get()

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

inlinenoexcept

Definition at line 160 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_clock >::load().

Referenced by get_display().

get_display()

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

inlinenoexcept

Definition at line 166 of file components.hpp.

{ return get(); }

References get().

label()

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

inlinestatic

Definition at line 150 of file components.hpp.

{ return "monotonic_clock"; }

record()

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

inlinestatic

Definition at line 156 of file components.hpp.

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

Referenced by start(), and stop().

start()

void tim::component::monotonic_clock::start ( )

inlinenoexcept

Definition at line 167 of file components.hpp.

{ value = record(); }

References record().

stop()

void tim::component::monotonic_clock::stop ( )

inlinenoexcept

Definition at line 168 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