[#BloombergLP-ball-HierarchicalCategorySetting]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::HierarchicalCategorySetting
:relfileprefix: ../../
:mrdocs:

This class represents a hierarchical category setting that consists of a category name prefix and 4 threshold level settings for categories whose name starts with that prefix. Instances of `HierarchicalCategorySetting` are created and manipulated by `LoggerManager`. All threshold levels are integral values in the range `[0 .. 255]`.

== Synopsis

Declared in `<ball_hierarchicalcategorysetting.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/HierarchicalCategorySetting/allocator_type.adoc[`allocator_type`] 
| This `typedef` is an alias for the allocator used by this object.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/HierarchicalCategorySetting/2constructor-03.adoc[`HierarchicalCategorySetting`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/ball/HierarchicalCategorySetting/operator_assign-00.adoc[`operator=`] 
| Assignment operators
| xref:BloombergLP/ball/HierarchicalCategorySetting/categoryPrefix.adoc[`categoryPrefix`] 
| Return the name prefix of this hierarchical category setting.
| xref:BloombergLP/ball/HierarchicalCategorySetting/get_allocator.adoc[`get_allocator`] 
| Return the allocator used by this object to supply memory.
| xref:BloombergLP/ball/HierarchicalCategorySetting/passLevel.adoc[`passLevel`] 
| Return the pass level of this hierarchical category setting.
| xref:BloombergLP/ball/HierarchicalCategorySetting/print.adoc[`print`] 
| Format this object to the specified output `stream` at the (absolute value of) the optionally specified indentation `level` and return a reference to `stream`. If `level` is specified, optionally specify `spacesPerLevel`, the number of spaces per indentation level for this and all of its nested objects. If `level` is negative, suppress indentation of the first line. If `spacesPerLevel` is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by `level`). If `stream` is not valid on entry, this operation has no effect. Note that the format is not fully specified, and can change without notice.
| xref:BloombergLP/ball/HierarchicalCategorySetting/recordLevel.adoc[`recordLevel`] 
| Return the record level of this hierarchical category setting.
| xref:BloombergLP/ball/HierarchicalCategorySetting/setLevels.adoc[`setLevels`] 
| Set the threshold levels of this hierarchical category settings object to the specified `recordLevel`, `passLevel`, `triggerLevel`, and `triggerAllLevel` values, respectively, if each of the specified values is in the range `[0 .. 255]`. Return 0 on success, and a non‐zero value otherwise (with no effect on the threshold levels of this object).
| xref:BloombergLP/ball/HierarchicalCategorySetting/triggerAllLevel.adoc[`triggerAllLevel`] 
| Return the trigger‐all level of this hierarchical category setting.
| xref:BloombergLP/ball/HierarchicalCategorySetting/triggerLevel.adoc[`triggerLevel`] 
| Return the trigger level of this hierarchical category setting.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/ball/operator_not_eq-0a2.adoc[BloombergLP::ball::operator!=]`
| Return `true` if the specified `lhs` and `rhs` hierarchical category settings do not have the same value, and `false` otherwise. Two such objects differ in value if their category name prefix or threshold values differ.
| `xref:BloombergLP/ball/operator_eq-0f00.adoc[BloombergLP::ball::operator==]`
| Return `true` if the specified `lhs` and `rhs` hierarchical category settings have the same value, and `false` otherwise. Two such objects have the same value if they have the same category name prefix and threshold values.
|===


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