summaryrefslogtreecommitdiff
path: root/docs/html/data_tests_8cpp.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/html/data_tests_8cpp.html')
-rw-r--r--docs/html/data_tests_8cpp.html305
1 files changed, 305 insertions, 0 deletions
diff --git a/docs/html/data_tests_8cpp.html b/docs/html/data_tests_8cpp.html
new file mode 100644
index 0000000..2aba791
--- /dev/null
+++ b/docs/html/data_tests_8cpp.html
@@ -0,0 +1,305 @@
+<!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>Rally X: tests/dataTests.cpp File Reference</title>
+
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+ $(document).ready(function() { searchBox.OnSelectItem(0); });
+</script>
+
+</head>
+<body>
+<div id="top"><!-- do not remove this div! -->
+
+
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+
+ <td id="projectlogo"><img alt="Logo" src="car.PNG"/></td>
+
+
+ <td style="padding-left: 0.5em;">
+ <div id="projectname">Rally X
+
+ </div>
+ <div id="projectbrief">ELEN3009 Project by Justin Wernick and David Schneider</div>
+ </td>
+
+
+
+ </tr>
+ </tbody>
+</table>
+</div>
+
+<!-- Generated by Doxygen 1.7.5.1 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+ <li><a href="annotated.html"><span>Classes</span></a></li>
+ <li class="current"><a href="files.html"><span>Files</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <div id="navrow2" class="tabs2">
+ <ul class="tablist">
+ <li><a href="files.html"><span>File&#160;List</span></a></li>
+ <li><a href="globals.html"><span>File&#160;Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="header">
+ <div class="summary">
+<a href="#func-members">Functions</a> </div>
+ <div class="headertitle">
+<div class="title">tests/dataTests.cpp File Reference</div> </div>
+</div>
+<div class="contents">
+
+<p>Unit tests for the data layer of a Rally-X game.
+<a href="#details">More...</a></p>
+<div class="textblock"><code>#include &lt;cstdio&gt;</code><br/>
+<code>#include &lt;fstream&gt;</code><br/>
+<code>#include &lt;gtest/gtest.h&gt;</code><br/>
+<code>#include &quot;../source/data/Config.h&quot;</code><br/>
+<code>#include &quot;../source/data/LevelReader.h&quot;</code><br/>
+<code>#include &quot;../source/logic/PlayerCar.h&quot;</code><br/>
+<code>#include &quot;../source/logic/EnemyCar.h&quot;</code><br/>
+<code>#include &quot;../source/logic/Checkpoint.h&quot;</code><br/>
+<code>#include &quot;../source/logic/Rock.h&quot;</code><br/>
+<code>#include &quot;../source/logic/Smokescreen.h&quot;</code><br/>
+<code>#include &quot;../source/logic/Maze.h&quot;</code><br/>
+</div>
+<p><a href="data_tests_8cpp_source.html">Go to the source code of this file.</a></p>
+<table class="memberdecls">
+<tr><td colspan="2"><h2><a name="func-members"></a>
+Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="data_tests_8cpp.html#a7612e068db66f415f3b230260450eba8">TEST</a> (<a class="el" href="class_config.html">Config</a>, readsSettingsCorrectly)</td></tr>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests that a normal complete config file can be read. <a href="#a7612e068db66f415f3b230260450eba8"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="data_tests_8cpp.html#a2159abeac0546de95bbdd68b1e10c56c">TEST</a> (<a class="el" href="class_config.html">Config</a>, createsFileIfNeeded)</td></tr>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests that, if the config file does not exist, it is created with default values. <a href="#a2159abeac0546de95bbdd68b1e10c56c"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="data_tests_8cpp.html#a49403434f62b3318444eff742d2b2231">TEST</a> (<a class="el" href="class_config.html">Config</a>, incompleteFileFilled)</td></tr>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests that an incomplete config file is loaded, with defaults for the missing values. <a href="#a49403434f62b3318444eff742d2b2231"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="data_tests_8cpp.html#afc4fdfbf4ea1ef87d266b9b67cc665d1">TEST</a> (<a class="el" href="class_level_reader.html">LevelReader</a>, readsFileInfoObjects)</td></tr>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests that a level can be loaded correctly from a file. <a href="#afc4fdfbf4ea1ef87d266b9b67cc665d1"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="data_tests_8cpp.html#a63083af852f9dfa8036f327f6fa84328">TEST</a> (<a class="el" href="class_level_reader.html">LevelReader</a>, throwsExceptionOnBadFilename)</td></tr>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests that an exception is throws if the selected file does not exist. <a href="#a63083af852f9dfa8036f327f6fa84328"></a><br/></td></tr>
+</table>
+<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
+<div class="textblock"><p>Unit tests for the data layer of a Rally-X game. </p>
+<p>The functionality of each class in the data layer was tested.</p>
+<p>The <a class="el" href="class_config.html" title="Object for handling user settings loaded from a file.">Config</a> class was tested in terms of its ability to read an existing config file, as well as its ability to create a new file with default values, or fill missing parameters with default values.</p>
+<p>The <a class="el" href="class_level_reader.html" title="Reads the game objects from a text file and calls relevant constructors.">LevelReader</a> class was tested in the normal case, where a correct level file is given, and in the case where a file that does not exist is given.</p>
+<dl class="author"><dt><b>Author:</b></dt><dd>Justin Wernick </dd>
+<dd>
+David Schneider </dd></dl>
+
+<p>Definition in file <a class="el" href="data_tests_8cpp_source.html">dataTests.cpp</a>.</p>
+</div><hr/><h2>Function Documentation</h2>
+<a class="anchor" id="a7612e068db66f415f3b230260450eba8"></a><!-- doxytag: member="dataTests.cpp::TEST" ref="a7612e068db66f415f3b230260450eba8" args="(Config, readsSettingsCorrectly)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">TEST </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="class_config.html">Config</a>&#160;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">readsSettingsCorrectly&#160;</td>
+ <td class="paramname">&#160;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Tests that a normal complete config file can be read. </p>
+
+<p>Definition at line <a class="el" href="data_tests_8cpp_source.html#l00035">35</a> of file <a class="el" href="data_tests_8cpp_source.html">dataTests.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a2159abeac0546de95bbdd68b1e10c56c"></a><!-- doxytag: member="dataTests.cpp::TEST" ref="a2159abeac0546de95bbdd68b1e10c56c" args="(Config, createsFileIfNeeded)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">TEST </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="class_config.html">Config</a>&#160;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">createsFileIfNeeded&#160;</td>
+ <td class="paramname">&#160;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Tests that, if the config file does not exist, it is created with default values. </p>
+
+<p>Definition at line <a class="el" href="data_tests_8cpp_source.html#l00058">58</a> of file <a class="el" href="data_tests_8cpp_source.html">dataTests.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a49403434f62b3318444eff742d2b2231"></a><!-- doxytag: member="dataTests.cpp::TEST" ref="a49403434f62b3318444eff742d2b2231" args="(Config, incompleteFileFilled)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">TEST </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="class_config.html">Config</a>&#160;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">incompleteFileFilled&#160;</td>
+ <td class="paramname">&#160;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Tests that an incomplete config file is loaded, with defaults for the missing values. </p>
+
+<p>Definition at line <a class="el" href="data_tests_8cpp_source.html#l00078">78</a> of file <a class="el" href="data_tests_8cpp_source.html">dataTests.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="afc4fdfbf4ea1ef87d266b9b67cc665d1"></a><!-- doxytag: member="dataTests.cpp::TEST" ref="afc4fdfbf4ea1ef87d266b9b67cc665d1" args="(LevelReader, readsFileInfoObjects)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">TEST </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="class_level_reader.html">LevelReader</a>&#160;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">readsFileInfoObjects&#160;</td>
+ <td class="paramname">&#160;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Tests that a level can be loaded correctly from a file. </p>
+
+<p>Definition at line <a class="el" href="data_tests_8cpp_source.html#l00099">99</a> of file <a class="el" href="data_tests_8cpp_source.html">dataTests.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a63083af852f9dfa8036f327f6fa84328"></a><!-- doxytag: member="dataTests.cpp::TEST" ref="a63083af852f9dfa8036f327f6fa84328" args="(LevelReader, throwsExceptionOnBadFilename)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">TEST </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="class_level_reader.html">LevelReader</a>&#160;</td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">throwsExceptionOnBadFilename&#160;</td>
+ <td class="paramname">&#160;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+
+<p>Tests that an exception is throws if the selected file does not exist. </p>
+
+<p>Definition at line <a class="el" href="data_tests_8cpp_source.html#l00174">174</a> of file <a class="el" href="data_tests_8cpp_source.html">dataTests.cpp</a>.</p>
+
+</div>
+</div>
+</div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+
+
+<hr class="footer"/><address class="footer"><small>
+Generated on Wed Oct 5 2011 20:08:31 for Rally X by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.7.5.1
+</small></address>
+
+</body>
+</html>