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

This attribute class characterizes how to describe a metric.

== Synopsis

Declared in `<bdlm_metricdescriptor.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlm/MetricDescriptor/2constructor-04.adoc[`MetricDescriptor`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlm/MetricDescriptor/operator_assign.adoc[`operator=`] 
| Assign to this object the value of the specified `rhs` object, and return a reference providing modifiable access to this object.
| xref:BloombergLP/bdlm/MetricDescriptor/allocator.adoc[`allocator`] 
| Return the allocator used by this object to supply memory.
| xref:BloombergLP/bdlm/MetricDescriptor/instanceNumber.adoc[`instanceNumber`] 
| Return the `instanceNumber` attribute.
| xref:BloombergLP/bdlm/MetricDescriptor/metricName.adoc[`metricName`] 
| Return the `metricName` attribute.
| xref:BloombergLP/bdlm/MetricDescriptor/metricNamespace.adoc[`metricNamespace`] 
| Return the `metricNamespace` attribute.
| xref:BloombergLP/bdlm/MetricDescriptor/objectIdentifier.adoc[`objectIdentifier`] 
| Return the `objectIdentifier` attribute.
| xref:BloombergLP/bdlm/MetricDescriptor/objectTypeAbbreviation.adoc[`objectTypeAbbreviation`] 
| Return the `objectTypeAbbreviation` attribute.
| xref:BloombergLP/bdlm/MetricDescriptor/objectTypeName.adoc[`objectTypeName`] 
| Return the `objectTypeName` attribute.
| xref:BloombergLP/bdlm/MetricDescriptor/setInstanceNumber.adoc[`setInstanceNumber`] 
| Set the `instanceNumber` attribute of this object to the specified `value`.
| xref:BloombergLP/bdlm/MetricDescriptor/setMetricName.adoc[`setMetricName`] 
| Set the `metricName` attribute of this object to the specified `value`.
| xref:BloombergLP/bdlm/MetricDescriptor/setMetricNamespace.adoc[`setMetricNamespace`] 
| Set the `metricNamespace` attribute of this object to the specified `value`.
| xref:BloombergLP/bdlm/MetricDescriptor/setObjectIdentifier.adoc[`setObjectIdentifier`] 
| Set the `objectIdentifier` attribute of this object to the specified `value`.
| xref:BloombergLP/bdlm/MetricDescriptor/setObjectTypeAbbreviation.adoc[`setObjectTypeAbbreviation`] 
| Set the `objectTypeAbbreviation` attribute of this object to the specified `value`.
| xref:BloombergLP/bdlm/MetricDescriptor/setObjectTypeName.adoc[`setObjectTypeName`] 
| Set the `objectTypeName` attribute of this object to the specified `value`.
| xref:BloombergLP/bdlm/MetricDescriptor/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<MetricDescriptor, UsesBslmaAllocator>`] 
| Declare that this type uses a `bslma` allocator.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlm/MetricDescriptor/k_USE_METRICS_ADAPTER_NAMESPACE_SELECTION.adoc[`k_USE_METRICS_ADAPTER_NAMESPACE_SELECTION`] 
| Sentinel value indicating that the metrics adapter should select the namespace attribute.
| xref:BloombergLP/bdlm/MetricDescriptor/k_USE_METRICS_ADAPTER_OBJECT_ID_SELECTION.adoc[`k_USE_METRICS_ADAPTER_OBJECT_ID_SELECTION`] 
| Sentinel value indicating that the metrics adapter should select the object identifier attribute.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlm/operator_not_eq-03.adoc[BloombergLP::bdlm::operator!=]`
| Return `true` if the specified `lhs` and `rhs` objects do not have the same value, and `false` otherwise. Two `MetricDescriptor` objects do not have the same value if any of their attributes (respectively) do not have the same value.
| `xref:BloombergLP/bdlm/operator_eq-0b7.adoc[BloombergLP::bdlm::operator==]`
| Return `true` if the specified `lhs` and `rhs` objects have the same value, and `false` otherwise. Two `MetricDescriptor` objects have the same value if each of their attributes (respectively) have the same value.
|===


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