<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Atlas-C++: Atlas::Filter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Atlas-C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_atlas.html">Atlas</a> </li>
<li class="navelem"><a class="el" href="class_atlas_1_1_filter.html">Filter</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">Atlas::Filter Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atlas::Filter" -->
<p><a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream filter.
<a href="class_atlas_1_1_filter.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_filter_8h_source.html">Filter.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Atlas::Filter:</div>
<div class="dyncontent">
<div class="center">
<img src="class_atlas_1_1_filter.png" usemap="#Atlas::Filter_map" alt=""/>
<map id="Atlas::Filter_map" name="Atlas::Filter_map">
<area href="class_atlas_1_1_filters_1_1_bzip2.html" alt="Atlas::Filters::Bzip2" shape="rect" coords="0,56,118,80"/>
<area href="class_atlas_1_1_filters_1_1_gzip.html" alt="Atlas::Filters::Gzip" shape="rect" coords="128,56,246,80"/>
</map>
</div></div>
<p><a href="class_atlas_1_1_filter-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>Type</b> { <b>CHECKSUM</b>,
<b>COMPRESSION</b>,
<b>ENCRYPTION</b>
}</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82196c59dc1be6813033d8ffd875bbe3"></a><!-- doxytag: member="Atlas::Filter::Filter" ref="a82196c59dc1be6813033d8ffd875bbe3" args="(Filter *=0)" -->
 </td><td class="memItemRight" valign="bottom"><b>Filter</b> (<a class="el" href="class_atlas_1_1_filter.html">Filter</a> *=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e6bda6c59f1924d20c2da6919b48b2b"></a><!-- doxytag: member="Atlas::Filter::begin" ref="a4e6bda6c59f1924d20c2da6919b48b2b" args="()=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>begin</b> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbb969d7bfab27272b22f260930e8cc0"></a><!-- doxytag: member="Atlas::Filter::end" ref="acbb969d7bfab27272b22f260930e8cc0" args="()=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>end</b> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ad869a221b7e7ad79fe6d72071633eb"></a><!-- doxytag: member="Atlas::Filter::encode" ref="a2ad869a221b7e7ad79fe6d72071633eb" args="(const std::string &)=0" -->
virtual std::string </td><td class="memItemRight" valign="bottom"><b>encode</b> (const std::string &)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a309e36dc3ca72165906d984712eb1d0b"></a><!-- doxytag: member="Atlas::Filter::decode" ref="a309e36dc3ca72165906d984712eb1d0b" args="(const std::string &)=0" -->
virtual std::string </td><td class="memItemRight" valign="bottom"><b>decode</b> (const std::string &)=0</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3afbc23e7daacbe1401f7ef33faf74a4"></a><!-- doxytag: member="Atlas::Filter::m_next" ref="a3afbc23e7daacbe1401f7ef33faf74a4" args="" -->
<a class="el" href="class_atlas_1_1_filter.html">Filter</a> * </td><td class="memItemRight" valign="bottom"><b>m_next</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream filter. </p>
<p>Filters are used by <a class="el" href="class_atlas_1_1_codec.html" title="Atlas stream codec.">Codec</a> to transform the byte stream before transmission. The transform must be invertible; that is to say, encoding a string and then decoding it must result in the original string. Filters can be used for compression, encryption or performing checksums and other forms of transmission error detection. A compound filter can be created that acts like a single filter, allowing various filters to be chained together in useful ways such as compressing and then encrypting.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_atlas_1_1_codec.html" title="Atlas stream codec.">Codec</a> </dd>
<dd>
<a class="el" href="class_atlas_1_1_negotiate.html" title="Negotiation of codecs and filters for an Atlas connection.">Negotiate</a> </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_filter_8h_source.html">Filter.h</a></li>
</ul>
</div>
<HR>
<P>Copyright 2000-2004 the respective authors.</P>
<P>This document can be licensed under the terms of the GNU Free Documentation
License or the GNU General Public License and may be freely distributed under
the terms given by one of these licenses.</P>
