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

This class provides a mechanism for representing a category.

== Synopsis

Declared in `<balm_category.h>`

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

== Description

A category is an identifier used to group related metrics. A `Category` object contains the address of a null‐terminated string, `name`, holding the name of the category and a boolean value, `enabled`, indicating whether the category is currently enabled.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/Category/2constructor.adoc[`Category`]         [.small]#[constructor]#
| Create a category having the specified `name` address.
| xref:BloombergLP/balm/Category/2destructor.adoc[`~Category`] [.small]#[destructor]#
| Destroy this category object.
| xref:BloombergLP/balm/Category/enabled.adoc[`enabled`] 
| Report whether this category is enabled.
| xref:BloombergLP/balm/Category/isEnabledRaw.adoc[`isEnabledRaw`] 
| Return a reference to the enabled status of this category.
| xref:BloombergLP/balm/Category/name.adoc[`name`] 
| Return the address of the non‐modifiable null‐terminated string containing the name of this category.
| xref:BloombergLP/balm/Category/print.adoc[`print`] 
| Print this category to the specified output `stream` in some human readable form, and return the modifiable `stream`.
| xref:BloombergLP/balm/Category/registerCategoryHolder.adoc[`registerCategoryHolder`] 
| Register the specified category `holder` with this category.
| xref:BloombergLP/balm/Category/setEnabled.adoc[`setEnabled`] 
| Set the enabled state of this category.
| xref:BloombergLP/balm/Category/setName.adoc[`setName`] 
| Set the name of this metric to the specified `name` address. The behavior is undefined unless `name` remains valid and unmodified for the lifetime of this object.
|===



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