tim::component::printer Struct Reference

A diagnostic component when prints messages via start(...) and stores messages via store(...). The stored messages are returned via the get() member function. If bundled alongside the timestamp component, the timestamp will be added to the stored message. More...

#include "timemory/components/printer/printer.hpp"

Collaboration diagram for tim::component::printer:

Public Types
using	value_type = void
using	storage_type = empty_storage
using	base_type = void

Public Member Functions
	printer ()=default
	~printer ()=default
	printer (printer &&)=default
	printer (const printer &)
printer &	operator= (printer &&)=default
printer &	operator= (const printer &)
std::string	get () const
void	set_prefix (const char *)
bool	assemble (timestamp *)
template<typename... Args>
auto	start (Args &&... args) -> decltype(TIMEMORY_FOLD_EXPRESSION(std::declval< std::stringstream >()<< args), void())
template<typename... Args>
auto	store (Args &&... args) -> decltype(TIMEMORY_FOLD_EXPRESSION(std::declval< std::stringstream >()<< args), void())

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static std::string	get_label ()
static std::string	get_description ()
template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

A diagnostic component when prints messages via start(...) and stores messages via store(...). The stored messages are returned via the get() member function. If bundled alongside the timestamp component, the timestamp will be added to the stored message.

Definition at line 43 of file printer.hpp.

Member Typedef Documentation

base_type

using tim::component::empty_base::base_type = void

inherited

Definition at line 67 of file declaration.hpp.

storage_type

using tim::component::empty_base::storage_type = empty_storage

inherited

Definition at line 66 of file declaration.hpp.

value_type

using tim::component::printer::value_type = void

Definition at line 47 of file printer.hpp.

Constructor & Destructor Documentation

printer() [1/3]

tim::component::printer::printer ( )

default

~printer()

tim::component::printer::~printer ( )

default

printer() [2/3]

tim::component::printer::printer ( printer &&  )

default

printer() [3/3]

tim::component::printer::printer

(

const printer &

rhs

)

Definition at line 70 of file printer.cpp.

: m_prefix{ rhs.m_prefix }
, m_ts{ rhs.m_ts }
, m_stream{ rhs.m_stream.str() }
{}

Member Function Documentation

assemble()

bool tim::component::printer::assemble

(

timestamp *

_wc

)

Definition at line 106 of file printer.cpp.

{
    m_ts = _wc;
    return (m_ts != nullptr);
}

description()

std::string tim::component::printer::description ( )

static

Definition at line 50 of file printer.cpp.

{
    return "Provides an interface for printing out debug messages";
}

Referenced by get_description().

get()

std::string tim::component::printer::get

(

)

const

Definition at line 92 of file printer.cpp.

{
    return m_stream.str();
}

get_description()

std::string tim::component::printer::get_description ( )

static

Definition at line 64 of file printer.cpp.

{
    return description();
}

References description().

get_label()

std::string tim::component::printer::get_label ( )

static

Definition at line 57 of file printer.cpp.

{
    return label();
}

References label().

get_opaque()

template<typename... Args>

static opaque tim::component::empty_base::get_opaque ( Args &&  ... )

inlinestaticinherited

Definition at line 72 of file declaration.hpp.

    {
        return opaque{};
    }

label()

std::string tim::component::printer::label ( )

static

Definition at line 43 of file printer.cpp.

{
    return "printer";
}

Referenced by get_label().

operator=() [1/2]

printer & tim::component::printer::operator=

(

const printer &

rhs

)

Definition at line 78 of file printer.cpp.

{
    if(this == &rhs)
        return *this;
 
    m_prefix = rhs.m_prefix;
    m_ts     = rhs.m_ts;
    m_stream << rhs.m_stream.str();
 
    return *this;
}

operator=() [2/2]

printer & tim::component::printer::operator= ( printer &&  )

default

set_prefix()

void tim::component::printer::set_prefix

(

const char *

_prefix

)

Definition at line 99 of file printer.cpp.

{
    m_prefix = _prefix;
}

References tim::_prefix.

start()

template<typename... Args>

auto tim::component::printer::start

(

Args &&...

args

)

-> decltype(TIMEMORY_FOLD_EXPRESSION(std::declval<std::stringstream>() << args), void())

Definition at line 91 of file printer.hpp.

{
    // only print message if arguments provided
    if(sizeof...(Args) == 0)
        return;
 
    std::cerr << std::flush;
    if(m_prefix)
        std::cerr << "[" << m_prefix << "]";
    std::cerr << "> " << TIMEMORY_JOIN("", std::forward<Args>(args)...) << '\n';
}

References TIMEMORY_JOIN.

store()

template<typename... Args>

auto tim::component::printer::store

(

Args &&...

args

)

-> decltype(TIMEMORY_FOLD_EXPRESSION(std::declval<std::stringstream>() << args), void())

Definition at line 107 of file printer.hpp.

{
    // only store message if arguments provided
    if(sizeof...(Args) == 0)
        return;
 
    std::string _tp{};
    if(m_prefix)
        _tp += TIMEMORY_JOIN("", '[', m_prefix, ']');
    if(m_ts)
        _tp += "[" + timestamp::as_string(m_ts->get()) + "]";
    m_stream << _tp << "> " << TIMEMORY_JOIN("", std::forward<Args>(args)...) << '\n';
}

References tim::trait::as_string(), and TIMEMORY_JOIN.

---

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

• timemory/components/printer/printer.hpp
• timemory/components/printer/printer.cpp