tim::env_settings Class Reference

#include "timemory/environment/declaration.hpp"

Collaboration diagram for tim::env_settings:

Public Types
using	string_t = std::string
using	env_map_t = std::map< string_t, string_t >
using	env_uomap_t = std::map< string_t, string_t >
using	env_pair_t = std::pair< string_t, string_t >
using	iterator = typename env_map_t::iterator
using	const_iterator = typename env_map_t::const_iterator
using	filter_func_t = std::function< bool(const std::string &)>

Public Member Functions
template<typename Tp >
void	insert (const std::string &env_id, Tp val)
env_map_t	get () const
iterator	get (const string_t &_entry)
const_iterator	get (const string_t &_entry) const
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
void	print (std::ostream &, filter_func_t &&_filter=[](const std::string &) { return true;}) const
template<typename Archive >
void	serialize (Archive &ar, unsigned int)

Static Public Member Functions
static env_settings *	instance ()
template<typename Archive >
static void	serialize_environment (Archive &ar)

Friends
std::ostream &	operator<< (std::ostream &os, const env_settings &env)

Detailed Description

Definition at line 54 of file declaration.hpp.

Member Typedef Documentation

const_iterator

using tim::env_settings::const_iterator = typename env_map_t::const_iterator

Definition at line 62 of file declaration.hpp.

env_map_t

using tim::env_settings::env_map_t = std::map<string_t, string_t>

Definition at line 58 of file declaration.hpp.

env_pair_t

using tim::env_settings::env_pair_t = std::pair<string_t, string_t>

Definition at line 60 of file declaration.hpp.

env_uomap_t

using tim::env_settings::env_uomap_t = std::map<string_t, string_t>

Definition at line 59 of file declaration.hpp.

filter_func_t

using tim::env_settings::filter_func_t = std::function<bool(const std::string&)>

Definition at line 63 of file declaration.hpp.

iterator

using tim::env_settings::iterator = typename env_map_t::iterator

Definition at line 61 of file declaration.hpp.

string_t

using tim::env_settings::string_t = std::string

Definition at line 57 of file declaration.hpp.

Member Function Documentation

begin() [1/2]

iterator tim::env_settings::begin ( )

inline

Definition at line 82 of file declaration.hpp.

{ return m_env->begin(); }

begin() [2/2]

const_iterator tim::env_settings::begin ( ) const

inline

Definition at line 84 of file declaration.hpp.

{ return m_env->begin(); }

end() [1/2]

iterator tim::env_settings::end ( )

inline

Definition at line 83 of file declaration.hpp.

{ return m_env->end(); }

end() [2/2]

const_iterator tim::env_settings::end ( ) const

inline

Definition at line 85 of file declaration.hpp.

{ return m_env->end(); }

get() [1/3]

env_map_t tim::env_settings::get

(

)

const

get() [2/3]

iterator tim::env_settings::get ( const string_t &  _entry )

inline

Definition at line 80 of file declaration.hpp.

{ return m_env->find(_entry); }

get() [3/3]

const_iterator tim::env_settings::get ( const string_t &  _entry ) const

inline

Definition at line 81 of file declaration.hpp.

{ return m_env->find(_entry); }

insert()

template<typename Tp >

void tim::env_settings::insert	(	const std::string &	env_id,
		Tp	val
	)

Definition at line 128 of file declaration.hpp.

{
#if !defined(TIMEMORY_DISABLE_STORE_ENVIRONMENT)
    std::stringstream ss;
    ss << std::boolalpha << val;
 
    auto_lock_t lk(type_mutex<env_settings>(), std::defer_lock);
    if(lock_flag().load() && !lk.owns_lock())
        lk.lock();
 
    if(m_env &&
       (m_env->find(env_id) == m_env->end() || m_env->find(env_id)->second != ss.str()))
        (*m_env)[env_id] = ss.str();
#else
    consume_parameters(env_id, val);
#endif
}

References tim::consume_parameters(), and tim::cereal::load().

instance()

static env_settings * tim::env_settings::instance ( )

static

Referenced by tim::get_env(), tim::load_env(), tim::print_env(), serialize_environment(), and tim::TIMEMORY_ENVIRONMENT_LINKAGE().

print()

void tim::env_settings::print	(	std::ostream &	,
		filter_func_t &&	_filter = [](const std::string &) { return true;}
	)		const

Referenced by tim::print_env().

serialize()

template<typename Archive >

void tim::env_settings::serialize	(	Archive &	ar,
		unsigned int
	)

Definition at line 150 of file declaration.hpp.

{
    auto _tmp = env_uomap_t{};
    if(!m_env)
        m_env = &_tmp;
 
    collapse();
 
    auto_lock_t lk(type_mutex<env_settings>(), std::defer_lock);
    lock_flag().store(true);
 
    if(!lk.owns_lock())
        lk.lock();
 
    ar(cereal::make_nvp("environment", *m_env));
 
    if(m_env == &_tmp)
        m_env = nullptr;
 
    lock_flag().store(false);
}

Referenced by serialize_environment().

serialize_environment()

template<typename Archive >

static void tim::env_settings::serialize_environment ( Archive &  ar )

inlinestatic

Definition at line 103 of file declaration.hpp.

    {
        if(instance())
            instance()->serialize(ar, TIMEMORY_GET_CLASS_VERSION(tim::env_settings));
    }

References instance(), serialize(), and TIMEMORY_GET_CLASS_VERSION.

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const env_settings &  env  )

friend

Definition at line 90 of file declaration.hpp.

    {
        env.print(os);
        return os;
    }

---

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

• timemory/environment/declaration.hpp