tim::component::vtune_event Struct Reference

Implements __itt_event More...

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

Collaboration diagram for tim::component::vtune_event:

Public Types
using	value_type = void
using	this_type = vtune_event
using	base_type = base< this_type, value_type >
using	storage_type = empty_storage

Public Member Functions
void	start ()
void	stop ()
void	set_prefix (const std::string &_prefix)
void	get () const

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static value_type	record ()
static void	global_init ()
static void	global_finalize ()
template<typename... Args>
static opaque	get_opaque (Args &&...)

Protected Attributes
bool	m_created = false
std::string	m_prefix
int64_t	m_index = -1
ittnotify::event_t	m_event

Detailed Description

Implements __itt_event

Definition at line 40 of file components.hpp.

Member Typedef Documentation

base_type

using tim::component::vtune_event::base_type = base<this_type, value_type>

Definition at line 44 of file components.hpp.

storage_type

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

inherited

Definition at line 66 of file declaration.hpp.

this_type

using tim::component::vtune_event::this_type = vtune_event

Definition at line 43 of file components.hpp.

value_type

using tim::component::vtune_event::value_type = void

Definition at line 42 of file components.hpp.

Member Function Documentation

description()

static std::string tim::component::vtune_event::description ( )

inlinestatic

Definition at line 47 of file components.hpp.

    {
        return "Creates events for Intel profiler running on the application";
    }

get()

void tim::component::empty_base::get ( ) const

inlineinherited

Definition at line 69 of file declaration.hpp.

{}

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{};
    }

global_finalize()

static void tim::component::vtune_event::global_finalize ( )

inlinestatic

Definition at line 54 of file components.hpp.

{ ittnotify::pause(); }

global_init()

static void tim::component::vtune_event::global_init ( )

inlinestatic

Definition at line 53 of file components.hpp.

{ ittnotify::pause(); }

label()

static std::string tim::component::vtune_event::label ( )

inlinestatic

Definition at line 46 of file components.hpp.

{ return "vtune_event"; }

record()

static value_type tim::component::vtune_event::record ( )

inlinestatic

Definition at line 51 of file components.hpp.

{}

set_prefix()

void tim::component::vtune_event::set_prefix ( const std::string &  _prefix )

inline

Definition at line 78 of file components.hpp.

{ m_prefix = _prefix; }

References tim::_prefix, and m_prefix.

start()

void tim::component::vtune_event::start ( )

inline

Definition at line 56 of file components.hpp.

    {
        get_index()++;
 
        if(m_index == 0)
            ittnotify::resume();
        if(!m_created)
        {
            m_event   = ittnotify::create_event(m_prefix);
            m_created = true;
        }
        ittnotify::start_event(m_event);
    }

References m_created, m_event, m_index, and m_prefix.

stop()

void tim::component::vtune_event::stop ( )

inline

Definition at line 70 of file components.hpp.

    {
        auto _index = --get_index();
        ittnotify::end_event(m_event);
        if(_index == 0)
            ittnotify::pause();
    }

References m_event.

Member Data Documentation

m_created

bool tim::component::vtune_event::m_created = false

protected

Definition at line 81 of file components.hpp.

Referenced by start().

m_event

ittnotify::event_t tim::component::vtune_event::m_event

protected

Definition at line 84 of file components.hpp.

Referenced by start(), and stop().

m_index

int64_t tim::component::vtune_event::m_index = -1

protected

Definition at line 83 of file components.hpp.

Referenced by start().

m_prefix

std::string tim::component::vtune_event::m_prefix

protected

Definition at line 82 of file components.hpp.

Referenced by set_prefix(), and start().

---

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

• timemory/components/vtune/components.hpp