[#BloombergLP-balm-MetricRecord]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::MetricRecord
:relfileprefix: ../../
:mrdocs:

Each instance of this class represents the aggregated value of a metric. A metric record contains a `MetricId` object (identifying the metric), the number of times the measured event has occurred as well as the minimum, maximum, and total of the measured value. The default `metricId` is the invalid id value, the default `count` is 0, the defined `k_DEFAULT_MIN` constant (the representation for positive default `total` is 0.0, the default `min` is the infinity), and the default `max` is the defined `k_DEFAULT_MAX` constant (the representation for negative infinity).

== Synopsis

Declared in `<balm_metricrecord.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class MetricRecord;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/MetricRecord/2constructor-0fc.adoc[`MetricRecord`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balm/MetricRecord/count-01.adoc[`count`] 
| `count` overloads
| xref:BloombergLP/balm/MetricRecord/max-0c.adoc[`max`] 
| `max` overloads
| xref:BloombergLP/balm/MetricRecord/metricId-07.adoc[`metricId`] 
| `metricId` overloads
| xref:BloombergLP/balm/MetricRecord/min-0d.adoc[`min`] 
| `min` overloads
| xref:BloombergLP/balm/MetricRecord/print.adoc[`print`] 
| Write a description of this record to the specified `stream` and return a reference to the modifiable `stream`.
| xref:BloombergLP/balm/MetricRecord/total-03.adoc[`total`] 
| `total` overloads
| xref:BloombergLP/balm/MetricRecord/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<MetricRecord, is_trivially_copyable>`] 
| Declare that this type is trivially copyable.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/MetricRecord/DEFAULT_MAX.adoc[`DEFAULT_MAX`] 
| Deprecated alias for `k_DEFAULT_MAX`.
| xref:BloombergLP/balm/MetricRecord/DEFAULT_MIN.adoc[`DEFAULT_MIN`] 
| Deprecated alias for `k_DEFAULT_MIN`.
| xref:BloombergLP/balm/MetricRecord/k_DEFAULT_MAX.adoc[`k_DEFAULT_MAX`] 
| Default maximum value (negative infinity).
| xref:BloombergLP/balm/MetricRecord/k_DEFAULT_MIN.adoc[`k_DEFAULT_MIN`] 
| Default minimum value (positive infinity).
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/operator_not_eq-06.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` metric records do not have the same value and `false` otherwise. Two records do not have same value if they differ in their respective values for `metricId`, `count`, `total`, `min`, or `max` attributes.
| xref:BloombergLP/balm/operator_eq-0b.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` metric records have the same value and `false` otherwise. Two records have the same value if they have the same values for their `metricId`, `count`, `total`, `min`, and `max` attributes, respectively.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#