<!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::Formatter 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_formatter.html">Formatter</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">Atlas::Formatter Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atlas::Formatter" --><!-- doxytag: inherits="Atlas::Bridge" -->
<p><a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream formatter.
<a href="class_atlas_1_1_formatter.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_formatter_8h_source.html">Formatter.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Atlas::Formatter:</div>
<div class="dyncontent">
<div class="center">
<img src="class_atlas_1_1_formatter.png" usemap="#Atlas::Formatter_map" alt=""/>
<map id="Atlas::Formatter_map" name="Atlas::Formatter_map">
<area href="class_atlas_1_1_bridge.html" title="Atlas stream bridge." alt="Atlas::Bridge" shape="rect" coords="0,0,100,24"/>
</map>
</div></div>
<p><a href="class_atlas_1_1_formatter-members.html">List of all members.</a></p>
<table class="memberdecls">
<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="a553e80c45de0b44172253b8ba71640fd"></a><!-- doxytag: member="Atlas::Formatter::Formatter" ref="a553e80c45de0b44172253b8ba71640fd" args="(std::iostream &s, Atlas::Bridge &b)" -->
 </td><td class="memItemRight" valign="bottom"><b>Formatter</b> (std::iostream &s, <a class="el" href="class_atlas_1_1_bridge.html">Atlas::Bridge</a> &b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61e4179c54a85af3baf24ab268c9ba9e"></a><!-- doxytag: member="Atlas::Formatter::streamBegin" ref="a61e4179c54a85af3baf24ab268c9ba9e" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#a61e4179c54a85af3baf24ab268c9ba9e">streamBegin</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin an <a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5764a959b5ca6d82e53e44f7ff55bcef"></a><!-- doxytag: member="Atlas::Formatter::streamMessage" ref="a5764a959b5ca6d82e53e44f7ff55bcef" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#a5764a959b5ca6d82e53e44f7ff55bcef">streamMessage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a message in an <a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac34162b66edea0ae629b3e20b1c4df29"></a><!-- doxytag: member="Atlas::Formatter::streamEnd" ref="ac34162b66edea0ae629b3e20b1c4df29" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#ac34162b66edea0ae629b3e20b1c4df29">streamEnd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ends the <a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac187a313d4b4ab05c6c9d7bd6b9b1b87"></a><!-- doxytag: member="Atlas::Formatter::mapMapItem" ref="ac187a313d4b4ab05c6c9d7bd6b9b1b87" args="(const std::string &name)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#ac187a313d4b4ab05c6c9d7bd6b9b1b87">mapMapItem</a> (const std::string &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a map object to the currently streamed map. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4584a7debdb2e30f978817a73838a0df"></a><!-- doxytag: member="Atlas::Formatter::mapListItem" ref="a4584a7debdb2e30f978817a73838a0df" args="(const std::string &name)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#a4584a7debdb2e30f978817a73838a0df">mapListItem</a> (const std::string &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a list object to the currently streamed map. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe3aefcbae1744d36b3183e1caabd3c2"></a><!-- doxytag: member="Atlas::Formatter::mapIntItem" ref="abe3aefcbae1744d36b3183e1caabd3c2" args="(const std::string &name, long)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#abe3aefcbae1744d36b3183e1caabd3c2">mapIntItem</a> (const std::string &name, long)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an integer to the currently streames map. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f134ab4b169f6829a3493bbb4b3ca48"></a><!-- doxytag: member="Atlas::Formatter::mapFloatItem" ref="a8f134ab4b169f6829a3493bbb4b3ca48" args="(const std::string &name, double)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#a8f134ab4b169f6829a3493bbb4b3ca48">mapFloatItem</a> (const std::string &name, double)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a float to the currently streamed map. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a283701ae4083a260f1ff70735c181a30"></a><!-- doxytag: member="Atlas::Formatter::mapStringItem" ref="a283701ae4083a260f1ff70735c181a30" args="(const std::string &name, const std::string &)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#a283701ae4083a260f1ff70735c181a30">mapStringItem</a> (const std::string &name, const std::string &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a string to the currently streamed map. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a641be4ebe790d9e2e50c1bd6b668d4e2"></a><!-- doxytag: member="Atlas::Formatter::mapEnd" ref="a641be4ebe790d9e2e50c1bd6b668d4e2" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#a641be4ebe790d9e2e50c1bd6b668d4e2">mapEnd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ends the currently streamed map. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48468e7f1f67f940f48a9385d13872bf"></a><!-- doxytag: member="Atlas::Formatter::listMapItem" ref="a48468e7f1f67f940f48a9385d13872bf" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#a48468e7f1f67f940f48a9385d13872bf">listMapItem</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a map object in the currently streamed list. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a455646164c1ab065948f7c93df1bef26"></a><!-- doxytag: member="Atlas::Formatter::listListItem" ref="a455646164c1ab065948f7c93df1bef26" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#a455646164c1ab065948f7c93df1bef26">listListItem</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a list object in the currently streamed list. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a494b5cf166b08c5e916ea5b97e8a6b4e"></a><!-- doxytag: member="Atlas::Formatter::listIntItem" ref="a494b5cf166b08c5e916ea5b97e8a6b4e" args="(long)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#a494b5cf166b08c5e916ea5b97e8a6b4e">listIntItem</a> (long)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an integer to the currently streames list. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff0655ae697e4077703dfb3cada7b351"></a><!-- doxytag: member="Atlas::Formatter::listFloatItem" ref="aff0655ae697e4077703dfb3cada7b351" args="(double)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#aff0655ae697e4077703dfb3cada7b351">listFloatItem</a> (double)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a float to the currently streamed list. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a543819fc4150b03b5b3ec29fe0af9fba"></a><!-- doxytag: member="Atlas::Formatter::listStringItem" ref="a543819fc4150b03b5b3ec29fe0af9fba" args="(const std::string &)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#a543819fc4150b03b5b3ec29fe0af9fba">listStringItem</a> (const std::string &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a string to the currently streamed list. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada42325d5149ad0c7c09314f1fb4e9a9"></a><!-- doxytag: member="Atlas::Formatter::listEnd" ref="ada42325d5149ad0c7c09314f1fb4e9a9" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_formatter.html#ada42325d5149ad0c7c09314f1fb4e9a9">listEnd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ends the currently streamed list. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae08390d33ef0af20c14177a19a1c0a65"></a><!-- doxytag: member="Atlas::Formatter::setSpacing" ref="ae08390d33ef0af20c14177a19a1c0a65" args="(int s)" -->
void </td><td class="memItemRight" valign="bottom"><b>setSpacing</b> (int s)</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="a0ec62e1bd2869677b042df7e31507f90"></a><!-- doxytag: member="Atlas::Formatter::m_stream" ref="a0ec62e1bd2869677b042df7e31507f90" args="" -->
std::iostream & </td><td class="memItemRight" valign="bottom"><b>m_stream</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60520d63ce6685495e2a4e29475353f2"></a><!-- doxytag: member="Atlas::Formatter::m_bridge" ref="a60520d63ce6685495e2a4e29475353f2" args="" -->
<a class="el" href="class_atlas_1_1_bridge.html">Bridge</a> & </td><td class="memItemRight" valign="bottom"><b>m_bridge</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44717c252b54945498f09a1db1f6afeb"></a><!-- doxytag: member="Atlas::Formatter::m_indent" ref="a44717c252b54945498f09a1db1f6afeb" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>m_indent</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a09d5c910b8498ecf6b3a2dd22fcfdb"></a><!-- doxytag: member="Atlas::Formatter::m_spacing" ref="a8a09d5c910b8498ecf6b3a2dd22fcfdb" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>m_spacing</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 formatter. </p>
<p>This class implements the <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Bridge</a> interface that accepts an <a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream. It copies the input stream to an output bridge, inserting formatting characters according to settings defined at construction time.</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></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_formatter_8h_source.html">Formatter.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>
