dunedaq::utilities::TimestampEstimatorSystem Class Reference

TimestampEstimatorSystem is an implementation of TimestampEstimatorBase that uses the system clock to give the current timestamp. More...

#include <TimestampEstimatorSystem.hpp>

Inheritance diagram for dunedaq::utilities::TimestampEstimatorSystem:

Collaboration diagram for dunedaq::utilities::TimestampEstimatorSystem:

Public Member Functions
	TimestampEstimatorSystem (uint64_t clock_frequency_hz)
uint64_t	get_timestamp_estimate () const override
std::chrono::microseconds	get_wait_estimate (uint64_t ts) const override
Public Member Functions inherited from dunedaq::utilities::TimestampEstimatorBase
virtual	~TimestampEstimatorBase ()=default
WaitStatus	wait_for_valid_timestamp (std::atomic< bool > &continue_flag)
	Waits for a valid timestamp to become available. Returns a status value that indicates whether a valid timestamp is available or not.
WaitStatus	wait_for_timestamp (uint64_t ts, std::atomic< bool > &continue_flag)

Private Attributes
uint64_t	m_clock_frequency_hz

Additional Inherited Members
Public Types inherited from dunedaq::utilities::TimestampEstimatorBase
enum	WaitStatus { kFinished , kInterrupted }

Detailed Description

TimestampEstimatorSystem is an implementation of TimestampEstimatorBase that uses the system clock to give the current timestamp.

Definition at line 22 of file TimestampEstimatorSystem.hpp.

Constructor & Destructor Documentation

TimestampEstimatorSystem()

dunedaq::utilities::TimestampEstimatorSystem::TimestampEstimatorSystem ( uint64_t clock_frequency_hz )

explicit

Definition at line 18 of file TimestampEstimatorSystem.cpp.

  : m_clock_frequency_hz(clock_frequency_hz)
{
  TLOG_DEBUG(0) << "Clock frequency is " << m_clock_frequency_hz
                << " clock_frequency_hz/1000000.=" << (m_clock_frequency_hz / 1000000.);
}

Member Function Documentation

get_timestamp_estimate()

uint64_t dunedaq::utilities::TimestampEstimatorSystem::get_timestamp_estimate ( ) const

overridevirtual

Implements dunedaq::utilities::TimestampEstimatorBase.

Definition at line 26 of file TimestampEstimatorSystem.cpp.

{
  auto now = std::chrono::system_clock::now().time_since_epoch();
  auto now_us = std::chrono::duration_cast<std::chrono::microseconds>(now);
  return (m_clock_frequency_hz / 1000000.) * now_us.count();
}

get_wait_estimate()

std::chrono::microseconds dunedaq::utilities::TimestampEstimatorSystem::get_wait_estimate ( uint64_t ts ) const

overridevirtual

Implements dunedaq::utilities::TimestampEstimatorBase.

Definition at line 34 of file TimestampEstimatorSystem.cpp.

{
  auto now = std::chrono::system_clock::now().time_since_epoch();
  auto now_us = std::chrono::duration_cast<std::chrono::microseconds>(now);
  auto then = static_cast<long>(ts * 1000000. / m_clock_frequency_hz);
  auto then_us = std::chrono::microseconds(then);
  if (then_us < now_us)
    return std::chrono::microseconds(0);
  return then_us - now_us;
}

Member Data Documentation

m_clock_frequency_hz

uint64_t dunedaq::utilities::TimestampEstimatorSystem::m_clock_frequency_hz

private

Definition at line 32 of file TimestampEstimatorSystem.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/utilities/include/utilities/TimestampEstimatorSystem.hpp
• /github/workspace/dunedaq/sourcecode/utilities/src/TimestampEstimatorSystem.cpp