# ace::Filter Class Reference

Abstract class declares some basic interface for counting filter rules matches. More...

`#include <filter.h>`

Inherited by ace::MultiRulesFilter, and ace::UniRulesFilter.

List of all members.

## Public Member Functions
virtual | ~Filter (void)
| Class is abstract, so declaring virtual destructor is in good taste.
virtual bool | is_on (void) const =0
Stats | recent_stats (void) const
void | reset_recent_stats (void)
| Resets recent stats counter.
Stats | stats_so_far (void) const
## Protected Attributes
Stats | _stats_so_far
| Overall stats.
Stats | _recent_stats
| Recent stats (resetable).
## Classes
struct | Stats
| Struct for filtration statistics. More...

## Detailed Description

Abstract class declares some basic interface for counting filter rules matches.

## Constructor & Destructor Documentation

virtual ace::Filter::~Filter | ( | void |  | ) | `[inline, virtual]`

Class is abstract, so declaring virtual destructor is in good taste.

## Member Function Documentation

virtual bool ace::Filter::is_on | ( | void |  | ) | const`[pure virtual]`

Returns:
  True, if there are any rules to use.

Implemented in ace::UniRulesFilter, and ace::MultiRulesFilter.

Stats ace::Filter::recent_stats | ( | void |  | ) | const`[inline]`

Returns:
  Recent stats counter.

void ace::Filter::reset_recent_stats | ( | void |  | ) | `[inline]`

Resets recent stats counter.

Stats ace::Filter::stats_so_far | ( | void |  | ) | const`[inline]`

Returns:
  Overall stats counter.

## Member Data Documentation

Stats ace::Filter::_stats_so_far`[protected]`

Overall stats.

Stats ace::Filter::_recent_stats`[protected]`

Recent stats (resetable).

The documentation for this class was generated from the following file:

- proto/Source/filter.h