#include "timemory/components/opaque/types.hpp"

Collaboration diagram for tim::component::opaque:

Public Types
using	init_func_t = std::function< void()>

using	setup_func_t = std::function< void (void , const string_view_t &, scope::config)>

using	push_func_t = std::function< void(void *&, const string_view_t &, scope::config)>

using	start_func_t = std::function< void(void *)>

using	stop_func_t = std::function< void(void *)>

using	pop_func_t = std::function< void(void *)>

using	get_func_t = std::function< void(void , void &, size_t)>

using	delete_func_t = std::function< void(void *)>

using	sample_func_t = std::function< void(void *)>

Public Member Functions
template<typename InitF , typename StartF , typename StopF , typename GetF , typename DelF , typename SetupF , typename PushF , typename PopF , typename SampleF >
	opaque (bool _valid, size_t _typeid, InitF &&_init, StartF &&_start, StopF &&_stop, GetF &&_get, DelF &&_del, SetupF &&_setup, PushF &&_push, PopF &&_pop, SampleF &&_sample)

	opaque ()=default

	~opaque ()

	opaque (const opaque &)=default

	opaque (opaque &&)=default

opaque &	operator= (const opaque &)=default

opaque &	operator= (opaque &&)=default

	operator bool () const

void	init () const

void	setup (const string_view_t &_prefix, scope::config _scope)

void	push (const string_view_t &_prefix, scope::config _scope)

void	sample () const

void	start () const

void	stop () const

void	pop () const

void	cleanup ()

void	get (void *&ptr, size_t _hash) const

void	set_copy (bool val)

Public Attributes
bool	m_valid = false

bool	m_copy = false

size_t	m_typeid = 0

void *	m_data = nullptr

init_func_t	m_init = []() {}

setup_func_t	m_setup

push_func_t	m_push = [](void*&, const string_view_t&, scope::config) {}

start_func_t	m_start = [](void*) {}

stop_func_t	m_stop = [](void*) {}

pop_func_t	m_pop = [](void*) {}

get_func_t	m_get = [](void, void&, size_t) {}

delete_func_t	m_del = [](void*) {}

sample_func_t	m_sample = [](void*) {}

Detailed Description

Definition at line 45 of file types.hpp.

Member Typedef Documentation

◆ delete_func_t

using tim::component::opaque::delete_func_t = std::function<void(void*)>

Definition at line 54 of file types.hpp.

◆ get_func_t

using tim::component::opaque::get_func_t = std::function<void(void*, void*&, size_t)>

Definition at line 53 of file types.hpp.

◆ init_func_t

using tim::component::opaque::init_func_t = std::function<void()>

Definition at line 47 of file types.hpp.

◆ pop_func_t

using tim::component::opaque::pop_func_t = std::function<void(void*)>

Definition at line 52 of file types.hpp.

◆ push_func_t

using tim::component::opaque::push_func_t = std::function<void(void*&, const string_view_t&, scope::config)>

Definition at line 49 of file types.hpp.

◆ sample_func_t

using tim::component::opaque::sample_func_t = std::function<void(void*)>

Definition at line 55 of file types.hpp.

◆ setup_func_t

using tim::component::opaque::setup_func_t = std::function<void*(void*, const string_view_t&, scope::config)>

Definition at line 48 of file types.hpp.

◆ start_func_t

using tim::component::opaque::start_func_t = std::function<void(void*)>

Definition at line 50 of file types.hpp.

◆ stop_func_t

using tim::component::opaque::stop_func_t = std::function<void(void*)>

Definition at line 51 of file types.hpp.

Constructor & Destructor Documentation

◆ opaque() [1/4]

template<typename InitF , typename StartF , typename StopF , typename GetF , typename DelF , typename SetupF , typename PushF , typename PopF , typename SampleF >

tim::component::opaque::opaque	(	bool	_valid,
		size_t	_typeid,
		InitF &&	_init,
		StartF &&	_start,
		StopF &&	_stop,
		GetF &&	_get,
		DelF &&	_del,
		SetupF &&	_setup,
		PushF &&	_push,
		PopF &&	_pop,
		SampleF &&	_sample
	)

Definition at line 48 of file declaration.hpp.

 : m_valid(_valid)
 , m_typeid(_typeid)
 , m_init(std::move(_init))
 , m_setup(std::move(_setup))
 , m_push(std::move(_push))
 , m_start(std::move(_start))
 , m_stop(std::move(_stop))
 , m_pop(std::move(_pop))
 , m_get(std::move(_get))
 , m_del(std::move(_del))
 , m_sample(std::move(_sample))
 {}

◆ opaque() [2/4]

tim::component::opaque::opaque ( )

default

◆ ~opaque()

tim::component::opaque::~opaque ( )

inline

Definition at line 66 of file declaration.hpp.

 {
     if(m_data)
     {
         m_stop(m_data);
         m_del(m_data);
     }
 }

References m_data, m_del, and m_stop.

◆ opaque() [3/4]

tim::component::opaque::opaque ( const opaque & )

default

◆ opaque() [4/4]

tim::component::opaque::opaque ( opaque && )

default

Member Function Documentation

◆ cleanup()

void tim::component::opaque::cleanup ( )

inline

Definition at line 145 of file declaration.hpp.

 {
     if(m_data && !m_copy)
         m_del(m_data);
     m_data = nullptr;
 }

References m_copy, m_data, and m_del.

Referenced by setup().

◆ get()

void tim::component::opaque::get	(	void *&	ptr,
		size_t	_hash
	)		const

inline

Definition at line 155 of file declaration.hpp.

 {
     if(m_data)
         m_get(m_data, ptr, _hash);
 }

References m_data, and m_get.

◆ init()

void tim::component::opaque::init ( ) const

inline

Definition at line 78 of file declaration.hpp.

 {
     m_init();
 }

References m_init.

◆ operator bool()

tim::component::opaque::operator bool ( ) const

inline

Definition at line 71 of file types.hpp.

71 { return m_valid; }

References m_valid.

◆ operator=() [1/2]

opaque& tim::component::opaque::operator= ( const opaque & )

default

◆ operator=() [2/2]

opaque& tim::component::opaque::operator= ( opaque && )

default

◆ pop()

void tim::component::opaque::pop ( ) const

inline

Definition at line 136 of file declaration.hpp.

 {
     if(m_data)
         m_pop(m_data);
 }

References m_data, and m_pop.

◆ push()

void tim::component::opaque::push	(	const string_view_t &	_prefix,
		scope::config	_scope
	)

inline

Definition at line 100 of file declaration.hpp.

 {
     if(m_data)
         m_push(m_data, _prefix, _scope);
 }

References tim::_prefix, m_data, and m_push.

◆ sample()

void tim::component::opaque::sample ( ) const

inline

Definition at line 109 of file declaration.hpp.

 {
     if(m_data)
         m_sample(m_data);
 }

References m_data, and m_sample.

◆ set_copy()

void tim::component::opaque::set_copy ( bool val )

inline

Definition at line 164 of file declaration.hpp.

 {
     m_copy = val;
 }

References m_copy.

◆ setup()

void tim::component::opaque::setup	(	const string_view_t &	_prefix,
		scope::config	_scope
	)

inline

Definition at line 86 of file declaration.hpp.

 {
     if(m_data)
     {
         stop();
         cleanup();
     }
     m_data  = m_setup(m_data, _prefix, _scope);
     m_valid = (m_data != nullptr);
 }

References tim::_prefix, cleanup(), m_data, m_setup, m_valid, and stop().

◆ start()

void tim::component::opaque::start ( ) const

inline

Definition at line 118 of file declaration.hpp.

 {
     if(m_data)
         m_start(m_data);
 }

References m_data, and m_start.

◆ stop()

void tim::component::opaque::stop ( ) const

inline

Definition at line 127 of file declaration.hpp.

 {
     if(m_data)
         m_stop(m_data);
 }

References m_data, and m_stop.

Referenced by setup().

Member Data Documentation

◆ m_copy

bool tim::component::opaque::m_copy = false

Definition at line 85 of file types.hpp.

Referenced by cleanup(), and set_copy().

◆ m_data

void* tim::component::opaque::m_data = nullptr

Definition at line 87 of file types.hpp.

Referenced by ~opaque(), cleanup(), get(), pop(), push(), sample(), setup(), start(), and stop().

◆ m_del

delete_func_t tim::component::opaque::m_del = [](void*) {}

Definition at line 97 of file types.hpp.

Referenced by ~opaque(), and cleanup().

◆ m_get

get_func_t tim::component::opaque::m_get = [](void*, void*&, size_t) {}

Definition at line 96 of file types.hpp.

Referenced by get().

◆ m_init

init_func_t tim::component::opaque::m_init = []() {}

Definition at line 88 of file types.hpp.

Referenced by tim::component::factory::hidden::get_opaque(), and init().

◆ m_pop

pop_func_t tim::component::opaque::m_pop = [](void*) {}

Definition at line 95 of file types.hpp.

Referenced by pop().

◆ m_push

push_func_t tim::component::opaque::m_push = [](void*&, const string_view_t&, scope::config) {}

Definition at line 92 of file types.hpp.

Referenced by push().

◆ m_sample

sample_func_t tim::component::opaque::m_sample = [](void*) {}

Definition at line 98 of file types.hpp.

Referenced by sample().

◆ m_setup

setup_func_t tim::component::opaque::m_setup

Initial value:

= [](void*, const string_view_t&, scope::config) {
        return nullptr;
    }

Definition at line 89 of file types.hpp.

Referenced by setup().

◆ m_start

start_func_t tim::component::opaque::m_start = [](void*) {}

Definition at line 93 of file types.hpp.

Referenced by start().

◆ m_stop

stop_func_t tim::component::opaque::m_stop = [](void*) {}

Definition at line 94 of file types.hpp.

Referenced by ~opaque(), and stop().

◆ m_typeid

size_t tim::component::opaque::m_typeid = 0

Definition at line 86 of file types.hpp.

◆ m_valid

bool tim::component::opaque::m_valid = false

Definition at line 84 of file types.hpp.

Referenced by tim::component::factory::hidden::get_opaque(), operator bool(), and setup().

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

timemory/components/opaque/types.hpp
timemory/components/opaque/declaration.hpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ delete_func_t

◆ get_func_t

◆ init_func_t

◆ pop_func_t

◆ push_func_t

◆ sample_func_t

◆ setup_func_t

◆ start_func_t

◆ stop_func_t

Constructor & Destructor Documentation

◆ opaque() [1/4]

◆ opaque() [2/4]

◆ ~opaque()

◆ opaque() [3/4]

◆ opaque() [4/4]

Member Function Documentation

◆ cleanup()

◆ get()

◆ init()

◆ operator bool()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ pop()

◆ push()

◆ sample()

◆ set_copy()

◆ setup()

◆ start()

◆ stop()

Member Data Documentation

◆ m_copy

◆ m_data

◆ m_del

◆ m_get

◆ m_init

◆ m_pop

◆ m_push

◆ m_sample

◆ m_setup

◆ m_start

◆ m_stop

◆ m_typeid

◆ m_valid