kanzi::ProfilingCategory Class Reference

Represents the runtime state of the profiling category. More...

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

Public Member Functions
FixedString	getName () const
	Gets the name of a profiling category. More...
bool	isEnabled () const
	Checks whether a profiling category is enabled. More...
void	resetEnabledToInitial ()
	Resets the profiling category to its initial runtime state. More...
void	setEnabled (bool enabled)
	Enables or disables the profiling category. More...

Static Public Member Functions
static ProfilingCategory &	create (FixedString name, bool initialEnabled)
	Creates a new profiling category. More...
static ProfilingCategory *	findByName (string_view name)
	Looks up a profiling category by its name. More...
static void	resetAllEnabledToInitial ()
	Resets all profiling categories to their initial runtime state. More...
static void	setAllEnabled (bool enabled)
	Enables or disables all profiling categories. More...
static void	setFilter (string_view filterConfiguration)
	Sets the category filter. More...

Detailed Description

Represents the runtime state of the profiling category.

Member Function Documentation

static ProfilingCategory& kanzi::ProfilingCategory::create ( FixedString  name, bool  initialEnabled  )

static

Creates a new profiling category.

Do not call this function directly.

This function is used to create a new profiling category object. The name you provide in the name parameter should be unique for each category. The function raises an exception if a category with the given name already exists.

Parameters

name	The name of the new category.
initialEnabled	The initial runtime state of the category.

Returns

The reference to new profiling category.

static void kanzi::ProfilingCategory::setFilter ( string_view  filterConfiguration )

static

Sets the category filter.

Do not call this function directly.

Parameters

filterConfiguration

Filter configuration string.

static ProfilingCategory* kanzi::ProfilingCategory::findByName ( string_view  name )

static

Looks up a profiling category by its name.

Use profiling category name you provided in name to look up created profiling category. See create() for details.

Parameters

name	The name of the profiling category to look up.

Returns

Pointer to the profiling category object, 0 if category was not found.

void kanzi::ProfilingCategory::setEnabled ( bool  enabled )

inline

Enables or disables the profiling category.

Parameters

enabled

Whether to enable or disable the category.

void kanzi::ProfilingCategory::resetEnabledToInitial ( )

inline

Resets the profiling category to its initial runtime state.

static void kanzi::ProfilingCategory::setAllEnabled ( bool  enabled )

static

Enables or disables all profiling categories.

Parameters

enabled

Whether to enable or disable all categories.

static void kanzi::ProfilingCategory::resetAllEnabledToInitial ( )

static

Resets all profiling categories to their initial runtime state.

FixedString kanzi::ProfilingCategory::getName ( ) const

inline

Gets the name of a profiling category.

Returns

Category name.

bool kanzi::ProfilingCategory::isEnabled ( ) const

inline

Checks whether a profiling category is enabled.

Returns

True if the category is enabled, otherwise false.

---

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

• kanzi/core/profiling/profiling_category.hpp