BloombergLP::balm::IntegerCollector

This class provides a mechanism for collecting and aggregating the value of an integer metric over a period of time.

Synopsis

Declared in <balm_integercollector.h>

class IntegerCollector;

Description

The collector contains a MetricId object identifying the metric being collected, the number of times an event occurred, and the total, minimum, and maximum aggregates of the associated measurement value. The default value for the count is 0, the default value for the total is 0, the default value for the minimum is k_DEFAULT_MIN, and the default value for the maximum is k_DEFAULT_MAX.

Member Functions

Name

Description

IntegerCollector [constructor]

Create an integer collector for a metric having the specified metricId.

~IntegerCollector [destructor]

Destroy this object.

accumulateCountTotalMinMax

Accumulate the specified count, total, min, and max into this collector.

Load the current metric aggregates into the specified record.

Load the current metric aggregates into the specified records and reset this collector.

Return a reference to the non‐modifiable MetricId object identifying the metric for which this object collects values.

Reset the count, total, minimum, and maximum values of the metric being collected to their default states.

setCountTotalMinMax

Set the count, total, min, and max aggregates to the specified values.

Update the collected aggregates with the specified value.

Static Data Members

Name

Description

Deprecated alias for k_DEFAULT_MAX.

Deprecated alias for k_DEFAULT_MIN.

k_DEFAULT_MAX

Default maximum value (INT_MIN).

k_DEFAULT_MIN

Default minimum value (INT_MAX).

Created with MrDocs