PreCache NetInjector Documentation Center : PreCache NetInjector API Reference

C++ Classes

C++ Classes

Class Hierarchy

AndFilter

Archive

ChannelInfo

CompoundFilter

CtrlNotification

Exception classes

Filter

FilterFactory

Notification

OrFilter

Proxy

Serializable

SimpleFilter

Subscriber

SubscriptionHandle

CompoundFilter

— an abstract class for aggregating filters

CompoundFilter is used to aggregate filters into a single object. CompoundFilter serves as a base class for AndFilter and OrFilter objects.

Hierarchy

precache::util:: Serializable

      --> precache::event:: Filter

            --> precache::event::CompoundFilter

subclasses —

AndFilter, OrFilter

Constructors

CompoundFilter(ChannelInfo)

CompoundFilter(
const ChannelInfo& rkChannelInfo)

Constructs a CompoundFilter object and associates it with a ChannelInfo object, providing access to a channel's attributes and validation against the associated channel's configuration.

rkChannelInfo —

the ChannelInfo object associated with the filter

CompoundFilter(CompoundFilter)

CompoundFilter(
const CompoundFilter& rkCompoundFilter)

Constructs a copy of a CompoundFilter object by performing a deep copy of the Filter tree.

rkCompoundFilter —

the CompoundFilter to be copied

Destructor

~CompoundFilter()

Frees up resources that were allocated for this object.

Methods

Add

void Add(Filter* pFilter) throw( InvalidFilterException)

Adds a subfilter to this object.

pFilter —

a Filter object containing the added subfilter

throws —

Add throws an InvalidFilterException if the subfilter has already been added.

Remove

void Remove(Filter* pFilter) throw( InvalidFilterException)

Removes a subfilter from the object.

pFilter —

a Filter object subfilter to be removed

Reset

void Reset()
throw( InvalidFilterException)

Removes all existing subfilters for the object.

SubFilters

rgpFilters_t& SubFilters

returns —

SubFilters returns a vector object storing the constituent filters in the order in which they were added.

ToString

virtual const PC_CHAR* ToString()

Returns the filter object as a string representation.