SuperSpaceInvaderTurboApoca.../doc/SAE102-SpaceInvaders/html/dd/d91/config_management_8h_source.html
2022-01-10 18:25:13 +01:00

144 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SUPER Space invader : Turbo edition DX - VS GOD: headers/configManagement.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../LOGO.png"/></td>
<td id="projectalign">
<div id="projectname">SUPER Space invader : Turbo edition DX - VS GOD<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">A simple space invader ripoff</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('dd/d91/config_management_8h_source.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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>
<div class="header">
<div class="headertitle"><div class="title">configManagement.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../dd/d91/config_management_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#ifndef SPACE_CONFIGMANAGEMENT_H</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#define SPACE_CONFIGMANAGEMENT_H</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include&lt;climits&gt;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">/* This header will only be imported once, but Djalim told me he would hurt me</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * if I didn&#39;t move it into his own header file instead of the cpp file*/</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="../../df/d3c/class_config_builder.html"> 20</a></span><span class="keyword">class </span><a class="code hl_class" href="../../df/d3c/class_config_builder.html">ConfigBuilder</a>{</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="../../df/d3c/class_config_builder.html#a4b4df7371d8b2544f302219631f0b77f"> 22</a></span> <a class="code hl_struct" href="../../da/da7/struct_config_data.html">ConfigData</a> <a class="code hl_variable" href="../../df/d3c/class_config_builder.html#a4b4df7371d8b2544f302219631f0b77f">collectedData</a>;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">void</span> <a class="code hl_function" href="../../df/d3c/class_config_builder.html#a408e15906e88336cbc53f19afec65cd6">parseFile</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; fname);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">void</span> <a class="code hl_function" href="../../df/d3c/class_config_builder.html#acd69e5a0777a3c9339aa96e8ce2e07a9">readConfig</a>();</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordtype">void</span> <a class="code hl_function" href="../../df/d3c/class_config_builder.html#aab791290aa2d314788fcd9f2c44bf79e">dumpInternalValues</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> map&lt;string, string&gt; internalValues;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; getString(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; key, <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; def) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; getString(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; key) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">char</span> getChar(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; key, <span class="keywordtype">char</span> def) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">char</span> getChar(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; key) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">int</span> getInt(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; key, <span class="keywordtype">int</span> def, <span class="keywordtype">int</span> min=INT_MIN, <span class="keywordtype">int</span> max=INT_MAX) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">int</span> getInt(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; key) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> getColor(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; key, nsGraphics::RGBAcolor&amp; color, <span class="keyword">const</span> nsGraphics::RGBAcolor&amp; def) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> getColor(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; key, nsGraphics::RGBAcolor&amp; color) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> getList(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; key, vector&lt;string&gt;&amp; vec) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">void</span> readGrid(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; baseKey);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">void</span> readPlayer(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; baseKey, <a class="code hl_struct" href="../../df/dc7/struct_player_def.html">PlayerDef</a>&amp;);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">void</span> readInvaderType(<span class="keyword">const</span> <a class="code hl_typedef" href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a>&amp; baseKey, <a class="code hl_struct" href="../../dd/d86/struct_invader_type_def.html">InvaderTypeDef</a>&amp;);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>};</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_config_builder_html"><div class="ttname"><a href="../../df/d3c/class_config_builder.html">ConfigBuilder</a></div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d91/config_management_8h_source.html#l00020">configManagement.h:20</a></div></div>
<div class="ttc" id="aclass_config_builder_html_a408e15906e88336cbc53f19afec65cd6"><div class="ttname"><a href="../../df/d3c/class_config_builder.html#a408e15906e88336cbc53f19afec65cd6">ConfigBuilder::parseFile</a></div><div class="ttdeci">void parseFile(const string &amp;fname)</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d65/config_management_8cpp_source.html#l00042">configManagement.cpp:42</a></div></div>
<div class="ttc" id="aclass_config_builder_html_a4b4df7371d8b2544f302219631f0b77f"><div class="ttname"><a href="../../df/d3c/class_config_builder.html#a4b4df7371d8b2544f302219631f0b77f">ConfigBuilder::collectedData</a></div><div class="ttdeci">ConfigData collectedData</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d91/config_management_8h_source.html#l00022">configManagement.h:22</a></div></div>
<div class="ttc" id="aclass_config_builder_html_aab791290aa2d314788fcd9f2c44bf79e"><div class="ttname"><a href="../../df/d3c/class_config_builder.html#aab791290aa2d314788fcd9f2c44bf79e">ConfigBuilder::dumpInternalValues</a></div><div class="ttdeci">void dumpInternalValues() const</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d65/config_management_8cpp_source.html#l00033">configManagement.cpp:33</a></div></div>
<div class="ttc" id="aclass_config_builder_html_acd69e5a0777a3c9339aa96e8ce2e07a9"><div class="ttname"><a href="../../df/d3c/class_config_builder.html#acd69e5a0777a3c9339aa96e8ce2e07a9">ConfigBuilder::readConfig</a></div><div class="ttdeci">void readConfig()</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d65/config_management_8cpp_source.html#l00156">configManagement.cpp:156</a></div></div>
<div class="ttc" id="aconfig_data_8h_html_a7ca3f09edce68ced014650c382bb767c"><div class="ttname"><a href="../../db/d70/config_data_8h.html#a7ca3f09edce68ced014650c382bb767c">configKey</a></div><div class="ttdeci">string configKey</div><div class="ttdef"><b>Definition:</b> <a href="../../db/d70/config_data_8h_source.html#l00020">configData.h:20</a></div></div>
<div class="ttc" id="astruct_config_data_html"><div class="ttname"><a href="../../da/da7/struct_config_data.html">ConfigData</a></div><div class="ttdoc">this struct stores all relevant data from the configuration file</div><div class="ttdef"><b>Definition:</b> <a href="../../db/d70/config_data_8h_source.html#l00027">configData.h:27</a></div></div>
<div class="ttc" id="astruct_invader_type_def_html"><div class="ttname"><a href="../../dd/d86/struct_invader_type_def.html">InvaderTypeDef</a></div><div class="ttdoc">defines an invader type</div><div class="ttdef"><b>Definition:</b> <a href="../../db/da9/invader_def_8h_source.html#l00021">invaderDef.h:21</a></div></div>
<div class="ttc" id="astruct_player_def_html"><div class="ttname"><a href="../../df/dc7/struct_player_def.html">PlayerDef</a></div><div class="ttdoc">player data, contains colors and key configuration</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/dd4/player_def_8h_source.html#l00042">playerDef.h:42</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_7f57b1e41c5acd0e859ae5f3a2b075a9.html">headers</a></li><li class="navelem"><a class="el" href="../../dd/d91/config_management_8h.html">configManagement.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
</ul>
</div>
</body>
</html>