Utopia::DataIO::Monitor Class Reference

The Monitor monitors entries that are emitted if a given time has passed. More...

#include <monitor.hh>

Public Member Functions
	Monitor (std::shared_ptr< MonitorManager > root_mtr_mgr)
	Constructs a root monitor object.
	Monitor (const std::string &name, const Monitor &parent_mtr)
	Construct a monitor object within a hierarchy.
template<typename Func >
void	set_by_func (const std::string key, Func &&f)
	Provide a new entry to the monitor manager.
template<typename Value >
void	set_by_value (const std::string key, Value const &v)
	Provide a new entry to the monitor manager.
template<typename Arg >
void	set_entry (const std::string key, Arg arg)
	Provide a new entry to the monitor manager.
std::shared_ptr< MonitorManager >	get_monitor_manager () const
	Get a shared pointer to the MonitorManager.
std::string	get_name () const
	Get the name of the monitor.

Private Attributes
const std::string	_name
	The name of the monitor.
std::shared_ptr< MonitorManager >	_mtr_mgr
	The monitor manager.

Detailed Description

The Monitor monitors entries that are emitted if a given time has passed.

Constructor & Destructor Documentation

Monitor() [1/2]

Utopia::DataIO::Monitor::Monitor ( std::shared_ptr< MonitorManager >  root_mtr_mgr )

inline

Constructs a root monitor object.

A root monitor has no name and writes to the root level of the monitor entries tree.

Parameters

root_mtr_mgr

The monitor manager to associate this monitor with

    :
        _name(""),
        _mtr_mgr(root_mtr_mgr){};

Monitor() [2/2]

Utopia::DataIO::Monitor::Monitor ( const std::string &  name, const Monitor &  parent_mtr  )

inline

Construct a monitor object within a hierarchy.

Construct a new Monitor object and names it such that it fits into the monitor hierarchy

Parameters

name	The name of this monitor; to place it into the monitor hierarchy the parent's name is prepended to this given name, separated by the . character.
parent_mtr	The parent monitor

    :
        _name(parent_mtr.get_name() + "." + name),
        _mtr_mgr(parent_mtr.get_monitor_manager()){};

Member Function Documentation

get_monitor_manager()

std::shared_ptr< MonitorManager > Utopia::DataIO::Monitor::get_monitor_manager ( ) const

inline

Get a shared pointer to the MonitorManager.

    {
        return _mtr_mgr;
    }

get_name()

std::string Utopia::DataIO::Monitor::get_name ( ) const

inline

Get the name of the monitor.

    {
        return _name;
    }

set_by_func()

template<typename Func >

void Utopia::DataIO::Monitor::set_by_func ( const std::string  key, Func &&  f  )

inline

Provide a new entry to the monitor manager.

Note

An entry is set regardless of whether the emission is enabled.

Template Parameters

Func	The type of the function (rvalue reference)

Parameters

key	The key of the new entry
value	The value of the new entry

    {
        _mtr_mgr->set_entry(_name, key, f());
    }

set_by_value()

template<typename Value >

void Utopia::DataIO::Monitor::set_by_value ( const std::string  key, Value const &  v  )

inline

Provide a new entry to the monitor manager.

Note

An entry is set regardless of whether the emission is enabled.

Template Parameters

Value

The type of the value (lvalue reference)

Parameters

key	The key of the new entry
value	The value of the new entry

    {
        _mtr_mgr->set_entry(_name, key, v);
    }

set_entry()

template<typename Arg >

void Utopia::DataIO::Monitor::set_entry ( const std::string  key, Arg  arg  )

inline

Provide a new entry to the monitor manager.

This function tests whether the argument is callable like a std::function or a lambda excluding the operator(). If so, they are called and the return value is used for setting the entry.

(Without the exclusion of operator(), types such as int or double would also be classified callable.)

Note

An entry is set regardless of whether the emission is enabled!

Template Parameters

Arg	The type of the argument

Parameters

key	The key of the new entry
arg	The argument (value or function) that determines the value of the new entry

    {
        if constexpr (is_callable< Arg >::value)
        {
            set_by_func(key, arg);
        }
        else
        {
            set_by_value(key, arg);
        }
    }

Member Data Documentation

_mtr_mgr

std::shared_ptr< MonitorManager > Utopia::DataIO::Monitor::_mtr_mgr

private

The monitor manager.

_name

const std::string Utopia::DataIO::Monitor::_name

private

The name of the monitor.

Used when setting entries via MonitorManager::set_entry

---

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

• include/utopia/data_io/monitor.hh