<box begindoc>**This is automatically generated documentation.**  Edit after the "[[#COMMENTS|COMMENTS]]" heading; changes to the main body will be lost.</box>

====== AggregatePaint Element Documentation ======

===== NAME =====

**AggregatePaint** -- Click element;
sets aggregate annotation based on paint annotation

===== SYNOPSIS =====

AggregatePaint([BITS, //KEYWORDS//])

**Ports**: 1 input, 1 output\\ 
**Processing**: agnostic\\ 
**Drivers**: userlevel\\ 
**Package**: analysis (core)\\ 

===== DESCRIPTION =====

AggregatePaint sets the aggregate annotation on every passing packet to a
portion of that packet's paint annotation.  By default, it is simply set to
the paint annotation; but if you specify a number for BITS, then only the
low-order BITS bits of the annotation are used.
Keyword arguments are:


 ? **INCREMENTAL**
 ! Boolean.  If true, then incrementally update the aggregate annotation: given a
paint annotation with value V, and an old aggregate annotation of O, the new
aggregate annotation will equal (O * 2^LENGTH) + V.  Default is false.


===== SEE ALSO =====

[[AggregateLength]], [[AggregateIPFlows]], [[AggregateCounter]], [[AggregateIP]]


Generated by 'click-elem2man' from '../elements/analysis/aggregatepaint.hh' on 18/Sep/2007.


===== COMMENTS =====