tim::component::caliper_config Struct Reference

Component which provides Caliper cali::ConfigManager. More...

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

Collaboration diagram for tim::component::caliper_config:

Public Types
using	value_type = void
using	this_type = caliper_config
using	base_type = base< this_type, value_type >
using	value_type = void
using	instance_tracker_t = policy::instance_tracker< caliper_config, false >
using	arg_map_t = std::map< std::string, std::string >
using	arg_vec_t = std::vector< std::string >
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 std::string	label ()
static std::string	description ()
static auto &	get_manager ()
static void	configure (const arg_vec_t &_args, const arg_map_t &_kwargs={})
template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

Component which provides Caliper cali::ConfigManager.

Definition at line 81 of file components.hpp.

Member Typedef Documentation

arg_map_t

using tim::component::caliper_config::arg_map_t = std::map<std::string, std::string>

Definition at line 159 of file timemory.hpp.

arg_vec_t

using tim::component::caliper_config::arg_vec_t = std::vector<std::string>

Definition at line 160 of file timemory.hpp.

base_type

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

Definition at line 85 of file components.hpp.

instance_tracker_t

using tim::component::caliper_config::instance_tracker_t = policy::instance_tracker<caliper_config, false>

Definition at line 158 of file timemory.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::caliper_config::this_type = caliper_config

Definition at line 84 of file components.hpp.

value_type [1/2]

using tim::component::caliper_config::value_type = void

Definition at line 83 of file components.hpp.

value_type [2/2]

using tim::component::caliper_config::value_type = void

Definition at line 157 of file timemory.hpp.

Member Function Documentation

configure()

static void tim::component::caliper_config::configure ( const arg_vec_t &  _args, const arg_map_t &  _kwargs = {}  )

inlinestatic

Definition at line 171 of file timemory.hpp.

                                                                             {})
    {
        std::string cmd{};
        {
            std::stringstream ss;
            for(auto& itr : _args)
                ss << "," << itr;
            if(!ss.str().empty())
                cmd = ss.str().substr(1);
        }
        {
            std::stringstream ss;
            for(auto& itr : _kwargs)
            {
                auto _arg = itr.second;
                if(_arg.empty())
                {
                    ss << "," << itr.first;
                }
                else
                {
                    ss << "," << itr.first << "=(" << _arg << ")";
                }
            }
            if(!ss.str().empty())
            {
                if(!cmd.empty())
                    cmd += ",";
                cmd += ss.str().substr(1);
            }
        }
        if(!cmd.empty())
        {
            if(tim::settings::debug() || tim::settings::verbose() > -1)
                std::cerr << "Configuring caliper with :: " << cmd << std::endl;
            get_manager().add(cmd.c_str());
            if(get_manager().error())
            {
                std::cerr << "Caliper config error: " << get_manager().error_msg()
                          << std::endl;
            }
        }
        else
        {
            if(tim::settings::debug() || tim::settings::verbose() > -1)
                std::cerr << "Caliper was not configured" << std::endl;
        }
    }

description() [1/2]

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

inlinestatic

Definition at line 88 of file components.hpp.

{ return "Caliper configuration manager"; }

description() [2/2]

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

inlinestatic

Definition at line 163 of file timemory.hpp.

{ return "Caliper configuration manager"; }

get()

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

inlineinherited

Definition at line 69 of file declaration.hpp.

{}

get_manager()

static auto & tim::component::caliper_config::get_manager ( )

inlinestatic

Definition at line 165 of file timemory.hpp.

    {
        static cali::ConfigManager _instance;
        return _instance;
    }

Referenced by start(), and stop().

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() [1/2]

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

inlinestatic

Definition at line 87 of file components.hpp.

{ return "caliper_config"; }

label() [2/2]

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

inlinestatic

Definition at line 162 of file timemory.hpp.

{ return "caliper_config"; }

start()

void tim::component::caliper_config::start ( )

inline

Definition at line 273 of file timemory.hpp.

    {
        auto cnt = instance_tracker_t::start();
        if(cnt == 0)
        {
            CONDITIONAL_PRINT_HERE(tim::settings::debug(), "%s",
                                   "Starting Caliper ConfigManager");
            get_manager().start();
        }
    }

References CONDITIONAL_PRINT_HERE, tim::debug, get_manager(), and tim::invoke::start().

stop()

void tim::component::caliper_config::stop ( )

inline

Definition at line 284 of file timemory.hpp.

    {
        auto cnt = instance_tracker_t::stop();
        if(cnt == 0)
        {
            CONDITIONAL_PRINT_HERE(tim::settings::debug(), "%s",
                                   "Flushing Caliper ConfigManager");
            get_manager().flush();
        }
    }

References CONDITIONAL_PRINT_HERE, tim::debug, get_manager(), and tim::invoke::stop().

---

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

• timemory/components/caliper/components.hpp
• timemory/components/caliper/timemory.hpp