BloombergLP::ball::Category

This class provides a container for a category name and threshold levels.

Synopsis

Declared in <ball_category.h>

class Category;

Description

Instances of Category are created and manipulated by CategoryManager. All threshold levels are integral values in the range [0 .. 255].

Implementation Note: The d_ruleThreshold and d_relevantRuleMask serve as a cache for logging rule evaluation (see ball_attributecontext). They are not meant to be modified by users of the logging system, and may be modified by const operations of the logging system.

Member Functions

NameDescription
Category [constructor]Create a category having the specified name and threshold levels.
categoryName Return the name of this category.
isEnabled Return true if logging at the specified level is enabled for this category, and false otherwise.
maxLevel Return the numerical maximum of the four levels of this category.
passLevel Return the pass level of this category.
recordLevel Return the record level of this category.
relevantRuleMask Return a reference to the non-modifiable relevant rule mask for this category.
ruleThreshold Return the maximum threshold for any rule associated with this category.
setLevels Set the threshold levels of this category if they are valid.
threshold Return the current maximum threshold among this category's levels.
thresholdLevels Return the aggregate threshold levels of this category.
triggerAllLevel Return the trigger-all level of this category.
triggerLevel Return the trigger level of this category.
operator BloombergLP::bslmf::NestedTraitDeclaration<Category, UsesBslmaAllocator> Declare that this type uses a bslma allocator.

Static Member Functions

NameDescription
areValidThresholdLevels Return true if each of the specified recordLevel, passLevel, triggerLevel and triggerAllLevel threshold values are in the range [0 .. 255], and false otherwise.

Friends

NameDescription
BloombergLP::ball::CategoryManagerImpUtilThis class provides a suite of free functions used to help implement a manager of categories and category holders.