<html>
<head>
<title>CppTest - A C++ Unit Testing Framework</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
</head>
<body bgcolor="#ffffff">
<table width="100%">
<tr>
<td width="40%" align="right" valign="center">
<a href="http://cpptest.sourceforge.net">CppTest home page</a>
</td>
<td></td>
<td width="40%" align="left" valign="center">
<a href="http://sourceforge.net/projects/cpptest">CppTest project page</a>
</td>
</tr>
</table>
<hr>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<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="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="namespaceTest.html">Test</a>::<a class="el" href="classTest_1_1TextOutput.html">TextOutput</a>
</div>
</div>
<div class="contents">
<h1>Test::TextOutput Class Reference</h1><!-- doxytag: class="Test::TextOutput" --><!-- doxytag: inherits="Test::Output" -->
<p>Text output handler that outputs to the a stream.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cpptest-textoutput_8h_source.html">cpptest-textoutput.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Test::TextOutput:</div>
<div class="dynsection">
<div class="center">
<img src="classTest_1_1TextOutput.png" usemap="#Test::TextOutput_map" alt=""/>
<map id="Test::TextOutput_map" name="Test::TextOutput_map">
<area href="classTest_1_1Output.html" alt="Test::Output" shape="rect" coords="0,0,101,24"/>
</map>
</div>
</div>
<p><a href="classTest_1_1TextOutput-members.html">List of all members.</a></p>
<h2>Public Types</h2>
<ul>
<li>enum <a class="el" href="classTest_1_1TextOutput.html#ae7b22c9458e6c566996bf4517c73feb1">Mode</a> { <a class="el" href="classTest_1_1TextOutput.html#ae7b22c9458e6c566996bf4517c73feb1ae63930203459836dfc6e0939f92a9fb2">Terse</a>,
<a class="el" href="classTest_1_1TextOutput.html#ae7b22c9458e6c566996bf4517c73feb1a85dd6e42f6261a23fd504201f5cc2792">Verbose</a>
}
</ul>
<h2>Public Member Functions</h2>
<ul>
<li><a class="anchor" id="ab9bdd9b2d9b362ca5fb148b766ecdd02"></a><!-- doxytag: member="Test::TextOutput::TextOutput" ref="ab9bdd9b2d9b362ca5fb148b766ecdd02" args="(Mode mode, std::ostream &stream=std::cout)" -->
<b>TextOutput</b> (<a class="el" href="classTest_1_1TextOutput.html#ae7b22c9458e6c566996bf4517c73feb1">Mode</a> mode, std::ostream &stream=std::cout)
<li>virtual void <a class="el" href="classTest_1_1TextOutput.html#ad139154d84e75aaaabed7b718b0ff106">finished</a> (int tests, const <a class="el" href="classTest_1_1Time.html">Time</a> &time)
<li>virtual void <a class="el" href="classTest_1_1TextOutput.html#a0b6479918ee7f0501dfcdfcbc7c9d190">suite_start</a> (int tests, const std::string &name)
<li>virtual void <a class="el" href="classTest_1_1TextOutput.html#a84efd3536702a815325590cc8837dbb2">suite_end</a> (int tests, const std::string &name, const <a class="el" href="classTest_1_1Time.html">Time</a> &time)
<li>virtual void <a class="el" href="classTest_1_1TextOutput.html#a0ff333537e85d680740c72dd46cd2e7e">test_end</a> (const std::string &name, bool ok, const <a class="el" href="classTest_1_1Time.html">Time</a> &time)
<li>virtual void <a class="el" href="classTest_1_1TextOutput.html#a9acf66ddd0a5f584a86e5fbdd98e5f1a">assertment</a> (const <a class="el" href="classTest_1_1Source.html">Source</a> &s)
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Text output handler that outputs to the a stream. </p>
<p>Test suite output handler that writes its information as text to a a stream. It it possible to select between two different operational modes that controls the detail level, see Mode. </p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ae7b22c9458e6c566996bf4517c73feb1"></a><!-- doxytag: member="Test::TextOutput::Mode" ref="ae7b22c9458e6c566996bf4517c73feb1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTest_1_1TextOutput.html#ae7b22c9458e6c566996bf4517c73feb1">Test::TextOutput::Mode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classTest_1_1Output.html" title="Test suite output handler.">Output</a> mode. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ae7b22c9458e6c566996bf4517c73feb1ae63930203459836dfc6e0939f92a9fb2"></a><!-- doxytag: member="Terse" ref="ae7b22c9458e6c566996bf4517c73feb1ae63930203459836dfc6e0939f92a9fb2" args="" -->Terse</em> </td><td>
<p>Terse output mode, which only shows the number of correct tests. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae7b22c9458e6c566996bf4517c73feb1a85dd6e42f6261a23fd504201f5cc2792"></a><!-- doxytag: member="Verbose" ref="ae7b22c9458e6c566996bf4517c73feb1a85dd6e42f6261a23fd504201f5cc2792" args="" -->Verbose</em> </td><td>
<p>Verbose output mode, which also shows extended assert information for each test that failed. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad139154d84e75aaaabed7b718b0ff106"></a><!-- doxytag: member="Test::TextOutput::finished" ref="ad139154d84e75aaaabed7b718b0ff106" args="(int tests, const Time &time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Test::TextOutput::finished </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tests</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTest_1_1Time.html">Time</a> & </td>
<td class="paramname"> <em>time</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when testing is finished.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tests</em> </td><td>Total number of tests in all suites. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td>Total elapsed time for all tests. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classTest_1_1Output.html#aeff8af8326a8c54a38199f76837f860a">Test::Output</a>.</p>
</div>
</div>
<a class="anchor" id="a0b6479918ee7f0501dfcdfcbc7c9d190"></a><!-- doxytag: member="Test::TextOutput::suite_start" ref="a0b6479918ee7f0501dfcdfcbc7c9d190" args="(int tests, const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Test::TextOutput::suite_start </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tests</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when a suite is entered.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tests</em> </td><td>Number of tests in this suite. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the suite. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classTest_1_1Output.html#a7022c32c5a1577b10b93d3942746f17d">Test::Output</a>.</p>
</div>
</div>
<a class="anchor" id="a84efd3536702a815325590cc8837dbb2"></a><!-- doxytag: member="Test::TextOutput::suite_end" ref="a84efd3536702a815325590cc8837dbb2" args="(int tests, const std::string &name, const Time &time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Test::TextOutput::suite_end </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tests</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTest_1_1Time.html">Time</a> & </td>
<td class="paramname"> <em>time</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when a suite is finished.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tests</em> </td><td>Number of tests in this suite. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the suite. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td>Total elapsed time for all tests in this suite. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classTest_1_1Output.html#a6dbf4c0adb2bd4a7364c629179f788a6">Test::Output</a>.</p>
</div>
</div>
<a class="anchor" id="a0ff333537e85d680740c72dd46cd2e7e"></a><!-- doxytag: member="Test::TextOutput::test_end" ref="a0ff333537e85d680740c72dd46cd2e7e" args="(const std::string &name, bool ok, const Time &time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Test::TextOutput::test_end </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>ok</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTest_1_1Time.html">Time</a> & </td>
<td class="paramname"> <em>time</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when a test if finished, regardless if an assertment was issued.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the test function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ok</em> </td><td>True if the test was successful; false otherwise. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>time</em> </td><td>Execution time. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classTest_1_1Output.html#a3796943e3b56373492c957212a21454e">Test::Output</a>.</p>
</div>
</div>
<a class="anchor" id="a9acf66ddd0a5f584a86e5fbdd98e5f1a"></a><!-- doxytag: member="Test::TextOutput::assertment" ref="a9acf66ddd0a5f584a86e5fbdd98e5f1a" args="(const Source &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Test::TextOutput::assertment </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTest_1_1Source.html">Source</a> & </td>
<td class="paramname"> <em>s</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when an assertment is issued.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>Assert point information. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classTest_1_1Output.html#a48c31f0baa7627d81939be840c9a7f65">Test::Output</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="cpptest-textoutput_8h_source.html">cpptest-textoutput.h</a></li>
<li>textoutput.cpp</li>
</ul>
</div>
<hr>
<div align="center">
Supported by:
<br><br>
<img src="http://sourceforge.net/sflogo.php?group_id=77564"
width="88" height="31" border="0" alt="SourceForge Logo"></a>
</div>
</body>
</html>
