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

This class implements an aggregate of the four logging threshold levels.

== Synopsis

Declared in `<ball_thresholdaggregate.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/ThresholdAggregate/2constructor-06.adoc[`ThresholdAggregate`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/ball/ThresholdAggregate/operator_assign.adoc[`operator=`] 
| Assign the value of the specified `rhs` threshold aggregate to this aggregate, and return a reference to this modifiable aggregate.
| xref:BloombergLP/ball/ThresholdAggregate/passLevel.adoc[`passLevel`] 
| Return the pass level of this threshold aggregate.
| xref:BloombergLP/ball/ThresholdAggregate/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.
| xref:BloombergLP/ball/ThresholdAggregate/recordLevel.adoc[`recordLevel`] 
| Return the record level of this threshold aggregate.
| xref:BloombergLP/ball/ThresholdAggregate/setLevels.adoc[`setLevels`] 
| Set the threshold levels of this threshold aggregate 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 aggregate).
| xref:BloombergLP/ball/ThresholdAggregate/setPassLevel.adoc[`setPassLevel`] 
| Set the pass level of this threshold aggregate to the specified `passLevel`.
| xref:BloombergLP/ball/ThresholdAggregate/setRecordLevel.adoc[`setRecordLevel`] 
| Set the record level of this threshold aggregate to the specified `recordLevel`.
| xref:BloombergLP/ball/ThresholdAggregate/setTriggerAllLevel.adoc[`setTriggerAllLevel`] 
| Set the trigger‐all level of this threshold aggregate to the specified `triggerAllLevel`.
| xref:BloombergLP/ball/ThresholdAggregate/setTriggerLevel.adoc[`setTriggerLevel`] 
| Set the trigger level of this threshold aggregate to the specified `triggerLevel`.
| xref:BloombergLP/ball/ThresholdAggregate/triggerAllLevel.adoc[`triggerAllLevel`] 
| Return the trigger‐all level of this threshold aggregate.
| xref:BloombergLP/ball/ThresholdAggregate/triggerLevel.adoc[`triggerLevel`] 
| Return the trigger level of this threshold aggregate.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/ThresholdAggregate/areValidThresholdLevels.adoc[`areValidThresholdLevels`] 
| Return `true` if each of the specified `recordLevel`, `passLevel`, `triggerLevel`, and `triggerAllLevel` threshold values is in the range `[0 .. 255]`, and `false` otherwise.
| xref:BloombergLP/ball/ThresholdAggregate/hash.adoc[`hash`] 
| Return a hash value calculated from the specified threshold `aggregate` using the specified `size` as the number of slots. The hash value is guaranteed to be in the range `[0, size ‐ 1]`. The behavior is undefined unless `0 < size`.
| xref:BloombergLP/ball/ThresholdAggregate/maxLevel-08.adoc[`maxLevel`] 
| `maxLevel` overloads
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/ball/operator_eq-0e.adoc[BloombergLP::ball::operator==]`
| Return `true` if the specified `lhs` and `rhs` threshold aggregates have the same value, and `false` otherwise. Two threshold aggregates have the same value if all four of their respective threshold levels are the same.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/operator_not_eq-0af.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` threshold aggregates do not have the same value, and `false` otherwise. Two threshold aggregates do not have the same value if any of their four respective threshold levels differ.
|===


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