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 >
using	storage_type = empty_storage

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 ()
template<typename... Args>
static opaque	get_opaque (Args &&...)

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 137 of file components.hpp.

Member Typedef Documentation

base_type

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

Definition at line 141 of file components.hpp.

ratio_t

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

Definition at line 139 of file components.hpp.

storage_type

using tim::component::empty_base::storage_type = empty_storage

inherited

Definition at line 66 of file declaration.hpp.

value_type

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

Definition at line 140 of file components.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 144 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 153 of file components.hpp.

    {
        return load() / static_cast<double>(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 157 of file components.hpp.

{ return get(); }

References get().

get_opaque()

template<typename... Args>

static opaque tim::component::empty_base::get_opaque ( Args &&  ... )

inlinestaticinherited

Definition at line 72 of file declaration.hpp.

    {
        return opaque{};
    }

label()

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

inlinestatic

Definition at line 143 of file components.hpp.

{ return "monotonic_clock"; }

record()

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

inlinestatic

Definition at line 149 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 158 of file components.hpp.

{ value = record(); }

References record().

stop()

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

inlinenoexcept

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