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

Create a metric description for the specified `category` and the specified `name`.

== Synopsis

Declared in `<balm_metricdescription.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
MetricDescription(
    xref:BloombergLP/balm/Category.adoc[Category] const* category,
    char const* name,
    xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]* basicAllocator = 0);
----

== Description

Optionally specify a `basicAllocator` used to supply memory. If `basicAllocator` is 0, the currently installed default allocator is used. The initial value for `preferredPublicationType` is `e_UNSPECIFIED`, and the initial value for `format` is 0. The behavior is undefined unless `name` and `category` remain valid, and the contents of `name` remain unmodified, for the lifetime of this object.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *category*
| address of the category (held, not owned)
| *name*
| null‐terminated metric name (held, not owned)
| *basicAllocator*
| memory allocator; null uses the default
|===


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