Utopia::DataIO::MonitorManager Class Reference

The MonitorManager manages the monitor entries and MonitorTimer. More...

#include <monitor.hh>

Public Member Functions
	MonitorManager (const double emit_interval, const std::string emit_prefix="!!map ", const std::string emit_suffix="")
	Constructor.
void	emit_if_enabled ()
	Perform an emission of the data to the terminal, if the flag was set.
void	check_timer ()
	Checks with the timer whether the time to emit has come.
bool	emit_enabled () const
	Returns true if the emission is enabled.
template<typename Value >
void	set_entry (const std::string &path, const std::string &key, const Value value)
	Set an entry in the tree of monitor entries.
template<typename Time >
void	set_time_entries (const Time time, const Time time_max)
	Set time- and progress-related top level entries.
Timer &	get_timer ()
	Get a shared pointer to the MonitorTimer object.
auto	get_emit_interval ()
	Return the emit interval.
auto	get_emit_counter ()
	Return the emit interval.
YAML::Node &	get_entries ()
	Get the reference to the monitor entries object.

Private Types
using	Timer = std::shared_ptr< MonitorTimer >
	Type of the timer.

Private Attributes
Timer	_timer
	The monitor timer.
YAML::Node	_entries
	The monitor entries.
bool	_emit_enabled
	The flag that determines whether to collect data.
std::size_t	_emit_counter
	Counts the number of emit operations.
const std::string	_emit_prefix
	A prefix to the emitted string.
const std::string	_emit_suffix
	A suffix to the emitted string.

Detailed Description

The MonitorManager manages the monitor entries and MonitorTimer.

The manager performs an emission of the stored monitor data if the monitor timer asserts that enough time has passed since the last emit.

Member Typedef Documentation

Timer

using Utopia::DataIO::MonitorManager::Timer = std::shared_ptr< MonitorTimer >

private

Type of the timer.

Constructor & Destructor Documentation

MonitorManager()

Utopia::DataIO::MonitorManager::MonitorManager ( const double  emit_interval, const std::string  emit_prefix = "!!map ", const std::string  emit_suffix = ""  )

inline

Constructor.

Parameters

emit_interval	The emit interval that specifies after how much time to emit the monitor data.
emit_prefix	A prefix to the emitted string, default: "!!map "
emit_suffix	A suffix to the emitted string, default: "". Note that std::endl is always appended.

    :
        // Create a new MonitorTimer object
        _timer(std::make_shared< MonitorTimer >(emit_interval)),
        // Create an empty MonitorEntries object for the data to be emitted
        _entries(YAML::Node()),
        // Initialially set the collect data flag to true
        _emit_enabled(true),
        _emit_counter(0),
        _emit_prefix(emit_prefix),
        _emit_suffix(emit_suffix)
    {};

Member Function Documentation

check_timer()

void Utopia::DataIO::MonitorManager::check_timer ( )

inline

Checks with the timer whether the time to emit has come.

    {
        if (_timer->time_has_come())
        {
            _emit_enabled = true;
        }
    }

emit_enabled()

bool Utopia::DataIO::MonitorManager::emit_enabled ( ) const

inline

Returns true if the emission is enabled.

    {
        return _emit_enabled;
    }

emit_if_enabled()

void Utopia::DataIO::MonitorManager::emit_if_enabled ( )

inline

Perform an emission of the data to the terminal, if the flag was set.

    {
        if (not _emit_enabled) return;
 
        // Calling recursive_setitem may remove the emitter style, requiring
        // to reset it here each time. This will only set some flags in the
        // to-be-created YAML::Emitter and has negligible performance impact.
        _entries.SetStyle(YAML::EmitterStyle::Flow);
 
        std::cout << _emit_prefix
                  << _entries
                  << _emit_suffix
                  << std::endl;
 
        _emit_counter++;
        _timer->reset();
        _emit_enabled = false;
    }

get_emit_counter()

auto Utopia::DataIO::MonitorManager::get_emit_counter ( )

inline

Return the emit interval.

    {
        return _emit_counter;
    }

get_emit_interval()

auto Utopia::DataIO::MonitorManager::get_emit_interval ( )

inline

Return the emit interval.

    {
        return _timer->get_emit_interval();
    }

get_entries()

YAML::Node & Utopia::DataIO::MonitorManager::get_entries ( )

inline

Get the reference to the monitor entries object.

    {
        return _entries;
    }

get_timer()

Timer & Utopia::DataIO::MonitorManager::get_timer ( )

inline

Get a shared pointer to the MonitorTimer object.

    {
        return _timer;
    }

set_entry()

template<typename Value >

void Utopia::DataIO::MonitorManager::set_entry ( const std::string &  path, const std::string &  key, const Value  value  )

inline

Set an entry in the tree of monitor entries.

Sets an element at <path>.<key> to value, creating intermediate nodes within the monitor entries tree.

Template Parameters

Value

The type of the value that should be monitored

Parameters

path	The path at which to add the key. This can be used to traverse the entries tree. To separate the path segments, the . character is used.
key	The key of the new entry. It is suffixed onto the path with the . delimiter in between, becoming the last segment of the path.
value	The value of the new entry

    {
        using _internal::recursive_setitem;
        recursive_setitem(_entries, path + "." + key, value, ".");
    }

set_time_entries()

template<typename Time >

void Utopia::DataIO::MonitorManager::set_time_entries ( const Time  time, const Time  time_max  )

inline

Set time- and progress-related top level entries.

Using the given parameters, this method sets the top-level entries 'time' and 'progress'

Template Parameters

Time	The data type of the time

Parameters

time	The current time
time_max	The maximum time of the simulation

    {
        _entries["time"] = time;
 
        // Add the progress indicator and the elapsed time
        _entries["progress"] = float(time) / float(time_max);
    }

Member Data Documentation

_emit_counter

std::size_t Utopia::DataIO::MonitorManager::_emit_counter

private

Counts the number of emit operations.

_emit_enabled

bool Utopia::DataIO::MonitorManager::_emit_enabled

private

The flag that determines whether to collect data.

_emit_prefix

const std::string Utopia::DataIO::MonitorManager::_emit_prefix

private

A prefix to the emitted string.

_emit_suffix

const std::string Utopia::DataIO::MonitorManager::_emit_suffix

private

A suffix to the emitted string.

_entries

YAML::Node Utopia::DataIO::MonitorManager::_entries

private

The monitor entries.

_timer

Timer Utopia::DataIO::MonitorManager::_timer

private

The monitor timer.

---

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

• include/utopia/data_io/monitor.hh