PDG_Filter Class Reference

#include <PDG_Filter.h>

Public Types
enum	Type { eSingle, eRange, eSet, eInvalid }
	Storage method the filter uses to keep track of ids. More...

Public Member Functions
	PDG_Filter ()
	Constructs a new filter, which is all by default. More...
	PDG_Filter (bool is_strict)
bool	isAll () const
	Returns true if the filter is set to cook all static items. More...
bool	apply (PDG_WorkItemID id) const
void	setNone ()
	Configures the filter to cook nothing. More...
void	setAll ()
	Configures the filter so that it specifies all static items. More...
void	setSingle (PDG_WorkItemID single)
	Configures the filter to cook a single static item. More...
void	setRange (PDG_WorkItemID start, PDG_WorkItemID end)
	Configures the filter to cook an inclusive range of work items. More...
void	setSet (const PDG_WorkItemIDSet &set)
	Configures the filter to cook a set of items. More...
void	appendToSet (PDG_WorkItemID id)
	Appends an id to the set of static items to cook. More...
void	eraseFromSet (PDG_WorkItemID id)
Type	type () const
	Returns the filter cook type. More...
const PDG_WorkItemIDSet &	set () const
	Returns the filter id set. More...
bool	strict () const
	Returns true if the filter is strict. More...

Detailed Description

An item id filter that describes what static item ids to cook. The filter is either a single id, a range of ids or a set of ids.

Definition at line 19 of file PDG_Filter.h.

Member Enumeration Documentation

enum PDG_Filter::Type

Storage method the filter uses to keep track of ids.

Enumerator
eSingle
eRange	A single item id.
eSet	An inclusive range of item ids.
eInvalid	A set of aribitrary ids, possibly disjoint.

Definition at line 23 of file PDG_Filter.h.

Constructor & Destructor Documentation

PDG_Filter::PDG_Filter ( )

inline

Constructs a new filter, which is all by default.

Definition at line 33 of file PDG_Filter.h.

PDG_Filter::PDG_Filter ( bool  is_strict )

inline

Constructs a filter with a specific value for the Strict flag. A Strict filter will cook exactly the desired static item set, not the set + other dependencies

Definition at line 42 of file PDG_Filter.h.

Member Function Documentation

void PDG_Filter::appendToSet ( PDG_WorkItemID  id )

inline

Appends an id to the set of static items to cook.

Definition at line 107 of file PDG_Filter.h.

bool PDG_Filter::apply ( PDG_WorkItemID  id ) const

inline

Returns true if the given id matches that ones that this filter wishes to cook

Definition at line 56 of file PDG_Filter.h.

void PDG_Filter::eraseFromSet ( PDG_WorkItemID  id )

inline

Definition at line 116 of file PDG_Filter.h.

bool PDG_Filter::isAll ( ) const

inline

Returns true if the filter is set to cook all static items.

Definition at line 49 of file PDG_Filter.h.

const PDG_WorkItemIDSet& PDG_Filter::set ( ) const

inline

Returns the filter id set.

Definition at line 125 of file PDG_Filter.h.

void PDG_Filter::setAll ( )

inline

Configures the filter so that it specifies all static items.

Definition at line 74 of file PDG_Filter.h.

void PDG_Filter::setNone ( )

inline

Configures the filter to cook nothing.

Definition at line 67 of file PDG_Filter.h.

void PDG_Filter::setRange ( PDG_WorkItemID  start, PDG_WorkItemID  end  )

inline

Configures the filter to cook an inclusive range of work items.

Definition at line 90 of file PDG_Filter.h.

void PDG_Filter::setSet ( const PDG_WorkItemIDSet &  set )

inline

Configures the filter to cook a set of items.

Definition at line 100 of file PDG_Filter.h.

void PDG_Filter::setSingle ( PDG_WorkItemID  single )

inline

Configures the filter to cook a single static item.

Definition at line 81 of file PDG_Filter.h.

bool PDG_Filter::strict ( ) const

inline

Returns true if the filter is strict.

Definition at line 128 of file PDG_Filter.h.

Type PDG_Filter::type ( ) const

inline

Returns the filter cook type.

Definition at line 122 of file PDG_Filter.h.

---

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

• PDG/PDG_Filter.h