<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;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.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 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="navpath"><a class="el" href="namespace_atlas.html">Atlas</a>::<a class="el" href="class_atlas_1_1_filter.html">Filter</a>
</div>
</div>
<div class="contents">
<h1>Atlas::Filter Class Reference</h1><!-- doxytag: class="Atlas::Filter" --><a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream filter.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="_filter_8h_source.html">Filter.h</a>></code>
<p>
Inherited by Atlas::Filters::Bzip2, and Atlas::Filters::Gzip.
<p>
<p>
<a href="class_atlas_1_1_filter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap 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"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="82196c59dc1be6813033d8ffd875bbe3"></a><!-- doxytag: member="Atlas::Filter::Filter" ref="82196c59dc1be6813033d8ffd875bbe3" 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" nowrap align="right" valign="top"><a class="anchor" name="4e6bda6c59f1924d20c2da6919b48b2b"></a><!-- doxytag: member="Atlas::Filter::begin" ref="4e6bda6c59f1924d20c2da6919b48b2b" args="()=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>begin</b> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cbb969d7bfab27272b22f260930e8cc0"></a><!-- doxytag: member="Atlas::Filter::end" ref="cbb969d7bfab27272b22f260930e8cc0" args="()=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>end</b> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ad869a221b7e7ad79fe6d72071633eb"></a><!-- doxytag: member="Atlas::Filter::encode" ref="2ad869a221b7e7ad79fe6d72071633eb" 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" nowrap align="right" valign="top"><a class="anchor" name="309e36dc3ca72165906d984712eb1d0b"></a><!-- doxytag: member="Atlas::Filter::decode" ref="309e36dc3ca72165906d984712eb1d0b" 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"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3afbc23e7daacbe1401f7ef33faf74a4"></a><!-- doxytag: member="Atlas::Filter::m_next" ref="3afbc23e7daacbe1401f7ef33faf74a4" 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"></a><h2>Detailed Description</h2>
<a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream filter.
<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" compact><dt><b>See also:</b></dt><dd><a class="el" href="class_atlas_1_1_codec.html" title="Atlas stream codec.">Codec</a> <p>
<a class="el" href="class_atlas_1_1_negotiate.html" title="Negotiation of codecs and filters for an Atlas connection.">Negotiate</a> </dd></dl>
<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></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>
