Class: TBoundaryStyleFilter

Declaration: StyleRunIterator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStyleFilter

Inherited By:

None.

Purpose:

TBoundaryStyleFilter, derived from TStyleFilter, filters the results of a primary filter. This filter causes the iterator to return the runs selected by the primary filter and the runs not selected by the primary filter, breaking the runs both between included and excluded runs and anywhere the base filter breaks its selected runs.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is not designed for deriving.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TBoundaryStyleFilter::TBoundaryStyleFilter

TBoundaryStyleFilter (const TStyleFilter & filter)
TBoundaryStyleFilter (const TBoundaryStyleFilter & toCopy)

Interface Category:

API.

Purpose:

Constructs a TBoundaryStyleFilter with the specified primary filter.
Copy constructor.

Calling Context:

Called to construct a TBoundaryStyleFilter with the specified primary filter.
Called to copy an object.

Parameters:

const TStyleFilter & filter -The primary filter for this object.
const TBoundaryStyleFilter & toCopy -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBoundaryStyleFilter::operator=

TBoundaryStyleFilter & operator =(const TBoundaryStyleFilter & toCopy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TBoundaryStyleFilter & toCopy -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBoundaryStyleFilter::~TBoundaryStyleFilter

virtual ~ TBoundaryStyleFilter ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBoundaryStyleFilter::StartChecking

virtual void StartChecking ()

Interface Category:

API.

Purpose:

Initializes the storage for the iterator.

Calling Context:

Called before iteration to initialize the storage for the iterator, and whenever the iterator changes direction.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBoundaryStyleFilter::CheckForFirstRun

virtual FilterAction CheckForFirstRun (const TStyleSet * set)

Interface Category:

API.

Purpose:

Iterates through style runs until a run matching the filter conditions is found.

Calling Context:

Called while it returns excludeAndContinue; that is, until it returns includeAndContinue or includeAndStop. If it is a stop, the iterator stops and returns a single run. Otherwise, it calls CheckForContinuedRun to determine the extent of the range. It must never return excludeAndStop.

Parameters:

const TStyleSet * set -The style set defining the filter.

Return Value:

The FilterAction value specifying the action required by the first located run.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBoundaryStyleFilter::CheckForContinuedRun

virtual FilterAction CheckForContinuedRun (const TStyleSet * set)

Interface Category:

API.

Purpose:

Iterates through additional runs to determine if any need to be concatenated to the first located run.

Calling Context:

Called after a run matching the specified conditions is found; that is, after CheckForFirstRun returns includeAndContinue. This function is then called as long as it returns includeAndContinue.

Parameters:

const TStyleSet * set -The style set defining the filter.

Return Value:

The FilterAction value specifying the action required by the first located run.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBoundaryStyleFilter::StopChecking

virtual void StopChecking ()

Interface Category:

API.

Purpose:

Finalizes and deallocates storage.

Calling Context:

Called before returning from the iterator.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBoundaryStyleFilter::SetFilter

virtual void SetFilter (const TStyleFilter & filter)

Interface Category:

API.

Purpose:

Specifies the primary filter whose results this filter should return.

Calling Context:

Called to reset the primary filter after construction.

Parameters:

const TStyleFilter & filter -The new primary filter.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBoundaryStyleFilter::CreateFilter

virtual TStyleFilter * CreateFilter ()

Interface Category:

API.

Purpose:

Clones the current primary filter and gives you a copy.

Calling Context:

Called to get a copy of the current primary filter.

Parameters:

Takes no parameters.

Return Value:

A copy of the current primary filter.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.