diff options
Completely reworked documentation
1 files changed, 108 insertions, 0 deletions
| -rw-r--r-- | docs/html/HallService_8h_source.html | 108 |
diff --git a/docs/html/HallService_8h_source.html b/docs/html/HallService_8h_source.html new file mode 100644 index 0000000..d40fb32 --- /dev/null +++ b/docs/html/HallService_8h_source.html @@ -0,0 +1,108 @@ +<!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>FMI Ticket System: src/Services/HallService.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="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="projectalign"> + <div id="projectname">FMI Ticket System + </div> + <div id="projectbrief">| Kamen Mladenov | FMI Computer Science Year 1 Group 6 | Project 1 | Project Topic 4 |</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&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&dn=expat.txt MIT */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */ +</script> +<div id="main-nav"></div> +<!-- 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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_6aea3fadc932e04aa9fe3b3b27672cd7.html">Services</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"><div class="title">HallService.h</div></div> +</div><!--header--> +<div class="contents"> +<a href="HallService_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><span class="preprocessor">#ifndef HEADER_SERVICES_HALLSERVICE</span></div> +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define HEADER_SERVICES_HALLSERVICE</span></div> +<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div> +<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "../Generic/List/OrderedList.hpp"</span></div> +<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "../Models/Hall.h"</span></div> +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "<a class="code" href="StatusCode_8h.html">StatusCode.h</a>"</span></div> +<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div> +<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classHallService.html"> 14</a></span><span class="keyword">class </span><a class="code hl_class" href="classHallService.html">HallService</a> {</div> +<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <a class="code hl_class" href="classOrderedList.html">OrderedList<Hall></a> halls;</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="keyword">public</span>:</div> +<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_function" href="classHallService.html#a57a8117d8d510afb5351a3f7efc18dff">HallService</a>(<span class="keyword">const</span> <a class="code hl_class" href="classHall.html">Hall</a>* halls, <span class="keywordtype">unsigned</span> hallCount);</div> +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div> +<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">const</span> <a class="code hl_class" href="classOrderedList.html">OrderedList<Hall></a>& <a class="code hl_function" href="classHallService.html#a641fdcc475e094687713e94094e2a623">get_halls</a>() <span class="keyword">const</span>;</div> +<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div> +<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_enumeration" href="StatusCode_8h.html#ae98a46f4ea1a43ca48acaf15d2eb7113">StatusCode</a> <a class="code hl_function" href="classHallService.html#ab63c1ccff811ed3268f2fe5e996eb6ae">load</a>();</div> +<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_enumeration" href="StatusCode_8h.html#ae98a46f4ea1a43ca48acaf15d2eb7113">StatusCode</a> <a class="code hl_function" href="classHallService.html#a083e3d10ec89ee8c78a117c3754c66d2">save</a>();</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> </div> +<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#endif</span></div> +<div class="ttc" id="aStatusCode_8h_html"><div class="ttname"><a href="StatusCode_8h.html">StatusCode.h</a></div><div class="ttdoc">Stores declaration of enum StatusCode.</div></div> +<div class="ttc" id="aStatusCode_8h_html_ae98a46f4ea1a43ca48acaf15d2eb7113"><div class="ttname"><a href="StatusCode_8h.html#ae98a46f4ea1a43ca48acaf15d2eb7113">StatusCode</a></div><div class="ttdeci">StatusCode</div><div class="ttdoc">Used for communication between Services and what uses them.</div><div class="ttdef"><b>Definition:</b> StatusCode.h:14</div></div> +<div class="ttc" id="aclassHallService_html"><div class="ttname"><a href="classHallService.html">HallService</a></div><div class="ttdoc">Each HallService stores all halls.</div><div class="ttdef"><b>Definition:</b> HallService.h:14</div></div> +<div class="ttc" id="aclassHallService_html_a083e3d10ec89ee8c78a117c3754c66d2"><div class="ttname"><a href="classHallService.html#a083e3d10ec89ee8c78a117c3754c66d2">HallService::save</a></div><div class="ttdeci">StatusCode save()</div><div class="ttdoc">Saves Halls to a database file.</div><div class="ttdef"><b>Definition:</b> HallService.cpp:34</div></div> +<div class="ttc" id="aclassHallService_html_a57a8117d8d510afb5351a3f7efc18dff"><div class="ttname"><a href="classHallService.html#a57a8117d8d510afb5351a3f7efc18dff">HallService::HallService</a></div><div class="ttdeci">HallService(const Hall *halls, unsigned hallCount)</div><div class="ttdoc">Copies halls from parameters.</div><div class="ttdef"><b>Definition:</b> HallService.cpp:4</div></div> +<div class="ttc" id="aclassHallService_html_a641fdcc475e094687713e94094e2a623"><div class="ttname"><a href="classHallService.html#a641fdcc475e094687713e94094e2a623">HallService::get_halls</a></div><div class="ttdeci">const OrderedList< Hall > & get_halls() const</div><div class="ttdoc">Returns a constant reference to halls.</div><div class="ttdef"><b>Definition:</b> HallService.cpp:8</div></div> +<div class="ttc" id="aclassHallService_html_ab63c1ccff811ed3268f2fe5e996eb6ae"><div class="ttname"><a href="classHallService.html#ab63c1ccff811ed3268f2fe5e996eb6ae">HallService::load</a></div><div class="ttdeci">StatusCode load()</div><div class="ttdoc">Loads Halls to a database file.</div><div class="ttdef"><b>Definition:</b> HallService.cpp:18</div></div> +<div class="ttc" id="aclassHall_html"><div class="ttname"><a href="classHall.html">Hall</a></div><div class="ttdoc">Each hall contains a number, rows and seats per row.</div><div class="ttdef"><b>Definition:</b> Hall.h:13</div></div> +<div class="ttc" id="aclassOrderedList_html"><div class="ttname"><a href="classOrderedList.html">OrderedList< Hall ></a></div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +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 +</small></address> +</body> +</html> |