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

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

#include <types.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 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.

Examples:
simple_types.cc.

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.