tim::component::craypat_region Struct Reference

Adds a region label to the CrayPAT profiling output. More...

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

Collaboration diagram for tim::component::craypat_region:

Public Types
using	tracker_type = policy::instance_tracker< craypat_region, false >
using	storage_type = empty_storage
using	base_type = void

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

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

Detailed Description

Adds a region label to the CrayPAT profiling output.

Retrieves the names and value of any counter events that have been set to count on the hardware category.

Definition at line 92 of file components.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.

tracker_type

using tim::component::craypat_region::tracker_type = policy::instance_tracker<craypat_region, false>

Definition at line 96 of file components.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 99 of file components.hpp.

{ return "Adds region labels to CrayPAT output"; }

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

label()

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

inlinestatic

Definition at line 98 of file components.hpp.

{ return "craypat_region"; }

set_prefix()

void tim::component::craypat_region::set_prefix ( const std::string &  _label )

inline

Definition at line 113 of file components.hpp.

{ m_label = _label; }

start()

void tim::component::craypat_region::start ( )

inline

Definition at line 101 of file components.hpp.

    {
        tracker_type::start();
        backend::craypat::region_begin(tracker_type::m_tot, m_label.c_str());
    }

References tim::invoke::start().

stop()

void tim::component::craypat_region::stop ( )

inline

Definition at line 107 of file components.hpp.

    {
        backend::craypat::region_end(tracker_type::m_tot);
        tracker_type::stop();
    }

References tim::invoke::stop().

---

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

• timemory/components/craypat/components.hpp