This class manages a registry of categories.

Synopsis

Declared in <ball_categorymanager.h>

class CategoryManager;

Description

This class manages a set (or "registry") of categories. Categories may be added to the registry, but they cannot be removed. However, the threshold levels of existing categories may be accessed and modified directly.

Type Aliases

Name

Description

CategoryNameFilterCallback

CategoryNameFilterCallback is the type of the user‐supplied functor that translates external category names to internal names.

DefaultThresholdLevelsCallback

Functor type that computes default threshold levels for new categories.

Member Functions

Name

Description

CategoryManager [constructor]

Constructors

~CategoryManager [destructor]

Destroy this category manager.

addCategory

Add a category with the specified name and threshold levels.

addCategoryHierarchically

Add a category inheriting thresholds from the longest matching prefix.

addDefaultCategory

Add the default category if it has not already been added.

addRule

Add the specified rule to the unique rule set of this object.

addRules

Add each rule in ruleSet to the unique rule set of this object.

defaultCategory

defaultCategory overloads

defaultPassThresholdLevel

Return the default pass threshold level of this object.

defaultRecordThresholdLevel

Return the default record threshold level of this object.

defaultThresholdLevels

Return the default threshold levels associated with this object.

defaultTriggerAllThresholdLevel

Return the default trigger‐all threshold level of this object.

defaultTriggerThresholdLevel

Return the default trigger threshold level of this object.

length

Return the number of categories in the registry of this category manager.

lookupCategory

lookupCategory overloads

maxNumCategories

Return the current capacity of this category registry.

operator[]

Subscript operators

removeAllRules

Remove every rule from the set of rules maintained by this object.

removeRule

Remove the specified rule from the unique rule set of this object.

removeRules

Remove each rule in ruleSet from the rule set of this object.

resetCategoryHolders

Reset all linked category holders to their default values.

resetDefaultThresholdLevels

Reset the default threshold levels to the original "factory‐supplied" default values or the factory overrides supplied at construction.

ruleSet

Return a const reference to the maintained rule set.

ruleSetSequenceNumber

Return the sequence number that tracks rule‐set changes.

rulesetMutex

Return a reference to the mutex guarding the rule set.

setCategory

setCategory overloads

setCategoryThresholdsToCurrentDefaults

Set the specified category's thresholds to the current default values.

setCategoryThresholdsToFactoryDefaults

Set the specified category's thresholds to the factory default values.

setDefaultThresholdLevels

Set the default threshold levels.

setDefaultThresholdLevelsCallback

Set or clear the default‐thresholds callback.

setMaxNumCategories

Set the capacity of this category registry.

setThresholdLevels

Set or create the named category with the specified threshold levels.

setThresholdLevelsHierarchically

Set threshold levels for all categories matching a name prefix.

thresholdLevelsForNewCategory

Load the threshold levels that would apply to a newly created category.

visitCategories

visitCategories overloads

Created with MrDocs