this component stores the timestamp of when a bundle was started and is specialized such that the "timeline_storage" type-trait is true. This means that every entry in the call-graph for this output will be unique (look in the timestamp.txt output file) More...

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

Collaboration diagram for tim::component::timestamp:

Public Types
using	value_type = timestamp_entry_t

using	base_type = base< timestamp, value_type >

using	clock_type = std::chrono::system_clock

using	time_point_type = typename clock_type::time_point

using	duration_type = std::chrono::duration< clock_type::rep, std::nano >

using	storage_type = empty_storage

Public Member Functions
void	sample ()

void	start ()

value_type	get () const

std::string	get_display () const

template<typename ArchiveT >
void	load (ArchiveT &ar, const unsigned)

template<typename ArchiveT >
void	save (ArchiveT &ar, const unsigned) const

timestamp &	operator+= (const timestamp &)

timestamp &	operator/= (const timestamp &)

timestamp &	operator/= (int64_t)

Static Public Member Functions
static std::string	label ()

static std::string	description ()

static value_type	record ()

static value_type	get_reference_ts ()

static std::string	as_string (const time_point_type &_tp)

static int64_t	count ()

template<typename ArchiveT >
static void	extra_serialization (ArchiveT &)

template<typename... Args>
static opaque	get_opaque (Args &&...)

Friends
std::ostream &	operator<< (std::ostream &_os, const timestamp &_ts)

Detailed Description

this component stores the timestamp of when a bundle was started and is specialized such that the "timeline_storage" type-trait is true. This means that every entry in the call-graph for this output will be unique (look in the timestamp.txt output file)

Definition at line 49 of file timestamp.hpp.

Member Typedef Documentation

◆ base_type

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

Definition at line 52 of file timestamp.hpp.

◆ clock_type

using tim::component::timestamp::clock_type = std::chrono::system_clock

Definition at line 53 of file timestamp.hpp.

◆ duration_type

using tim::component::timestamp::duration_type = std::chrono::duration<clock_type::rep, std::nano>

Definition at line 55 of file timestamp.hpp.

◆ storage_type

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

inherited

Definition at line 66 of file declaration.hpp.

◆ time_point_type

using tim::component::timestamp::time_point_type = typename clock_type::time_point

Definition at line 54 of file timestamp.hpp.

◆ value_type

using tim::component::timestamp::value_type = timestamp_entry_t

Definition at line 51 of file timestamp.hpp.

Member Function Documentation

◆ as_string()

std::string tim::component::timestamp::as_string ( const time_point_type & _tp )

static

Definition at line 64 of file timestamp.cpp.

{
    char _repr[64];
    std::memset(_repr, '\0', sizeof(_repr));
    std::time_t _value = std::chrono::system_clock::to_time_t(_tp);
    // alternative: "%c %Z"
    if(std::strftime(_repr, sizeof(_repr), "%a %b %d %T %Y %Z", std::localtime(&_value)))
        return std::string{ _repr };
    return std::string{};
}

Referenced by tim::data::base::stream_entry::construct(), and get_display().

◆ count()

int64_t tim::component::timestamp::count ( )

static

Definition at line 77 of file timestamp.cpp.

{
    return std::chrono::duration_cast<duration_type>(record().time_since_epoch()).count();
}

References record().

◆ description()

std::string tim::component::timestamp::description ( )

static

Definition at line 50 of file timestamp.cpp.

{
    return "Provides a timestamp for every sample and/or phase";
}

◆ extra_serialization()

template<typename ArchiveT >

void tim::component::timestamp::extra_serialization ( ArchiveT & ar )

static

Definition at line 108 of file timestamp.hpp.

{
    ar(cereal::make_nvp("reference_timestamp", get_reference_ts()));
}

References get_reference_ts().

◆ get()

timestamp::value_type tim::component::timestamp::get ( ) const

Definition at line 100 of file timestamp.cpp.

{
    return base_type::get_value();
}

◆ get_display()

std::string tim::component::timestamp::get_display ( ) const

Definition at line 107 of file timestamp.cpp.

{
    return as_string(base_type::get_value());
}

References as_string().

◆ 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{};
    }

◆ get_reference_ts()

timestamp::value_type tim::component::timestamp::get_reference_ts ( )

static

Definition at line 131 of file timestamp.cpp.

{
    static auto _v = record();
    return _v;
}

References record().

Referenced by extra_serialization(), sample(), and start().

◆ label()

std::string tim::component::timestamp::label ( )

static

Definition at line 43 of file timestamp.cpp.

{
    return "timestamp";
}

◆ load()

template<typename ArchiveT >

void tim::component::timestamp::load	(	ArchiveT &	ar,
		const unsigned
	)

Definition at line 91 of file timestamp.hpp.

{
    time_t _val{};
    ar(cereal::make_nvp("time_since_epoch", _val));
    set_value(std::chrono::system_clock::from_time_t(_val));
}

◆ operator+=()

timestamp & tim::component::timestamp::operator+= ( const timestamp & _rhs )

Definition at line 114 of file timestamp.cpp.

{
    return (*this = _rhs);
}

◆ operator/=() [1/2]

timestamp & tim::component::timestamp::operator/= ( const timestamp & )

Definition at line 121 of file timestamp.cpp.

{
    return *this;
}

◆ operator/=() [2/2]

timestamp & tim::component::timestamp::operator/= ( int64_t )

Definition at line 127 of file timestamp.cpp.

127{ return *this; }

◆ record()

timestamp::value_type tim::component::timestamp::record ( )

static

Definition at line 57 of file timestamp.cpp.

{
    return std::chrono::system_clock::now();
}

Referenced by count(), get_reference_ts(), sample(), and start().

◆ sample()

void tim::component::timestamp::sample ( )

Definition at line 84 of file timestamp.cpp.

{
    get_reference_ts();
    base_type::set_value(record());
}

References get_reference_ts(), and record().

◆ save()

template<typename ArchiveT >

void tim::component::timestamp::save	(	ArchiveT &	ar,
		const unsigned
	)		const

Definition at line 100 of file timestamp.hpp.

{
    auto _val = std::chrono::system_clock::to_time_t(get_value());
    ar(cereal::make_nvp("time_since_epoch", _val));
}

◆ start()

void tim::component::timestamp::start ( )

Definition at line 92 of file timestamp.cpp.

{
    get_reference_ts();
    base_type::set_value(record());
}

References get_reference_ts(), and record().

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	_os,
		const timestamp &	_ts
	)

friend

Definition at line 82 of file timestamp.hpp.

    {
        _os << _ts.get_display();
        return _os;
    }

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

timemory/components/timestamp/timestamp.hpp
timemory/components/timestamp/timestamp.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ base_type

◆ clock_type

◆ duration_type

◆ storage_type

◆ time_point_type

◆ value_type

Member Function Documentation

◆ as_string()

◆ count()

◆ description()

◆ extra_serialization()

◆ get()

◆ get_display()

◆ get_opaque()

◆ get_reference_ts()

◆ label()

◆ load()

◆ operator+=()

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ record()

◆ sample()

◆ save()

◆ start()

Friends And Related Function Documentation

◆ operator<<