[#BloombergLP-bdlm-Metric]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlm.adoc[bdlm]::Metric
:relfileprefix: ../../
:mrdocs:

This class provides storage for various types of metric values.

== Synopsis

Declared in `<bdlm_metric.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlm/Metric/Gauge.adoc[`Gauge`] 
| This `typedef` is an alias for a gauge metric value.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlm/Metric/2constructor-08.adoc[`Metric`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlm/Metric/operator_assign.adoc[`operator=`] 
| Assign to this metric the specified `value`.
| xref:BloombergLP/bdlm/Metric/isGauge.adoc[`isGauge`] 
| Return `true` if the value of this metric is of gauge type, and `false` otherwise.
| xref:BloombergLP/bdlm/Metric/theGauge.adoc[`theGauge`] 
| Return a `const` reference to the value of this metric of gauge type. The behavior is undefined unless `true == isGuage()`.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlm/operator_not_eq-06.adoc[BloombergLP::bdlm::operator!=]`
| Return `true` if the specified `lhs` command‐line metric has a different value from the specified `rhs` command‐line metric, and `false` otherwise. Two `Metric` objects do not have the same value if their types are not the same or they have different values.
| `xref:BloombergLP/bdlm/operator_eq-0e.adoc[BloombergLP::bdlm::operator==]`
| Return `true` if the specified `lhs` and `rhs` have the same value, and `false` otherwise. Two `Metric` objects have the same value if their types are the same and they have the same value.
|===


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