| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
| <title>tbb::filter Class Reference</title> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"> |
| <link href="tabs.css" rel="stylesheet" type="text/css"> |
| </head><body> |
| <!-- Generated by Doxygen 1.4.7 --> |
| <div class="tabs"> |
| <ul> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="modules.html"><span>Modules</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li id="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| </ul></div> |
| <div class="tabs"> |
| <ul> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul></div> |
| <div class="nav"> |
| <a class="el" href="a00267.html">tbb</a>::<a class="el" href="a00165.html">filter</a></div> |
| <h1>tbb::filter Class Reference<br> |
| <small> |
| [<a class="el" href="a00274.html">Algorithms</a>]</small> |
| </h1><!-- doxytag: class="tbb::filter" -->A stage in a pipeline. |
| <a href="#_details">More...</a> |
| <p> |
| <code>#include <<a class="el" href="a00409.html">pipeline.h</a>></code> |
| <p> |
| <p>Inheritance diagram for tbb::filter: |
| <p><center><img src="a00165.png" usemap="#tbb::filter_map" border="0" alt=""></center> |
| <map name="tbb::filter_map"> |
| <area href="a00209.html" alt="tbb::thread_bound_filter" shape="rect" coords="0,56,145,80"> |
| </map> |
| <a href="a00049.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
| <tr><td></td></tr> |
| <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fcfec27656a69ff2072802ac001e936f"></a><!-- doxytag: member="tbb::filter::is_serial" ref="fcfec27656a69ff2072802ac001e936f" args="() const " --> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00165.html#fcfec27656a69ff2072802ac001e936f">is_serial</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">True if filter is serial. <br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd53206c4795ef2df5df26b795caf692"></a><!-- doxytag: member="tbb::filter::is_ordered" ref="cd53206c4795ef2df5df26b795caf692" args="() const " --> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00165.html#cd53206c4795ef2df5df26b795caf692">is_ordered</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">True if filter must receive stream in order. <br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15c29cae5d237e6d63dbfe5c94af89d5"></a><!-- doxytag: member="tbb::filter::is_bound" ref="15c29cae5d237e6d63dbfe5c94af89d5" args="() const " --> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00165.html#15c29cae5d237e6d63dbfe5c94af89d5">is_bound</a> () const </td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">True if filter is thread-bound. <br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00165.html#fa1b3dc1f4f47563ccab7f4d92f5b543">operator()</a> (void *item)=0</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Operate on an item from the input stream, and return item for output stream. <a href="#fa1b3dc1f4f47563ccab7f4d92f5b543"></a><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual __TBB_EXPORTED_METHOD </td><td class="memItemRight" valign="bottom"><a class="el" href="a00165.html#66d159f362293e3964ba3da8bc1d2604">~filter</a> ()</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy filter. <a href="#66d159f362293e3964ba3da8bc1d2604"></a><br></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00165.html#56275eb889c77c4807967133e21401bd">finalize</a> (void *)</td></tr> |
| |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys item if pipeline was cancelled. <a href="#56275eb889c77c4807967133e21401bd"></a><br></td></tr> |
| <tr><td colspan="2"><br><h2>Friends</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8228ce0751009045e8158d2e642715a6"></a><!-- doxytag: member="tbb::filter::internal::stage_task" ref="8228ce0751009045e8158d2e642715a6" args="" --> |
| class </td><td class="memItemRight" valign="bottom"><b>internal::stage_task</b></td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05d67150ca324698ba852553e223d3eb"></a><!-- doxytag: member="tbb::filter::internal::pipeline_root_task" ref="05d67150ca324698ba852553e223d3eb" args="" --> |
| class </td><td class="memItemRight" valign="bottom"><b>internal::pipeline_root_task</b></td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b211ee58bada099e24280d478017cbff"></a><!-- doxytag: member="tbb::filter::pipeline" ref="b211ee58bada099e24280d478017cbff" args="" --> |
| class </td><td class="memItemRight" valign="bottom"><b>pipeline</b></td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e43b69a482df8e053cb199af69eb5139"></a><!-- doxytag: member="tbb::filter::thread_bound_filter" ref="e43b69a482df8e053cb199af69eb5139" args="" --> |
| class </td><td class="memItemRight" valign="bottom"><b>thread_bound_filter</b></td></tr> |
| |
| </table> |
| <hr><a name="_details"></a><h2>Detailed Description</h2> |
| A stage in a pipeline. |
| <p> |
| <hr><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" name="66d159f362293e3964ba3da8bc1d2604"></a><!-- doxytag: member="tbb::filter::~filter" ref="66d159f362293e3964ba3da8bc1d2604" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual __TBB_EXPORTED_METHOD tbb::filter::~filter </td> |
| <td>(</td> |
| <td class="paramname"> </td> |
| <td> ) </td> |
| <td width="100%"><code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| Destroy filter. |
| <p> |
| If the filter was added to a pipeline, the pipeline must be destroyed first. |
| </div> |
| </div><p> |
| <hr><h2>Member Function Documentation</h2> |
| <a class="anchor" name="56275eb889c77c4807967133e21401bd"></a><!-- doxytag: member="tbb::filter::finalize" ref="56275eb889c77c4807967133e21401bd" args="(void *)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void tbb::filter::finalize </td> |
| <td>(</td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"> </td> |
| <td> ) </td> |
| <td width="100%"><code> [inline, virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| Destroys item if pipeline was cancelled. |
| <p> |
| Required to prevent memory leaks. Note it can be called concurrently even for serial filters. |
| </div> |
| </div><p> |
| <a class="anchor" name="fa1b3dc1f4f47563ccab7f4d92f5b543"></a><!-- doxytag: member="tbb::filter::operator()" ref="fa1b3dc1f4f47563ccab7f4d92f5b543" args="(void *item)=0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void* tbb::filter::operator() </td> |
| <td>(</td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"> <em>item</em> </td> |
| <td> ) </td> |
| <td width="100%"><code> [pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p> |
| Operate on an item from the input stream, and return item for output stream. |
| <p> |
| Returns NULL if filter is a sink. |
| </div> |
| </div><p> |
| <hr>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="a00409.html">pipeline.h</a></ul> |
| <hr> |
| <p></p> |
| Copyright © 2005-2010 Intel Corporation. All Rights Reserved. |
| <p></p> |
| 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. |
| <p></p> |
| * Other names and brands may be claimed as the property of others. |
