This class provides an in‐core value semantic type for recording and aggregating the values of a metric.

Synopsis

Declared in <balm_metric.h>

class Metric;

Description

The value of a Metric object is characterized by the Collector object it uses to collect metric‐event values. Each instance of this class establishes (at construction) an association to a Collector object to which the metric delegates. A Metric 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() == false) and the manipulator methods of the metric object will have no effect.

Member Functions

Name

Description

Metric [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 metric by 1.

isActive

Return true if this metric will actively record metrics, and false otherwise.

metricId

Return a MetricId object identifying this metric.

update

Increase the event count by 1 and add the specified value to the total recorded value.

Static Member Functions

Name

Description

lookupCollector

lookupCollector overloads

Non-Member Functions

Name

Description

operator!=

Return true if the specified lhs and rhs metrics do not have the same value and false otherwise.

operator==

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

Created with MrDocs