Utopia::DataIO::MonitorTimer Class Reference

The MonitorTimer keeps track of the time when to emit monitor data. More...

#include <monitor.hh>

Public Types
using	Clock = std::chrono::high_resolution_clock
	Data type for the clock.
using	Time = std::chrono::high_resolution_clock::time_point
	Data type for a time point.
using	DurationType = std::chrono::duration< double >
	Data type for the time unit.

Public Member Functions
	MonitorTimer (const double emit_interval)
	Constructor.
bool	time_has_come () const
	Check for whether the time to emit has come or not.
void	reset ()
	Reset the timer to the current time.
template<class DurationT = DurationType>
const DurationT	get_time_elapsed () const
	Get the time elapsed since the start of this timer.
double	get_time_elapsed_seconds () const
	Get the time elapsed since start of this timer, converted to seconds.
const DurationType	get_emit_interval () const
	Return the emit interval.

Private Attributes
const DurationType	_emit_interval
	The emit interval.
const Time	_start_time
	The starting time of the timer.
Time	_last_emit
	The time of the last emit.

Detailed Description

The MonitorTimer keeps track of the time when to emit monitor data.

Member Typedef Documentation

Clock

using Utopia::DataIO::MonitorTimer::Clock = std::chrono::high_resolution_clock

Data type for the clock.

DurationType

using Utopia::DataIO::MonitorTimer::DurationType = std::chrono::duration< double >

Data type for the time unit.

Time

using Utopia::DataIO::MonitorTimer::Time = std::chrono::high_resolution_clock::time_point

Data type for a time point.

Constructor & Destructor Documentation

MonitorTimer()

Utopia::DataIO::MonitorTimer::MonitorTimer ( const double  emit_interval )

inline

Constructor.

Construct a new Monitor Timer object. The _last_emit time is set to the time of construction.

Parameters

emit_interval

The time interval that defines whether the time has come to emit data. If more time than the _emit_interval has passed the time_has_come function returns true.

                                             :
        // Store the emit interval
        _emit_interval(emit_interval),
        // Set the starting time member
        _start_time(Clock::now()),
        // Initialize _last_emit empty, setting it to 1.1.1970, 0:00, meaning
        // that no emit has occurred yet.
        _last_emit(){};

Member Function Documentation

get_emit_interval()

const DurationType Utopia::DataIO::MonitorTimer::get_emit_interval ( ) const

inline

Return the emit interval.

    {
        return _emit_interval;
    }

get_time_elapsed()

template<class DurationT = DurationType>

const DurationT Utopia::DataIO::MonitorTimer::get_time_elapsed ( ) const

inline

Get the time elapsed since the start of this timer.

    {
        return Clock::now() - _start_time;
    }

get_time_elapsed_seconds()

double Utopia::DataIO::MonitorTimer::get_time_elapsed_seconds ( ) const

inline

Get the time elapsed since start of this timer, converted to seconds.

    {
        return get_time_elapsed< std::chrono::duration< double > >().count();
    }

reset()

void Utopia::DataIO::MonitorTimer::reset ( )

inline

Reset the timer to the current time.

    {
        _last_emit = Clock::now();
    }

time_has_come()

bool Utopia::DataIO::MonitorTimer::time_has_come ( ) const

inline

Check for whether the time to emit has come or not.

Parameters

reset

Reset the internal timer to the current time if the _emit_interval has been exceeded.

Returns

true if the internal timer has exceeded the _last_emit time.

    {
        // Calculate the time difference between now and the last emit
        const DurationType duration = Clock::now() - _last_emit;
 
        // If more time than the _emit_interval has passed, return true
        return (duration > _emit_interval);
    }

Member Data Documentation

_emit_interval

const DurationType Utopia::DataIO::MonitorTimer::_emit_interval

private

The emit interval.

_last_emit

Time Utopia::DataIO::MonitorTimer::_last_emit

private

The time of the last emit.

_start_time

const Time Utopia::DataIO::MonitorTimer::_start_time

private

The starting time of the timer.

---

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

• include/utopia/data_io/monitor.hh