Siena Fast Forwarding Documentation (v. 2.0.1)
Classes | Public Member Functions | List of all members
siena::Filter Class Referenceabstract

interface of a generic filter in the attribute-based data model. More...

#include <attributes.h>

Inheritance diagram for siena::Filter:
Inheritance graph
[legend]

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. More...
 
virtual bool covers (const Message &m) const
 applies this filter to a message. More...
 

Detailed Description

interface of a generic filter in the attribute-based 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.

Examples:
simple_attributes_types.h.

Member Function Documentation

virtual bool siena::Filter::covers ( const Message m) const
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.
Examples:
simple_attributes_types.h.