G4ProfilerConfig< Category > Class Template Reference

#include <G4Profiler.hh>

Data Structures
struct	PersistentSettings

Public Types
using	LabelFunc_t = G4ProfilerFunctors_t< Category, std::string >
using	LabelHandler_t = FuncHandler< this_type, LabelFunc_t, std::string >
using	QueryFunc_t = G4ProfilerFunctors_t< Category, bool >
using	QueryHandler_t = FuncHandler< this_type, QueryFunc_t, bool >
using	this_type = G4ProfilerConfig< Category >
using	ToolFunc_t = std::tuple< std::function< type *(const std::string &)> >
using	ToolHandler_t = FuncHandler< this_type, ToolFunc_t, type * >
using	type = G4ProfilerBundle< g4tim::user_bundle< Category, G4ProfileType > >

Public Member Functions
	G4ProfilerConfig ()=default
template<typename Arg , typename... Args>
	G4ProfilerConfig (Arg, Args...)
	G4ProfilerConfig (const G4ProfilerConfig &)=delete
	G4ProfilerConfig (G4ProfilerConfig &&)=default
template<int Idx>
G4ProfilerConfig< Ct >::template PersistentSettings< Idx > &	GetPersistent ()
template<int Idx>
G4ProfilerConfig< Ct >::template PersistentSettings< Idx > &	GetPersistentFallback ()
	operator bool () const
template<typename... Args>
bool	operator() (Args...)
G4ProfilerConfig &	operator= (const G4ProfilerConfig &)=delete
G4ProfilerConfig &	operator= (G4ProfilerConfig &&)=default
	~G4ProfilerConfig ()

Static Public Member Functions
static LabelHandler_t	GetFallbackLabelFunctor ()
static QueryHandler_t	GetFallbackQueryFunctor ()
static ToolHandler_t	GetFallbackToolFunctor ()
static LabelHandler_t	GetLabelFunctor ()
static QueryHandler_t	GetQueryFunctor ()
static ToolHandler_t	GetToolFunctor ()
template<typename... Args>
static std::string	Label (Args... _args)
template<typename... Args>
static bool	Query (Args... _args)
template<typename... Args>
static type *	Tool (const std::string &)

Static Public Attributes
static constexpr size_t	arg_sets

Private Types
template<bool B, typename Lhs , typename Rhs >
using	conditional_t = typename std::conditional< B, Lhs, Rhs >::type

Static Private Member Functions
static LabelFunc_t &	GetLables ()
template<int Idx>
static PersistentSettings< Idx > &	GetPersistent ()
template<int Idx>
static PersistentSettings< Idx > &	GetPersistentFallback ()
static QueryFunc_t &	GetQueries ()
static ToolFunc_t &	GetTools ()

Private Attributes
type *	m_bundle = nullptr

Detailed Description

template<size_t Category>
class G4ProfilerConfig< Category >

Definition at line 324 of file G4Profiler.hh.

Member Typedef Documentation

conditional_t

template<size_t Category>

template<bool B, typename Lhs , typename Rhs >

using G4ProfilerConfig< Category >::conditional_t = typename std::conditional<B, Lhs, Rhs>::type

private

Definition at line 412 of file G4Profiler.hh.

LabelFunc_t

template<size_t Category>

using G4ProfilerConfig< Category >::LabelFunc_t = G4ProfilerFunctors_t<Category, std::string>

Definition at line 334 of file G4Profiler.hh.

LabelHandler_t

template<size_t Category>

using G4ProfilerConfig< Category >::LabelHandler_t = FuncHandler<this_type, LabelFunc_t, std::string>

Definition at line 398 of file G4Profiler.hh.

QueryFunc_t

template<size_t Category>

using G4ProfilerConfig< Category >::QueryFunc_t = G4ProfilerFunctors_t<Category, bool>

Definition at line 333 of file G4Profiler.hh.

QueryHandler_t

template<size_t Category>

using G4ProfilerConfig< Category >::QueryHandler_t = FuncHandler<this_type, QueryFunc_t, bool>

Definition at line 397 of file G4Profiler.hh.

this_type

template<size_t Category>

using G4ProfilerConfig< Category >::this_type = G4ProfilerConfig<Category>

Definition at line 328 of file G4Profiler.hh.

ToolFunc_t

template<size_t Category>

using G4ProfilerConfig< Category >::ToolFunc_t = std::tuple<std::function<type*(const std::string&)> >

Definition at line 335 of file G4Profiler.hh.

ToolHandler_t

template<size_t Category>

using G4ProfilerConfig< Category >::ToolHandler_t = FuncHandler<this_type, ToolFunc_t, type*>

Definition at line 399 of file G4Profiler.hh.

type

template<size_t Category>

using G4ProfilerConfig< Category >::type = G4ProfilerBundle<g4tim::user_bundle<Category, G4ProfileType> >

Definition at line 327 of file G4Profiler.hh.

Constructor & Destructor Documentation

G4ProfilerConfig() [1/4]

template<size_t Category>

G4ProfilerConfig< Category >::G4ProfilerConfig ( )

default

G4ProfilerConfig() [2/4]

template<size_t Cat>

template<typename Arg , typename... Args>

G4ProfilerConfig< Cat >::G4ProfilerConfig	(	Arg	_arg,
		Args...	_args
	)

Definition at line 446 of file G4Profiler.hh.

{
  this->operator()(_arg, _args...);
}

~G4ProfilerConfig()

template<size_t Cat>

G4ProfilerConfig< Cat >::~G4ProfilerConfig

Definition at line 406 of file G4Profiler.cc.

{
  delete m_bundle;
}

G4ProfilerConfig() [3/4]

template<size_t Category>

G4ProfilerConfig< Category >::G4ProfilerConfig ( G4ProfilerConfig< Category > &&  )

default

G4ProfilerConfig() [4/4]

template<size_t Category>

G4ProfilerConfig< Category >::G4ProfilerConfig ( const G4ProfilerConfig< Category > &  )

delete

Member Function Documentation

GetFallbackLabelFunctor()

template<size_t Cat>

G4ProfilerConfig< Cat >::LabelHandler_t G4ProfilerConfig< Cat >::GetFallbackLabelFunctor

static

Definition at line 455 of file G4Profiler.cc.

{
  return LabelHandler_t{
    GetPersistentFallback<G4ProfileOp::Label>().m_functor
  };
}

GetFallbackQueryFunctor()

template<size_t Cat>

G4ProfilerConfig< Cat >::QueryHandler_t G4ProfilerConfig< Cat >::GetFallbackQueryFunctor

static

Definition at line 444 of file G4Profiler.cc.

{
  return QueryHandler_t{
    GetPersistentFallback<G4ProfileOp::Query>().m_functor
  };
}

GetFallbackToolFunctor()

template<size_t Cat>

G4ProfilerConfig< Cat >::ToolHandler_t G4ProfilerConfig< Cat >::GetFallbackToolFunctor

static

Definition at line 466 of file G4Profiler.cc.

{
  return ToolHandler_t{ GetPersistentFallback<G4ProfileOp::Tool>().m_functor };
}

GetLabelFunctor()

template<size_t Cat>

G4ProfilerConfig< Cat >::LabelHandler_t G4ProfilerConfig< Cat >::GetLabelFunctor

static

Definition at line 425 of file G4Profiler.cc.

{
  return LabelHandler_t{ GetPersistent<G4ProfileOp::Label>().m_functor };
}

GetLables()

template<size_t Category>

static LabelFunc_t & G4ProfilerConfig< Category >::GetLables ( )

inlinestaticprivate

Definition at line 372 of file G4Profiler.hh.

  {
    static LabelFunc_t _value;
    return _value;
  }

GetPersistent() [1/2]

template<size_t Category>

template<int Idx>

static PersistentSettings< Idx > & G4ProfilerConfig< Category >::GetPersistent ( )

staticprivate

GetPersistent() [2/2]

template<size_t Category>

template<int Idx>

G4ProfilerConfig< Ct >::template PersistentSettings< Idx > & G4ProfilerConfig< Category >::GetPersistent

(

)

Definition at line 372 of file G4Profiler.cc.

{
  //
  //  The pointers here automatically initialize on the first
  //  invocation on a thread and a reference is returned so they
  //  can be cleanly "leaked" at the application termination. Assignment
  //  is thread-safe and this scheme avoids having to deal with getters
  //  and setters. It is designed such that we can set defaults but
  //  the user can override them at any time.
  //
  // the first global instance copies from the fallback rountines, which are
  // assigned defaults in G4RunManager::ConfigureProfilers() but if the user
  // assigns new settings before creating G4RunManager, those defaults will
  // be ignored
  static PersistentSettings<Idx>* _instance =
    new PersistentSettings<Idx>(GetPersistentFallback<Idx>());
  static thread_local PersistentSettings<Idx>* _tlinstance = [=]() {
    static std::mutex mtx;
    std::unique_lock<std::mutex> lk(mtx);
    // If this is the primary thread, just return the global instance from
    // above. Modifying that instance will result in all threads created later
    // to inherit those settings
    static bool _first = true;
    if(_first)  // below uses comma operator to assign to false before return
      return ((_first = false), _instance);
    // if not first, make a copy from the primary thread
    return new PersistentSettings<Idx>(*_instance);
  }();
  return *_tlinstance;
}

References G4AttDefStore::mutex.

GetPersistentFallback() [1/2]

template<size_t Category>

template<int Idx>

static PersistentSettings< Idx > & G4ProfilerConfig< Category >::GetPersistentFallback ( )

staticprivate

GetPersistentFallback() [2/2]

template<size_t Category>

template<int Idx>

G4ProfilerConfig< Ct >::template PersistentSettings< Idx > & G4ProfilerConfig< Category >::GetPersistentFallback

(

)

Definition at line 358 of file G4Profiler.cc.

{
  // G4RunManager::ConfigureProfilers() assigns defaults to these lambdas
  // based on environment variables. The users should (generally) not modify
  // these.
  static PersistentSettings<Idx> _instance = PersistentSettings<Idx>{};
  return _instance;
}

GetQueries()

template<size_t Category>

static QueryFunc_t & G4ProfilerConfig< Category >::GetQueries ( )

inlinestaticprivate

Definition at line 366 of file G4Profiler.hh.

  {
    static QueryFunc_t _value;
    return _value;
  }

GetQueryFunctor()

template<size_t Cat>

G4ProfilerConfig< Cat >::QueryHandler_t G4ProfilerConfig< Cat >::GetQueryFunctor

static

Definition at line 416 of file G4Profiler.cc.

{
  return QueryHandler_t{ GetPersistent<G4ProfileOp::Query>().m_functor };
}

GetToolFunctor()

template<size_t Cat>

G4ProfilerConfig< Cat >::ToolHandler_t G4ProfilerConfig< Cat >::GetToolFunctor

static

Definition at line 434 of file G4Profiler.cc.

{
  return ToolHandler_t{ GetPersistent<G4ProfileOp::Tool>().m_functor };
}

GetTools()

template<size_t Category>

static ToolFunc_t & G4ProfilerConfig< Category >::GetTools ( )

inlinestaticprivate

Definition at line 378 of file G4Profiler.hh.

  {
    static ToolFunc_t _value;
    return _value;
  }

Label()

template<size_t Cat>

template<typename... Args>

std::string G4ProfilerConfig< Cat >::Label ( Args...  _args )

static

Definition at line 483 of file G4Profiler.hh.

{
  return LabelHandler_t{ GetPersistent<G4ProfileOp::Label>().m_functor }(
    _args...);
}

operator bool()

template<size_t Category>

G4ProfilerConfig< Category >::operator bool ( ) const

inline

Definition at line 361 of file G4Profiler.hh.

{ return (m_bundle != nullptr); }

References G4ProfilerConfig< Category >::m_bundle.

operator()()

template<size_t Cat>

template<typename... Args>

bool G4ProfilerConfig< Cat >::operator()

(

Args...

_args

)

Definition at line 455 of file G4Profiler.hh.

{
  if(Query(_args...))
  {
    m_bundle = Tool(Label(_args...));
    if(m_bundle)
      m_bundle->start(_args...);
    return (m_bundle != nullptr);
  }
  return false;
}

operator=() [1/2]

template<size_t Category>

G4ProfilerConfig & G4ProfilerConfig< Category >::operator= ( const G4ProfilerConfig< Category > &  )

delete

operator=() [2/2]

template<size_t Category>

G4ProfilerConfig & G4ProfilerConfig< Category >::operator= ( G4ProfilerConfig< Category > &&  )

default

Query()

template<size_t Cat>

template<typename... Args>

bool G4ProfilerConfig< Cat >::Query ( Args...  _args )

static

Definition at line 472 of file G4Profiler.hh.

{
  return QueryHandler_t{ GetPersistent<G4ProfileOp::Query>().m_functor }(
    _args...);
}

Tool()

template<size_t Cat>

template<typename... Args>

G4ProfilerConfig< Cat >::type * G4ProfilerConfig< Cat >::Tool ( const std::string &  _args )

static

Definition at line 494 of file G4Profiler.hh.

{
  return ToolHandler_t{ GetPersistent<G4ProfileOp::Tool>().m_functor }(_args);
}

Field Documentation

arg_sets

template<size_t Category>

constexpr size_t G4ProfilerConfig< Category >::arg_sets

staticconstexpr

Initial value:

=
    G4TypeListSize<G4ProfilerArgs_t<Category>>::value

Definition at line 330 of file G4Profiler.hh.

m_bundle

template<size_t Category>

type* G4ProfilerConfig< Category >::m_bundle = nullptr

private

Definition at line 364 of file G4Profiler.hh.

Referenced by G4ProfilerConfig< Category >::operator bool().

---

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

• source/global/management/include/G4Profiler.hh
• source/global/management/src/G4Profiler.cc