kanzi::GenericResourceProfilingContext Class Reference

Generic resource profiling context. More...

#include <kanzi/core.ui/resource/generic_resource_profiling_context.hpp>

Inheritance diagram for kanzi::GenericResourceProfilingContext:

Classes
class	Sampler
	The context sampler. More...

Protected Member Functions
	GenericResourceProfilingContext (TimeStamp entryTimeStamp, string &&name, string &&description)
	Constructor.
	GenericResourceProfilingContext (TimeStamp entryTimeStamp, string_view name, string_view description)
	Constructor.
void	getAttributesOverride (ResourceProfilingAttributes &attributes) const override
	Gets the attributes of the context defined in the derived class.
Protected Member Functions inherited from kanzi::NamedResourceProfilingContext
void	getAttributesOverride (ResourceProfilingAttributes &attributes) const override
	Gets the attributes of the context defined in the derived class.
	NamedResourceProfilingContext (TimeStamp entryTimeStamp, string &&name)
	Constructor.
	NamedResourceProfilingContext (TimeStamp entryTimeStamp, string_view name)
	Constructor.
Protected Member Functions inherited from kanzi::ResourceProfilingContext
Duration	getDependenciesDuration () const
	Gets the total duration of all dependency contexts.
virtual Duration	getDurationOverride () const
	Gets the duration of the context.
	ResourceProfilingContext (TimeStamp entryTimeStamp)
	Constructor.

Protected Attributes
string	m_description
	The description of the context.
Protected Attributes inherited from kanzi::NamedResourceProfilingContext
string	m_name
	The name of the context.

Additional Inherited Members
Public Types inherited from kanzi::ResourceProfilingContext
typedef chrono::nanoseconds	Duration
	The duration type.
typedef vector< ResourceProfilingContextSharedPtr >	ResourceProfilingContextContainer
	The resource profiling context container.
typedef Duration	TimeStamp
	The timestamp.
Public Member Functions inherited from kanzi::ResourceProfilingContext
void	addDependencyContext (ResourceProfilingContextSharedPtr context)
	Adds a dependency context.
void	getAttributes (ResourceProfilingAttributes &attributes) const
	Retrieves the attributes of the context.
const ResourceProfilingContextContainer &	getDependencyContexts () const
	Gets dependency contexts container.
TimeStamp	getEntryTimeStamp () const
	Gets the entry timestamp of the context.
uint64_t	getID () const
	Gets the unique identifier of the context.
void	recordExitTimeStamp ()
	Records exit timestamp on the context.
virtual	~ResourceProfilingContext ()
	Destructor.
Static Public Member Functions inherited from kanzi::ResourceProfilingContext
static TimePoint	getCurrentTimePoint ()
	Gets the current timepoint.
static TimeStamp	getCurrentTimeStamp ()
	Gets the current timestamp.

Detailed Description

Generic resource profiling context.

Constructor & Destructor Documentation

GenericResourceProfilingContext() [1/2]

kanzi::GenericResourceProfilingContext::GenericResourceProfilingContext ( TimeStamp entryTimeStamp, string && name, string && description )

explicitprotected

Constructor.

Parameters

entryTimeStamp	The timestamp evaluated at entry to the scope of the resource profiling context.
name	The name of the context to create.
description	The description of the created context.

GenericResourceProfilingContext() [2/2]

kanzi::GenericResourceProfilingContext::GenericResourceProfilingContext ( TimeStamp entryTimeStamp, string_view name, string_view description )

explicitprotected

Constructor.

Parameters

entryTimeStamp	The timestamp evaluated at entry to the scope of the resource profiling context.
name	The name of the context to create.
description	The description of the created context.

Member Function Documentation

getAttributesOverride()

void kanzi::GenericResourceProfilingContext::getAttributesOverride ( ResourceProfilingAttributes & attributes ) const

overrideprotectedvirtual

Gets the attributes of the context defined in the derived class.

Parameters

attributes

The attributes object to fill out with the attributes of the context. see getAttributes()

Reimplemented from kanzi::ResourceProfilingContext.

Member Data Documentation

m_description

string kanzi::GenericResourceProfilingContext::m_description

protected

The description of the context.

---

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

• kanzi/core.ui/resource/generic_resource_profiling_context.hpp