tim::component::allinea_map Struct Reference

Controls the AllineaMap sampling profiler. More...

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

Collaboration diagram for tim::component::allinea_map:

Public Types
using	value_type = void
using	this_type = allinea_map
using	base_type = base< this_type, value_type >
using	tracker_type = policy::instance_tracker< allinea_map, false >
using	storage_type = empty_storage

Public Member Functions
void	start ()
void	stop ()
void	get () const

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

Detailed Description

Controls the AllineaMap sampling profiler.

Definition at line 53 of file components.hpp.

Member Typedef Documentation

base_type

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

Definition at line 59 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::allinea_map::this_type = allinea_map

Definition at line 58 of file components.hpp.

tracker_type

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

Definition at line 60 of file components.hpp.

value_type

using tim::component::allinea_map::value_type = void

Definition at line 57 of file components.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 63 of file components.hpp.

{ return "Controls the AllineaMAP sampler"; }

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::allinea_map::global_finalize ( )

inlinestatic

Definition at line 66 of file components.hpp.

{ backend::allinea::stop_sampling(); }

global_init()

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

inlinestatic

Definition at line 65 of file components.hpp.

{ backend::allinea::stop_sampling(); }

label()

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

inlinestatic

Definition at line 62 of file components.hpp.

{ return "allinea_map"; }

start()

void tim::component::allinea_map::start ( )

inline

Definition at line 68 of file components.hpp.

    {
        tracker_type::start();
        if(tracker_type::m_tot == 0)
            backend::allinea::start_sampling();
    }

References tim::invoke::start().

stop()

void tim::component::allinea_map::stop ( )

inline

Definition at line 75 of file components.hpp.

    {
        tracker_type::stop();
        if(tracker_type::m_tot == 0)
            backend::allinea::stop_sampling();
    }

References tim::invoke::stop().

---

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

• timemory/components/allinea/components.hpp