libjmmcg  release_579_6_g8cffd
A C++ library containing an eclectic mix of useful, advanced components.
jmmcg::LIBJMMCG_VER_NAMESPACE::latency_timestamps_itf::timestamp Struct Reference

#include <latency_timestamps.hpp>

Public Types

using element_type = cpu_timer::element_type
 

Public Member Functions

bool is_valid () const noexcept(true)
 
void to_csv (std::ostream &os) const noexcept(false)
 Write a timestamp to the output stream in CSV format. More...
 

Public Attributes

element_type start {}
 The raw timestamp from the selected timer_t. More...
 
element_type end {}
 The raw timestamp from the selected timer_t. More...
 

Detailed Description

Definition at line 42 of file latency_timestamps.hpp.

Member Typedef Documentation

◆ element_type

Member Function Documentation

◆ is_valid()

bool jmmcg::LIBJMMCG_VER_NAMESPACE::latency_timestamps_itf::timestamp::is_valid ( ) const
inlinenoexcept

Definition at line 22 of file latency_timestamps_impl.hpp.

References end, and start.

◆ to_csv()

void jmmcg::LIBJMMCG_VER_NAMESPACE::latency_timestamps_itf::timestamp::to_csv ( std::ostream &  os) const
noexcept

Write a timestamp to the output stream in CSV format.

The output timestamps are in microseconds since the start of the program.

Definition at line 28 of file latency_timestamps.cpp.

References end, start, and jmmcg::LIBJMMCG_VER_NAMESPACE::cpu_timer::TSC_to_microsec().

Member Data Documentation

◆ end

element_type jmmcg::LIBJMMCG_VER_NAMESPACE::latency_timestamps_itf::timestamp::end {}

The raw timestamp from the selected timer_t.

See also
timer_t

Definition at line 53 of file latency_timestamps.hpp.

Referenced by is_valid(), to_csv(), and jmmcg::LIBJMMCG_VER_NAMESPACE::latency_timestamps_itf::period::~period().

◆ start

element_type jmmcg::LIBJMMCG_VER_NAMESPACE::latency_timestamps_itf::timestamp::start {}

The raw timestamp from the selected timer_t.

See also
timer_t

Definition at line 48 of file latency_timestamps.hpp.

Referenced by is_valid(), jmmcg::LIBJMMCG_VER_NAMESPACE::latency_timestamps_itf::period::period(), and to_csv().


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