diff options
Completely reworked documentation
1 files changed, 124 insertions, 0 deletions
| -rw-r--r-- | docs/html/Reservation_8h_source.html | 124 |
diff --git a/docs/html/Reservation_8h_source.html b/docs/html/Reservation_8h_source.html new file mode 100644 index 0000000..52c470a --- /dev/null +++ b/docs/html/Reservation_8h_source.html @@ -0,0 +1,124 @@ +<!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/Models/Reservation.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_36df885461d6bd14211edf06510d126c.html">Models</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"><div class="title">Reservation.h</div></div> +</div><!--header--> +<div class="contents"> +<a href="Reservation_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_MODEL_RESERVATION</span></div> +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define HEADER_MODEL_RESERVATION</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 "<a class="code" href="Ticket_8h.html">Ticket.h</a>"</span></div> +<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <istream></span></div> +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <ostream></span></div> +<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div> +<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#define PASSWORD_LEN 8</span></div> +<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#define NOTE_LEN 32</span></div> +<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div> +<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classReservation.html"> 17</a></span><span class="keyword">class </span><a class="code hl_class" href="classReservation.html">Reservation</a> {</div> +<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_class" href="classTicket.html">Ticket</a> ticket;</div> +<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordtype">char</span> password[PASSWORD_LEN];</div> +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordtype">char</span> note[NOTE_LEN];</div> +<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> +<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">public</span>:</div> +<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_function" href="classReservation.html#a63b283053695e6f50fa44c50da2b3de5">Reservation</a>();</div> +<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_function" href="classReservation.html#a63b283053695e6f50fa44c50da2b3de5">Reservation</a>(<span class="keyword">const</span> <a class="code hl_class" href="classTicket.html">Ticket</a>& ticket);</div> +<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_function" href="classReservation.html#a63b283053695e6f50fa44c50da2b3de5">Reservation</a>(<span class="keyword">const</span> <a class="code hl_class" href="classTicket.html">Ticket</a>& ticket, <span class="keyword">const</span> <span class="keywordtype">char</span>* password, <span class="keyword">const</span> <span class="keywordtype">char</span>* note);</div> +<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> +<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">const</span> <a class="code hl_class" href="classTicket.html">Ticket</a>& <a class="code hl_function" href="classReservation.html#af1b95b3d7c46f506dec4d275d6821cdb">get_ticket</a>() <span class="keyword">const</span>;</div> +<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="classReservation.html#aa34cd16a057a4a483e569ec5d7527ad9">get_password</a>() <span class="keyword">const</span>;</div> +<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="classReservation.html#a2285881510bf07f469bf360bb1050f12">get_note</a>() <span class="keyword">const</span>;</div> +<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div> +<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classReservation.html#a03f0d1a522edb2c5fba7538f0c879573">read</a>(std::istream& istr);</div> +<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classReservation.html#a1aba46b8e181750bd89fdfca6ff8ba32">write</a>(std::ostream& ostr) <span class="keyword">const</span>;</div> +<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classReservation.html#a31cc66beeaf85befe2185dfc88086d38">compare</a>(<span class="keyword">const</span> <a class="code hl_class" href="classReservation.html">Reservation</a>& other) <span class="keyword">const</span>;</div> +<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div> +<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">friend</span> std::istream& <a class="code hl_friend" href="classReservation.html#a2b7331e532f77bbc67eab217bfeb1f25">operator>></a>(std::istream& istr, <a class="code hl_class" href="classReservation.html">Reservation</a>& reservation);</div> +<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">friend</span> std::ostream& <a class="code hl_friend" href="classReservation.html#abf734c0a55da55ef89dab1e2f12b8ebd">operator<<</a>(std::ostream& ostr, <span class="keyword">const</span> <a class="code hl_class" href="classReservation.html">Reservation</a>& reservation);</div> +<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>};</div> +<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div> +<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="preprocessor">#endif</span></div> +<div class="ttc" id="aTicket_8h_html"><div class="ttname"><a href="Ticket_8h.html">Ticket.h</a></div><div class="ttdoc">Stores the declaration of class Ticket.</div></div> +<div class="ttc" id="aclassReservation_html"><div class="ttname"><a href="classReservation.html">Reservation</a></div><div class="ttdoc">Each Reservations contains a ticket, a password and a note.</div><div class="ttdef"><b>Definition:</b> Reservation.h:17</div></div> +<div class="ttc" id="aclassReservation_html_a03f0d1a522edb2c5fba7538f0c879573"><div class="ttname"><a href="classReservation.html#a03f0d1a522edb2c5fba7538f0c879573">Reservation::read</a></div><div class="ttdeci">void read(std::istream &istr)</div><div class="ttdoc">Reads Reservation from stream.</div><div class="ttdef"><b>Definition:</b> Reservation.cpp:34</div></div> +<div class="ttc" id="aclassReservation_html_a1aba46b8e181750bd89fdfca6ff8ba32"><div class="ttname"><a href="classReservation.html#a1aba46b8e181750bd89fdfca6ff8ba32">Reservation::write</a></div><div class="ttdeci">void write(std::ostream &ostr) const</div><div class="ttdoc">Writes Reservation to stream.</div><div class="ttdef"><b>Definition:</b> Reservation.cpp:48</div></div> +<div class="ttc" id="aclassReservation_html_a2285881510bf07f469bf360bb1050f12"><div class="ttname"><a href="classReservation.html#a2285881510bf07f469bf360bb1050f12">Reservation::get_note</a></div><div class="ttdeci">const char * get_note() const</div><div class="ttdoc">Returns constant C-style string to note.</div><div class="ttdef"><b>Definition:</b> Reservation.cpp:22</div></div> +<div class="ttc" id="aclassReservation_html_a2b7331e532f77bbc67eab217bfeb1f25"><div class="ttname"><a href="classReservation.html#a2b7331e532f77bbc67eab217bfeb1f25">Reservation::operator>></a></div><div class="ttdeci">friend std::istream & operator>>(std::istream &istr, Reservation &reservation)</div><div class="ttdoc">Reads Reservation from stream with >> operator.</div><div class="ttdef"><b>Definition:</b> Reservation.cpp:66</div></div> +<div class="ttc" id="aclassReservation_html_a31cc66beeaf85befe2185dfc88086d38"><div class="ttname"><a href="classReservation.html#a31cc66beeaf85befe2185dfc88086d38">Reservation::compare</a></div><div class="ttdeci">int compare(const Reservation &other) const</div><div class="ttdoc">Compares two Reservations.</div><div class="ttdef"><b>Definition:</b> Reservation.cpp:56</div></div> +<div class="ttc" id="aclassReservation_html_a63b283053695e6f50fa44c50da2b3de5"><div class="ttname"><a href="classReservation.html#a63b283053695e6f50fa44c50da2b3de5">Reservation::Reservation</a></div><div class="ttdeci">Reservation()</div><div class="ttdoc">Sets ticket as default value and leaves password and note blank.</div><div class="ttdef"><b>Definition:</b> Reservation.cpp:4</div></div> +<div class="ttc" id="aclassReservation_html_aa34cd16a057a4a483e569ec5d7527ad9"><div class="ttname"><a href="classReservation.html#aa34cd16a057a4a483e569ec5d7527ad9">Reservation::get_password</a></div><div class="ttdeci">const char * get_password() const</div><div class="ttdoc">Returns constant C-style string to password.</div><div class="ttdef"><b>Definition:</b> Reservation.cpp:18</div></div> +<div class="ttc" id="aclassReservation_html_abf734c0a55da55ef89dab1e2f12b8ebd"><div class="ttname"><a href="classReservation.html#abf734c0a55da55ef89dab1e2f12b8ebd">Reservation::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &ostr, const Reservation &reservation)</div><div class="ttdoc">Writes Reservation to stream with << operator.</div><div class="ttdef"><b>Definition:</b> Reservation.cpp:77</div></div> +<div class="ttc" id="aclassReservation_html_af1b95b3d7c46f506dec4d275d6821cdb"><div class="ttname"><a href="classReservation.html#af1b95b3d7c46f506dec4d275d6821cdb">Reservation::get_ticket</a></div><div class="ttdeci">const Ticket & get_ticket() const</div><div class="ttdoc">Returns constant reference to ticket.</div><div class="ttdef"><b>Definition:</b> Reservation.cpp:14</div></div> +<div class="ttc" id="aclassTicket_html"><div class="ttname"><a href="classTicket.html">Ticket</a></div><div class="ttdoc">Each Ticket contains a row and a seat number.</div><div class="ttdef"><b>Definition:</b> Ticket.h:13</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> |