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

This class provides a value&hyphen;semantic representation of the formatting specification for a metric aggregate value&period;

== Synopsis

Declared in `&lt;balm&lowbar;metricformat&period;h&gt;`

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

== Description

The `scale()` is a multiplier used to scale the numeric value&period; The `format()` is a `printf`&hyphen;style format string suitable for formatting a single floating&hyphen;point value&period;

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/MetricFormatSpec/2constructor-06.adoc[`MetricFormatSpec`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balm/MetricFormatSpec/operator_assign.adoc[`operator&equals;`] 
| Assign to this format spec the value of the specified `rhs` format spec, and return a reference to this modifiable format spec&period;
| xref:BloombergLP/balm/MetricFormatSpec/format.adoc[`format`] 
| Return the address of the null&hyphen;terminated string containing the `printf`&hyphen;style format that may be used to format values&period;
| xref:BloombergLP/balm/MetricFormatSpec/print.adoc[`print`] 
| Format this object to the specified output stream&period;
| xref:BloombergLP/balm/MetricFormatSpec/scale.adoc[`scale`] 
| Return the floating&hyphen;point multiplier value that may be applied to scale formatted values&period;
| xref:BloombergLP/balm/MetricFormatSpec/setFormat.adoc[`setFormat`] 
| Set the `printf`&hyphen;style formatting string used when formatting&period;
| xref:BloombergLP/balm/MetricFormatSpec/setScale.adoc[`setScale`] 
| Set, to the specified `scale`, the scale multiplier that may be applied when formatting values&period;
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/MetricFormatSpec/formatValue.adoc[`formatValue`] 
| Write the specified `value` to the specified `stream` using the specified `format`, and return a reference to the modifiable `stream`&period;
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/operator_not_eq-07.adoc[`operator!&equals;`]
| Return `true` if the specified `lhs` and `rhs` metric format specs do not have the same value, and `false` otherwise&period;
| xref:BloombergLP/balm/operator_eq-0ea.adoc[`operator&equals;&equals;`]
| Return `true` if the specified `lhs` and `rhs` metric format specs have the same value, and `false` otherwise&period;
|===


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