Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::ResourceProfilingDataSample Class Reference

The resource profiling data sample. More...

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

Classes

class  Factory
 The resource factory. More...
 

Public Member Functions

void addDeploymentDuration (ResourceProfilingContextSharedPtr deploymentContext, ResourceProfilingContext::Duration duration)
 Adds to the resource profiling data sample the duration of resource deployment and the deployment context. More...
 
void addLoadingDuration (ResourceProfilingContextSharedPtr loadingContext, ResourceProfilingContext::Duration duration)
 Adds to the resource profiling data sample the duration of resource loading and the loading context. More...
 
const ResourceProfilingContextgetAcquireContext () const
 Gets the acquire resource context. More...
 
void getAttributes (ResourceProfilingAttributes &attributes) const
 Gets the attributes of the profiled resource. More...
 
const ResourceProfilingContextgetDeploymentContext () const
 Gets the deployment context. More...
 
ResourceProfilingContext::Duration getDeploymentDuration () const
 Gets the duration of resource deployment. More...
 
uint64_t getID () const
 Gets the ID of the profiled resource. More...
 
const ResourceProfilingContextgetLoadingContext () const
 Gets the loading context. More...
 
ResourceProfilingContext::Duration getLoadingDuration () const
 Gets the duration of resource loading. More...
 
bool getSuccess () const
 Gets the loading status of the profiled resource. More...
 
string getType () const
 Gets the type of the profiled resource. More...
 
string getUrl () const
 Gets the URL of the profiled resource. More...
 
void setResourceType (string_view type)
 Sets the type of the profiled resource. More...
 
void setSuccess (bool success)
 Sets the loading status of the profiled resource. More...
 

Protected Member Functions

 ResourceProfilingDataSample (ResourceProfilingContextSharedPtr acquireContext, string_view url)
 Constructor. More...
 

Detailed Description

The resource profiling data sample.

Constructor & Destructor Documentation

kanzi::ResourceProfilingDataSample::ResourceProfilingDataSample ( ResourceProfilingContextSharedPtr  acquireContext,
string_view  url 
)
explicitprotected

Constructor.

Parameters
acquireContextThe acquire context.
urlThe URL of the profiled context.

Member Function Documentation

ResourceProfilingContext::Duration kanzi::ResourceProfilingDataSample::getLoadingDuration ( ) const

Gets the duration of resource loading.

Returns
The duration of resource loading.
ResourceProfilingContext::Duration kanzi::ResourceProfilingDataSample::getDeploymentDuration ( ) const

Gets the duration of resource deployment.

Returns
The duration of resource deployment.
string kanzi::ResourceProfilingDataSample::getUrl ( ) const

Gets the URL of the profiled resource.

Returns
The URL of the profiled resource.
string kanzi::ResourceProfilingDataSample::getType ( ) const

Gets the type of the profiled resource.

Returns
The type of the profiled resource.
See also
setResourceType()
uint64_t kanzi::ResourceProfilingDataSample::getID ( ) const

Gets the ID of the profiled resource.

Returns
The ID of the profiled resource.
bool kanzi::ResourceProfilingDataSample::getSuccess ( ) const

Gets the loading status of the profiled resource.

Returns
The loading status of the profiled resource.
void kanzi::ResourceProfilingDataSample::addLoadingDuration ( ResourceProfilingContextSharedPtr  loadingContext,
ResourceProfilingContext::Duration  duration 
)

Adds to the resource profiling data sample the duration of resource loading and the loading context.

Parameters
loadingContextThe loading context.
durationThe loading duration.
See also
getLoadingContext(), getLoadingDuration()
void kanzi::ResourceProfilingDataSample::addDeploymentDuration ( ResourceProfilingContextSharedPtr  deploymentContext,
ResourceProfilingContext::Duration  duration 
)

Adds to the resource profiling data sample the duration of resource deployment and the deployment context.

Parameters
deploymentContextThe deployment context.
durationThe deployment duration.
See also
getDeploymentContext(), getDeploymentDuration()
void kanzi::ResourceProfilingDataSample::setResourceType ( string_view  type)

Sets the type of the profiled resource.

Parameters
typeThe type of the profiled resource.
See also
getType()
void kanzi::ResourceProfilingDataSample::setSuccess ( bool  success)

Sets the loading status of the profiled resource.

Parameters
successThe loading status of the profiled resource.
See also
getSuccess()
const ResourceProfilingContext* kanzi::ResourceProfilingDataSample::getAcquireContext ( ) const
inline

Gets the acquire resource context.

Returns
The acquire resource context.
const ResourceProfilingContext* kanzi::ResourceProfilingDataSample::getLoadingContext ( ) const
inline

Gets the loading context.

Returns
The loading context.
const ResourceProfilingContext* kanzi::ResourceProfilingDataSample::getDeploymentContext ( ) const
inline

Gets the deployment context.

Returns
The deployment context.
void kanzi::ResourceProfilingDataSample::getAttributes ( ResourceProfilingAttributes attributes) const

Gets the attributes of the profiled resource.

Parameters
attributesThe attributes object to fill out with the attributes of the profiled resource.

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