kanzi::ProfilerRegistry< TProfiler > Class Template Reference

Profiler registry. More...

#include <kanzi/core/profiling/profiler_registry.hpp>

Public Types

typedef shared_ptr< TProfiler > ProfilerSharedPtr
 The profiler shared point type. More...
 
typedef unordered_set< ProfilerSharedPtrProfilerContainer
 The profiler container type. More...
 

Public Member Functions

void registerProfiler (ProfilerSharedPtr profiler)
 Adds a new profiler to the registry. More...
 
void unregisterProfiler (ProfilerSharedPtr profiler)
 Removes a profiler from the registry. More...
 
ProfilerContainer::const_iterator beginProfilers () const
 Gets iterator to the begging of the profiler container. More...
 
ProfilerContainer::const_iterator endProfilers () const
 Gets iterator to the end of the profiler container. More...
 

Protected Attributes

ProfilerContainer m_registeredProfilers
 The registered profilers. More...
 

Detailed Description

template<typename TProfiler>
class kanzi::ProfilerRegistry< TProfiler >

Profiler registry.

Use the profiler registry to store profilers. To get begin/end iterators to the profiler container, use beginProfilers()/endProfilers().

Member Typedef Documentation

template<typename TProfiler>
typedef shared_ptr<TProfiler> kanzi::ProfilerRegistry< TProfiler >::ProfilerSharedPtr

The profiler shared point type.

template<typename TProfiler>
typedef unordered_set<ProfilerSharedPtr> kanzi::ProfilerRegistry< TProfiler >::ProfilerContainer

The profiler container type.

Member Function Documentation

template<typename TProfiler>
void kanzi::ProfilerRegistry< TProfiler >::registerProfiler ( ProfilerSharedPtr  profiler)
inline

Adds a new profiler to the registry.

Parameters
profilerThe ProfilerSharedPtr pointing to the profiler being added.
template<typename TProfiler>
void kanzi::ProfilerRegistry< TProfiler >::unregisterProfiler ( ProfilerSharedPtr  profiler)
inline

Removes a profiler from the registry.

Parameters
profilerThe ProfilerSharedPtr pointing to the profiler being removed.
template<typename TProfiler>
ProfilerContainer::const_iterator kanzi::ProfilerRegistry< TProfiler >::beginProfilers ( ) const
inline

Gets iterator to the begging of the profiler container.

Returns
The iterator to the begging of the profiler container.
template<typename TProfiler>
ProfilerContainer::const_iterator kanzi::ProfilerRegistry< TProfiler >::endProfilers ( ) const
inline

Gets iterator to the end of the profiler container.

Returns
The iterator to the end of the profiler container.

Member Data Documentation

template<typename TProfiler>
ProfilerContainer kanzi::ProfilerRegistry< TProfiler >::m_registeredProfilers
protected

The registered profilers.


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