[#BloombergLP-balm-StopwatchScopedGuard-2constructor-01]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/StopwatchScopedGuard.adoc[StopwatchScopedGuard]::StopwatchScopedGuard
:relfileprefix: ../../../
:mrdocs:

Initialize this scoped guard to record elapsed time using the specified `collector`.

== Synopsis

Declared in `<balm_stopwatchscopedguard.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
explicit
StopwatchScopedGuard(
    xref:BloombergLP/balm/Collector.adoc[Collector]* collector,
    xref:BloombergLP/balm/StopwatchScopedGuard/Units.adoc[Units] timeUnits = k_SECONDS);
----

== Description

Optionally specify the `timeUnits` in which to report elapsed time. If `collector` is 0 or `collector‐>category().enabled() == false`, this object will be inactive (i.e., will not record any values). The behavior is undefined unless `collector == 0 || collector‐>metricId().isValid()`. Note that `timeUnits` indicates the scale of the double value reported by this guard, but does _not_ affect the precision of the elapsed time measurement.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *collector*
| collector used to record elapsed time
| *timeUnits*
| units in which to report elapsed time (optional)
|===


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