This class provides a mechanism for representing a category.

Synopsis

Declared in <balm_category.h>

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

Name

Description

Category [constructor]

Create a category having the specified name address.

~Category [destructor]

Destroy this category object.

enabled

Report whether this category is enabled.

isEnabledRaw

Return a reference to the enabled status of this category.

name

Return the address of the non‐modifiable null‐terminated string containing the name of this category.

print

Print this category to the specified output stream in some human readable form, and return the modifiable stream.

registerCategoryHolder

Register the specified category holder with this category.

setEnabled

Set the enabled state of this category.

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.

Created with MrDocs