Siena Fast Forwarding Documentation (v. 1.9.4)

siena::filter Class Reference

interface of a generic filter in the Siena data model. More...

#include <types.h>

Inheritance diagram for siena::filter:
siena::predicate::iterator

List of all members.

Classes

class  iterator
 interface of a generic filter iterator. More...

Public Member Functions

virtual ~filter ()
 virtual destructor
virtual iteratorfirst () const =0
 returns an iterator over this filter.
virtual bool covers (const message &m) const throw ()
 applies this filter to a message.

Detailed Description

interface of a generic filter in the Siena data model.

A filter is a set of constraint representing a logical conjunction of elementary conditions. Individual constraints can be accessed sequentially through a filter::iterator.


Member Function Documentation

virtual bool siena::filter::covers ( const message m  )  const throw () [virtual]

applies this filter to a message.

This is a naive implementation of the matching function.

Returns:
true iff this filter matches (i.e., covers) the given message.
virtual iterator* siena::filter::first (  )  const [pure virtual]

returns an iterator over this filter.

Returns:
iterator pointing to the first constraint in this filter, or NULL if this filter is empty.

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