ball_thresholdaggregate

Detailed Description

Provide an aggregate of the four logging threshold levels.

Outline

• Purpose
• Classes
• Description
  • Usage
    • Example 1: Basic Usage

Purpose

Provide an aggregate of the four logging threshold levels.

Classes

• ball::ThresholdAggregate: aggregate of four logging threshold levels
• ball::ThresholdAggregateUtil: ball::ThresholdAggregate helpers

See also

ball_severity

Description

This component implements a class, ball::ThresholdAggregate, that aggregates four threshold levels: record level, pass-through level, trigger level, and trigger-all level. Each of these levels must in the range [0 .. 255], and represents a threshold which, if exceeded, will invoke a certain action. ball::ThresholdAggregateUtil provides helper methods for packing/unpacking ball::ThresholdAggregate objects to/from integers.

Usage

This section illustrates intended use of this component.

Example 1: Basic Usage

The following code fragment illustrates some of the basic operations on threshold levels provided by ball::ThresholdAggregate.

  ball::ThresholdAggregate levels(192, 160, 128, 96);
  assert(192 == levels.recordLevel());
  assert(160 == levels.passLevel());
  assert(128 == levels.triggerLevel());
  assert( 96 == levels.triggerAllLevel());
 
  levels.setLevels(160, 128, 96, 64);
  assert(160 == levels.recordLevel());
  assert(128 == levels.passLevel());
  assert( 96 == levels.triggerLevel());
  assert( 64 == levels.triggerAllLevel());