This class provides an in‐core value‐semantic type for recording integer metric values.

Synopsis

Declared in <balm_integermetric.h>

class IntegerMetric;

Description

The value of a IntegerMetric object is characterized by the IntegerCollector object it uses to collect metric‐event values. Each instance of this class establishes (at construction) an association to an IntegerCollector object to which the metric delegates. A IntegerMetric value is constant after construction (i.e., it does not support assignment or provide manipulators that modify its collector value), so that synchronization primitives are not required to protect its data members. Note that if a collector or metrics manager is not supplied at construction, and if the default metrics manager has not been instantiated, then the metric will be inactive (i.e., isActive() is false) and the manipulator methods of the integer metric object will have no effect.

Member Functions

Name

Description

IntegerMetric [constructor]

Constructors

accumulateCountTotalMinMax

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

collector

collector overloads

increment

Increase the count and total of this integer metric by 1.

isActive

Return true if this integer metric will actively record metrics.

metricId

Return a MetricId object identifying this integer metric.

update

Update this integer metric with the specified value.

Static Member Functions

Name

Description

lookupCollector

lookupCollector overloads

Non-Member Functions

Name

Description

operator!=

Return true if lhs and rhs do not have the same value.

operator==

Return true if the specified lhs and rhs have the same value.

Created with MrDocs