Kanzi  3.9.4
Kanzi Engine API
kanzi::GenericResourceProfilingContext Class Reference

Generic resource profiling context. More...

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

Inheritance diagram for kanzi::GenericResourceProfilingContext:
[legend]

Classes

class  Sampler
 The context sampler. More...
 

Protected Member Functions

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

Protected Attributes

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

Additional Inherited Members

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

Detailed Description

Generic resource profiling context.

Constructor & Destructor Documentation

◆ GenericResourceProfilingContext() [1/2]

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

Constructor.

Parameters
entryTimeStampThe timestamp evaluated at entry to the scope of the resource profiling context.
nameThe name of the context to create.
descriptionThe description of the created context.

◆ GenericResourceProfilingContext() [2/2]

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

Constructor.

Parameters
entryTimeStampThe timestamp evaluated at entry to the scope of the resource profiling context.
nameThe name of the context to create.
descriptionThe 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
attributesThe 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: