Ocean
Ocean::HighPerformanceStatistic::ScopedStatistic Class Reference

This class defines a scoped high performance statistic module. More...

Public Member Functions

 ScopedStatistic (HighPerformanceStatistic &performance)
 Creates a new scoped statistic object and starts a new measurement. More...
 
 ~ScopedStatistic ()
 Destructs a scoped statistic object and stops the measurement. More...
 
void release ()
 Explicitly releases the object and does not wait until the scope ends. More...
 

Private Member Functions

 ScopedStatistic (const ScopedStatistic &)=delete
 Deleted copy constructor. More...
 
ScopedStatisticoperator= (const ScopedStatistic &)=delete
 Deleted copy operator. More...
 

Private Attributes

HighPerformanceStatisticstatisticPerformance
 High performance statistic object receiving the measurement value. More...
 

Detailed Description

This class defines a scoped high performance statistic module.

Use this scoped module in combination with a high performance statistic object to add a new performance measurement during the existence of this module.

Constructor & Destructor Documentation

◆ ScopedStatistic() [1/2]

Ocean::HighPerformanceStatistic::ScopedStatistic::ScopedStatistic ( HighPerformanceStatistic performance)
inlineexplicit

Creates a new scoped statistic object and starts a new measurement.

Parameters
performanceHigh performance statistic object receiving the scoped measurement.

◆ ~ScopedStatistic()

Ocean::HighPerformanceStatistic::ScopedStatistic::~ScopedStatistic ( )
inline

Destructs a scoped statistic object and stops the measurement.

◆ ScopedStatistic() [2/2]

Ocean::HighPerformanceStatistic::ScopedStatistic::ScopedStatistic ( const ScopedStatistic )
privatedelete

Deleted copy constructor.

Member Function Documentation

◆ operator=()

ScopedStatistic& Ocean::HighPerformanceStatistic::ScopedStatistic::operator= ( const ScopedStatistic )
privatedelete

Deleted copy operator.

Returns
Reference to this object

◆ release()

void Ocean::HighPerformanceStatistic::ScopedStatistic::release ( )
inline

Explicitly releases the object and does not wait until the scope ends.

Field Documentation

◆ statisticPerformance

HighPerformanceStatistic* Ocean::HighPerformanceStatistic::ScopedStatistic::statisticPerformance
private

High performance statistic object receiving the measurement value.


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