MetroCollect  2.3.4
MetroCollectStats Struct Reference

Small struct to implement MetricsController delegate. More...

Inheritance diagram for MetroCollectStats:
Collaboration diagram for MetroCollectStats:

Public Member Functions

void metricsContollerCollectedMetricsValues (const MetroCollect::MetricsController &, const MetroCollect::MetricsDiffArray &, const MetroCollect::MetricsDataArray &, const MetroCollect::MetricsDataArray &) override
 Function called every time the MetricsController has collected new values. More...
 
void metricsContollerCollectedMetricsStats (const MetroCollect::MetricsController &, const MetroCollect::MetricsController::MetricsStats &) override
 Function called every time the MetricsController has computed statistics. More...
 
bool metricsContollerShouldStopCollectingMetrics (const MetroCollect::MetricsController &) override
 Function called after each iteration to ask the delegate whether the controller should stop collecting metrics. More...
 

Public Attributes

size_t iterationCount
 Number of iterations remaining to be done. More...
 
std::vector< std::pair< std::string, std::string > > names
 Name of collected metrics. More...
 

Detailed Description

Small struct to implement MetricsController delegate.

Definition at line 96 of file MetroCollectStats.cc.

Member Function Documentation

◆ metricsContollerCollectedMetricsStats()

void MetroCollectStats::metricsContollerCollectedMetricsStats ( const MetroCollect::MetricsController metricsController,
const MetroCollect::MetricsController::MetricsStats metricsStats 
)
inlineoverridevirtual

Function called every time the MetricsController has computed statistics.

Parameters
metricsControllerthe calling MetricsController
metricsStatscomputed statistics

Implements MetroCollect::MetricsControllerDelegate.

Definition at line 108 of file MetroCollectStats.cc.

◆ metricsContollerCollectedMetricsValues()

void MetroCollectStats::metricsContollerCollectedMetricsValues ( const MetroCollect::MetricsController metricsController,
const MetroCollect::MetricsDiffArray metricsDiff,
const MetroCollect::MetricsDataArray previousMetrics,
const MetroCollect::MetricsDataArray currentMetrics 
)
inlineoverridevirtual

Function called every time the MetricsController has collected new values.

Parameters
metricsControllerthe calling MetricsController
metricsDiffcomputed metrics differences
previousMetricsearlier collected metrics
currentMetricslatest collected metrics

Implements MetroCollect::MetricsControllerDelegate.

Definition at line 100 of file MetroCollectStats.cc.

◆ metricsContollerShouldStopCollectingMetrics()

bool MetroCollectStats::metricsContollerShouldStopCollectingMetrics ( const MetroCollect::MetricsController metricsController)
inlineoverridevirtual

Function called after each iteration to ask the delegate whether the controller should stop collecting metrics.

Parameters
metricsControllerthe calling MetricsController
Returns
true if the controller should stop
false otherwise

Implements MetroCollect::MetricsControllerDelegate.

Definition at line 112 of file MetroCollectStats.cc.

Member Data Documentation

◆ iterationCount

size_t MetroCollectStats::iterationCount

Number of iterations remaining to be done.

Definition at line 97 of file MetroCollectStats.cc.

◆ names

std::vector<std::pair<std::string, std::string> > MetroCollectStats::names

Name of collected metrics.

Definition at line 98 of file MetroCollectStats.cc.


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