Siena Fast Forwarding Documentation (v. 1.9.4)

siena::predicate Class Reference

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

#include <types.h>

List of all members.

Classes

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

Public Member Functions

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

Detailed Description

interface of a generic predicate in the Siena data model.

A predicate is a set of filters representing a logical disjunctions of conjunctions of elementary conditions. Individual conjunctions can be accessed sequentially through a predicate::iterator.


Member Function Documentation

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

applies this predicate to a message.

This is a naive implementation of the matching function.

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

returns an iterator over this predicate.

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

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