<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_1CollectorOutput.html">CollectorOutput</a> </div> </div> <div class="contents"> <h1>Test::CollectorOutput Class Reference</h1><!-- doxytag: class="Test::CollectorOutput" --><!-- doxytag: inherits="Test::Output" --> <p>Collector output. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="cpptest-collectoroutput_8h_source.html">cpptest-collectoroutput.h</a>></code></p> <div class="dynheader"> Inheritance diagram for Test::CollectorOutput:</div> <div class="dynsection"> <div class="center"> <img src="classTest_1_1CollectorOutput.png" usemap="#Test::CollectorOutput_map" alt=""/> <map id="Test::CollectorOutput_map" name="Test::CollectorOutput_map"> <area href="classTest_1_1Output.html" alt="Test::Output" shape="rect" coords="0,0,129,24"/> <area href="classTest_1_1HtmlOutput.html" alt="Test::HtmlOutput" shape="rect" coords="0,112,129,136"/> </map> </div> </div> <p><a href="classTest_1_1CollectorOutput-members.html">List of all members.</a></p> <h2>Public Member Functions</h2> <ul> <li>virtual void <a class="el" href="classTest_1_1CollectorOutput.html#a758efaaf1e348636cb3877c622d2b5d0">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_1CollectorOutput.html#a1d4c1eb5920fa96fb8dc8fe2eb0c336e">suite_start</a> (int tests, const std::string &name) <li>virtual void <a class="el" href="classTest_1_1CollectorOutput.html#a50c041adf1de3e296b50b1611e55a407">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_1CollectorOutput.html#a0ac72b71fac68305ceabb1c516760eb0">test_start</a> (const std::string &name) <li>virtual void <a class="el" href="classTest_1_1CollectorOutput.html#a08aa350c9a0ce221d03f6841a0b5d633">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_1CollectorOutput.html#a201ecd71ad6e443b0be2e987d2dc3b39">assertment</a> (const <a class="el" href="classTest_1_1Source.html">Source</a> &s) </ul> <h2>Protected Types</h2> <ul> <li><a class="anchor" id="a1921f35e0da596bd75da5824afe872c9"></a><!-- doxytag: member="Test::CollectorOutput::Sources" ref="a1921f35e0da596bd75da5824afe872c9" args="" --> typedef std::list< <a class="el" href="classTest_1_1Source.html">Source</a> > <b>Sources</b> <li><a class="anchor" id="a54a7b7c9b6d181102bc8934190b06e86"></a><!-- doxytag: member="Test::CollectorOutput::Tests" ref="a54a7b7c9b6d181102bc8934190b06e86" args="" --> typedef std::vector< TestInfo > <b>Tests</b> <li><a class="anchor" id="a0879ce3b51f1e3b3fe14aa5665dccd30"></a><!-- doxytag: member="Test::CollectorOutput::Suites" ref="a0879ce3b51f1e3b3fe14aa5665dccd30" args="" --> typedef std::list< SuiteInfo > <b>Suites</b> </ul> <h2>Protected Member Functions</h2> <ul> <li><a class="el" href="classTest_1_1CollectorOutput.html#a852bde8f194b4f81ca36f222257adc53">CollectorOutput</a> () </ul> <h2>Protected Attributes</h2> <ul> <li><a class="anchor" id="a9f79c0fa5abf1d6248a85e7ae4701c5f"></a><!-- doxytag: member="Test::CollectorOutput::_suites" ref="a9f79c0fa5abf1d6248a85e7ae4701c5f" args="" --> Suites <b>_suites</b> <li><a class="anchor" id="a7d8ec4ad0316b57aa96ae50a548c94d2"></a><!-- doxytag: member="Test::CollectorOutput::_total_errors" ref="a7d8ec4ad0316b57aa96ae50a548c94d2" args="" --> int <b>_total_errors</b> <li><a class="anchor" id="ace6c1fc02a6ac7a6c15b982b96f5f68f"></a><!-- doxytag: member="Test::CollectorOutput::_total_tests" ref="ace6c1fc02a6ac7a6c15b982b96f5f68f" args="" --> int <b>_total_tests</b> <li><a class="anchor" id="af1e014fde4bf5b4e6c89de748630aa79"></a><!-- doxytag: member="Test::CollectorOutput::_total_time" ref="af1e014fde4bf5b4e6c89de748630aa79" args="" --> <a class="el" href="classTest_1_1Time.html">Time</a> <b>_total_time</b> </ul> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Collector output. </p> <p>Base class for output handlers that need to report status when all tests have executed. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a852bde8f194b4f81ca36f222257adc53"></a><!-- doxytag: member="Test::CollectorOutput::CollectorOutput" ref="a852bde8f194b4f81ca36f222257adc53" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Test::CollectorOutput::CollectorOutput </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructs a collector object. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a758efaaf1e348636cb3877c622d2b5d0"></a><!-- doxytag: member="Test::CollectorOutput::finished" ref="a758efaaf1e348636cb3877c622d2b5d0" args="(int tests, const Time &time)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Test::CollectorOutput::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="a1d4c1eb5920fa96fb8dc8fe2eb0c336e"></a><!-- doxytag: member="Test::CollectorOutput::suite_start" ref="a1d4c1eb5920fa96fb8dc8fe2eb0c336e" args="(int tests, const std::string &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void Test::CollectorOutput::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="a50c041adf1de3e296b50b1611e55a407"></a><!-- doxytag: member="Test::CollectorOutput::suite_end" ref="a50c041adf1de3e296b50b1611e55a407" 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::CollectorOutput::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="a0ac72b71fac68305ceabb1c516760eb0"></a><!-- doxytag: member="Test::CollectorOutput::test_start" ref="a0ac72b71fac68305ceabb1c516760eb0" args="(const std::string &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void Test::CollectorOutput::test_start </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td><code> [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 from <a class="el" href="classTest_1_1Output.html#a52d43b97609febc5abbc6da9aa0abac2">Test::Output</a>.</p> </div> </div> <a class="anchor" id="a08aa350c9a0ce221d03f6841a0b5d633"></a><!-- doxytag: member="Test::CollectorOutput::test_end" ref="a08aa350c9a0ce221d03f6841a0b5d633" 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::CollectorOutput::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="a201ecd71ad6e443b0be2e987d2dc3b39"></a><!-- doxytag: member="Test::CollectorOutput::assertment" ref="a201ecd71ad6e443b0be2e987d2dc3b39" args="(const Source &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Test::CollectorOutput::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-collectoroutput_8h_source.html">cpptest-collectoroutput.h</a></li> <li>collectoroutput.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>