- Main Page
- Modules
- Namespaces
- Classes
- Files
- Related Pages

- Class List
- Class Hierarchy
- Class Members

# tbb::filter Class Reference
[Algorithms]

A stage in a pipeline. More...

`#include <pipeline.h>`

Inheritance diagram for tbb::filter:

List of all members.

## Public Member Functions
bool | is_serial () const
| True if filter is serial.
bool | is_ordered () const
| True if filter must receive stream in order.
bool | is_bound () const
| True if filter is thread-bound.
virtual void * | operator() (void *item)=0
| Operate on an item from the input stream, and return item for output stream.
virtual __TBB_EXPORTED_METHOD | ~filter ()
| Destroy filter.
virtual void | finalize (void *)
| Destroys item if pipeline was cancelled.
## Friends
class | internal::stage_task
class | internal::pipeline_root_task
class | pipeline
class | thread_bound_filter

## Detailed Description

A stage in a pipeline.

## Constructor & Destructor Documentation

virtual __TBB_EXPORTED_METHOD tbb::filter::~filter | ( |  | ) | `[virtual]`

Destroy filter.

If the filter was added to a pipeline, the pipeline must be destroyed first.

## Member Function Documentation

virtual void tbb::filter::finalize | ( | void * |  | ) | `[inline, virtual]`

Destroys item if pipeline was cancelled.

Required to prevent memory leaks. Note it can be called concurrently even for serial filters.

virtual void* tbb::filter::operator() | ( | void * | item | ) | `[pure virtual]`

Operate on an item from the input stream, and return item for output stream.

Returns NULL if filter is a sink.

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

- pipeline.h

Copyright © 2005-2010 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.