<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_1Output.html">Output</a>
</div>
</div>
<div class="contents">
<h1>Test::Output Class Reference</h1><!-- doxytag: class="Test::Output" -->
<p>Test suite output handler.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cpptest-output_8h_source.html">cpptest-output.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Test::Output:</div>
<div class="dynsection">
<div class="center">
<img src="classTest_1_1Output.png" usemap="#Test::Output_map" alt=""/>
<map id="Test::Output_map" name="Test::Output_map">
<area href="classTest_1_1CollectorOutput.html" alt="Test::CollectorOutput" shape="rect" coords="0,56,129,80"/>
<area href="classTest_1_1CompilerOutput.html" alt="Test::CompilerOutput" shape="rect" coords="139,56,268,80"/>
<area href="classTest_1_1TextOutput.html" alt="Test::TextOutput" shape="rect" coords="278,56,407,80"/>
<area href="classTest_1_1HtmlOutput.html" alt="Test::HtmlOutput" shape="rect" coords="0,112,129,136"/>
</map>
</div>
</div>
<p><a href="classTest_1_1Output-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li>virtual <a class="el" href="classTest_1_1Output.html#a838de994609ac3d13b7d7cd389f56090">~Output</a> ()
<li>virtual void <a class="el" href="classTest_1_1Output.html#aa66480875d088befc6c23ecfd1107cc1">initialize</a> (int tests)
<li>virtual void <a class="el" href="classTest_1_1Output.html#aeff8af8326a8c54a38199f76837f860a">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_1Output.html#a7022c32c5a1577b10b93d3942746f17d">suite_start</a> (int tests, const std::string &name)
<li>virtual void <a class="el" href="classTest_1_1Output.html#a6dbf4c0adb2bd4a7364c629179f788a6">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_1Output.html#a52d43b97609febc5abbc6da9aa0abac2">test_start</a> (const std::string &name)
<li>virtual void <a class="el" href="classTest_1_1Output.html#a3796943e3b56373492c957212a21454e">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_1Output.html#a48c31f0baa7627d81939be840c9a7f65">assertment</a> (const <a class="el" href="classTest_1_1Source.html">Source</a> &s)
</ul>
<h2>Protected Member Functions</h2>
<ul>
<li><a class="el" href="classTest_1_1Output.html#acbffb6b160039caafd3e9ac11cace65c">Output</a> ()
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Test suite output handler. </p>
<p>Abstract base class for all suite output handlers. Derive from this class to create real output handlers that creates arbitrary complex output handlers.</p>
<p>All parts of testing is reported (test start/stop, suite start/stop, individual test start/stop, and assertments), thus giving maximum flexibility for derived classes. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a838de994609ac3d13b7d7cd389f56090"></a><!-- doxytag: member="Test::Output::~Output" ref="a838de994609ac3d13b7d7cd389f56090" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Test::Output::~Output </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Empty destructor. </p>
</div>
</div>
<a class="anchor" id="acbffb6b160039caafd3e9ac11cace65c"></a><!-- doxytag: member="Test::Output::Output" ref="acbffb6b160039caafd3e9ac11cace65c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Test::Output::Output </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Empty constructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa66480875d088befc6c23ecfd1107cc1"></a><!-- doxytag: member="Test::Output::initialize" ref="aa66480875d088befc6c23ecfd1107cc1" args="(int tests)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Test::Output::initialize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tests</em></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when testing is started.</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>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="suite_8cpp_source.html#l00085">Test::Suite::run()</a>.</p>
</div>
</div>
<a class="anchor" id="aeff8af8326a8c54a38199f76837f860a"></a><!-- doxytag: member="Test::Output::finished" ref="aeff8af8326a8c54a38199f76837f860a" args="(int tests, const Time &time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Test::Output::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> [inline, 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 in <a class="el" href="classTest_1_1CollectorOutput.html#a758efaaf1e348636cb3877c622d2b5d0">Test::CollectorOutput</a>, and <a class="el" href="classTest_1_1TextOutput.html#ad139154d84e75aaaabed7b718b0ff106">Test::TextOutput</a>.</p>
<p>Referenced by <a class="el" href="suite_8cpp_source.html#l00085">Test::Suite::run()</a>.</p>
</div>
</div>
<a class="anchor" id="a7022c32c5a1577b10b93d3942746f17d"></a><!-- doxytag: member="Test::Output::suite_start" ref="a7022c32c5a1577b10b93d3942746f17d" args="(int tests, const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Test::Output::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> [inline, 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 in <a class="el" href="classTest_1_1CollectorOutput.html#a1d4c1eb5920fa96fb8dc8fe2eb0c336e">Test::CollectorOutput</a>, and <a class="el" href="classTest_1_1TextOutput.html#a0b6479918ee7f0501dfcdfcbc7c9d190">Test::TextOutput</a>.</p>
</div>
</div>
<a class="anchor" id="a6dbf4c0adb2bd4a7364c629179f788a6"></a><!-- doxytag: member="Test::Output::suite_end" ref="a6dbf4c0adb2bd4a7364c629179f788a6" 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::Output::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> [inline, 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 in <a class="el" href="classTest_1_1CollectorOutput.html#a50c041adf1de3e296b50b1611e55a407">Test::CollectorOutput</a>, and <a class="el" href="classTest_1_1TextOutput.html#a84efd3536702a815325590cc8837dbb2">Test::TextOutput</a>.</p>
</div>
</div>
<a class="anchor" id="a52d43b97609febc5abbc6da9aa0abac2"></a><!-- doxytag: member="Test::Output::test_start" ref="a52d43b97609febc5abbc6da9aa0abac2" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Test::Output::test_start </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when a tests is executed.</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>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classTest_1_1CollectorOutput.html#a0ac72b71fac68305ceabb1c516760eb0">Test::CollectorOutput</a>.</p>
</div>
</div>
<a class="anchor" id="a3796943e3b56373492c957212a21454e"></a><!-- doxytag: member="Test::Output::test_end" ref="a3796943e3b56373492c957212a21454e" 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::Output::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> [inline, 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 in <a class="el" href="classTest_1_1CollectorOutput.html#a08aa350c9a0ce221d03f6841a0b5d633">Test::CollectorOutput</a>, and <a class="el" href="classTest_1_1TextOutput.html#a0ff333537e85d680740c72dd46cd2e7e">Test::TextOutput</a>.</p>
</div>
</div>
<a class="anchor" id="a48c31f0baa7627d81939be840c9a7f65"></a><!-- doxytag: member="Test::Output::assertment" ref="a48c31f0baa7627d81939be840c9a7f65" args="(const Source &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Test::Output::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> [inline, 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 in <a class="el" href="classTest_1_1CollectorOutput.html#a201ecd71ad6e443b0be2e987d2dc3b39">Test::CollectorOutput</a>, <a class="el" href="classTest_1_1CompilerOutput.html#ae276b6874eb54c8b1e3d8e3c610522dc">Test::CompilerOutput</a>, and <a class="el" href="classTest_1_1TextOutput.html#a9acf66ddd0a5f584a86e5fbdd98e5f1a">Test::TextOutput</a>.</p>
<p>Referenced by <a class="el" href="suite_8cpp_source.html#l00152">Test::Suite::assertment()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cpptest-output_8h_source.html">cpptest-output.h</a></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>
