diff options
Completely reworked documentation
1 files changed, 141 insertions, 0 deletions
| -rw-r--r-- | docs/html/Event_8h_source.html | 141 |
diff --git a/docs/html/Event_8h_source.html b/docs/html/Event_8h_source.html new file mode 100644 index 0000000..fd176b2 --- /dev/null +++ b/docs/html/Event_8h_source.html @@ -0,0 +1,141 @@ +<!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/Event.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">Event.h</div></div> +</div><!--header--> +<div class="contents"> +<a href="Event_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_EVENT</span></div> +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define HEADER_MODEL_EVENT</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 "../Generic/Date/Date.h"</span></div> +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "../Generic/String/String.h"</span></div> +<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include "<a class="code" href="Hall_8h.html">Hall.h</a>"</span></div> +<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include "<a class="code" href="Ticket_8h.html">Ticket.h</a>"</span></div> +<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include "<a class="code" href="Reservation_8h.html">Reservation.h</a>"</span></div> +<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include <istream></span></div> +<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include <ostream></span></div> +<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div> +<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classEvent.html"> 19</a></span><span class="keyword">class </span><a class="code hl_class" href="classEvent.html">Event</a> {</div> +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="classHall.html">Hall</a> hall;</div> +<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_class" href="classString.html">String</a> name;</div> +<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_class" href="classDate.html">Date</a> date;</div> +<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_class" href="classOrderedList.html">OrderedList<Ticket></a> tickets;</div> +<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_class" href="classOrderedList.html">OrderedList<Reservation></a> reservations;</div> +<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div> +<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">public</span>:</div> +<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_function" href="classEvent.html#a5a40dd4708297f7031e29b39e039ae10">Event</a>();</div> +<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_function" href="classEvent.html#a5a40dd4708297f7031e29b39e039ae10">Event</a>(<span class="keyword">const</span> <a class="code hl_class" href="classHall.html">Hall</a>& hall, <a class="code hl_class" href="classString.html">String</a> name, <a class="code hl_class" href="classDate.html">Date</a> date);</div> +<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> +<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">const</span> <a class="code hl_class" href="classHall.html">Hall</a>& <a class="code hl_function" href="classEvent.html#ae3023ae2c487f46b3235f67554e58615">get_hall</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> <a class="code hl_class" href="classString.html">String</a>& <a class="code hl_function" href="classEvent.html#a7bf717630c32826689df41e0bb3ecbce">get_name</a>() <span class="keyword">const</span>;</div> +<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">const</span> <a class="code hl_class" href="classDate.html">Date</a>& <a class="code hl_function" href="classEvent.html#a222904d44dfaf3f1f96e2190c5ea4293">get_date</a>() <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="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_class" href="classOrderedList.html">OrderedList<Ticket></a>& <a class="code hl_function" href="classEvent.html#a16a84fced8e02f756232c54c27bb22ad">get_tickets</a>();</div> +<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">const</span> <a class="code hl_class" href="classOrderedList.html">OrderedList<Ticket></a>& <a class="code hl_function" href="classEvent.html#a16a84fced8e02f756232c54c27bb22ad">get_tickets</a>() <span class="keyword">const</span>;</div> +<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="classOrderedList.html">OrderedList<Reservation></a>& <a class="code hl_function" href="classEvent.html#a43c6b2bddd42435eb6c8cd0f15d75c6f">get_reservations</a>();</div> +<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">const</span> <a class="code hl_class" href="classOrderedList.html">OrderedList<Reservation></a>& <a class="code hl_function" href="classEvent.html#a43c6b2bddd42435eb6c8cd0f15d75c6f">get_reservations</a>() <span class="keyword">const</span>;</div> +<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div> +<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classEvent.html#ae58d2ed716836adcdacaeec4dd08c1cf">read</a>(std::istream& istr);</div> +<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classEvent.html#a05a302aa998977c30950987c07f0fbba">write</a>(std::ostream& ostr);</div> +<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classEvent.html#af5c84a902db8f29f8b8737026011f1f6">compare</a>(<span class="keyword">const</span> <a class="code hl_class" href="classEvent.html">Event</a>& other);</div> +<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>};</div> +<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div> +<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>std::istream& <a class="code hl_function" href="Event_8h.html#a31d9c76919809491b346728ec6659b19">operator>></a>(std::istream& istr, <a class="code hl_class" href="classEvent.html">Event</a>& event);</div> +<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keywordtype">void</span> <a class="code hl_function" href="Event_8h.html#ad423797aa9adadabb5651f8955c001bb">configureEventInsertionOp</a>(<span class="keywordtype">unsigned</span> setting);</div> +<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>std::ostream& <a class="code hl_function" href="Event_8h.html#a08eaf45abee385d26c4934afeb9be163">operator<<</a>(std::ostream& ostr, <span class="keyword">const</span> <a class="code hl_class" href="classEvent.html">Event</a>& event);</div> +<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div> +<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#endif</span></div> +<div class="ttc" id="aEvent_8h_html_a08eaf45abee385d26c4934afeb9be163"><div class="ttname"><a href="Event_8h.html#a08eaf45abee385d26c4934afeb9be163">operator<<</a></div><div class="ttdeci">std::ostream & operator<<(std::ostream &ostr, const Event &event)</div><div class="ttdoc">Writes Event to stream with << operator.</div><div class="ttdef"><b>Definition:</b> Event.cpp:130</div></div> +<div class="ttc" id="aEvent_8h_html_a31d9c76919809491b346728ec6659b19"><div class="ttname"><a href="Event_8h.html#a31d9c76919809491b346728ec6659b19">operator>></a></div><div class="ttdeci">std::istream & operator>>(std::istream &istr, Event &event)</div><div class="ttdoc">Reads Event from stream with >> operator.</div><div class="ttdef"><b>Definition:</b> Event.cpp:86</div></div> +<div class="ttc" id="aEvent_8h_html_ad423797aa9adadabb5651f8955c001bb"><div class="ttname"><a href="Event_8h.html#ad423797aa9adadabb5651f8955c001bb">configureEventInsertionOp</a></div><div class="ttdeci">void configureEventInsertionOp(unsigned setting)</div><div class="ttdoc">Configures how Event should be shown, when written to stream with << operator.</div><div class="ttdef"><b>Definition:</b> Event.cpp:120</div></div> +<div class="ttc" id="aHall_8h_html"><div class="ttname"><a href="Hall_8h.html">Hall.h</a></div><div class="ttdoc">Stores the declaration of class Hall.</div></div> +<div class="ttc" id="aReservation_8h_html"><div class="ttname"><a href="Reservation_8h.html">Reservation.h</a></div><div class="ttdoc">Stores the declaration of class Reservation.</div></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="aclassDate_html"><div class="ttname"><a href="classDate.html">Date</a></div><div class="ttdoc">Stores a day, month and year.</div><div class="ttdef"><b>Definition:</b> Date.h:14</div></div> +<div class="ttc" id="aclassEvent_html"><div class="ttname"><a href="classEvent.html">Event</a></div><div class="ttdoc">Stores an event's hall, name, date, bought tickets and reservations.</div><div class="ttdef"><b>Definition:</b> Event.h:19</div></div> +<div class="ttc" id="aclassEvent_html_a05a302aa998977c30950987c07f0fbba"><div class="ttname"><a href="classEvent.html#a05a302aa998977c30950987c07f0fbba">Event::write</a></div><div class="ttdeci">void write(std::ostream &ostr)</div><div class="ttdoc">Writes Event to stream.</div><div class="ttdef"><b>Definition:</b> Event.cpp:64</div></div> +<div class="ttc" id="aclassEvent_html_a16a84fced8e02f756232c54c27bb22ad"><div class="ttname"><a href="classEvent.html#a16a84fced8e02f756232c54c27bb22ad">Event::get_tickets</a></div><div class="ttdeci">OrderedList< Ticket > & get_tickets()</div><div class="ttdoc">Returns reference to bought tickets.</div><div class="ttdef"><b>Definition:</b> Event.cpp:12</div></div> +<div class="ttc" id="aclassEvent_html_a222904d44dfaf3f1f96e2190c5ea4293"><div class="ttname"><a href="classEvent.html#a222904d44dfaf3f1f96e2190c5ea4293">Event::get_date</a></div><div class="ttdeci">const Date & get_date() const</div><div class="ttdoc">Returns constant reference to date on which event will be held.</div><div class="ttdef"><b>Definition:</b> Event.cpp:36</div></div> +<div class="ttc" id="aclassEvent_html_a43c6b2bddd42435eb6c8cd0f15d75c6f"><div class="ttname"><a href="classEvent.html#a43c6b2bddd42435eb6c8cd0f15d75c6f">Event::get_reservations</a></div><div class="ttdeci">OrderedList< Reservation > & get_reservations()</div><div class="ttdoc">Returns reference to reservations.</div><div class="ttdef"><b>Definition:</b> Event.cpp:20</div></div> +<div class="ttc" id="aclassEvent_html_a5a40dd4708297f7031e29b39e039ae10"><div class="ttname"><a href="classEvent.html#a5a40dd4708297f7031e29b39e039ae10">Event::Event</a></div><div class="ttdeci">Event()</div><div class="ttdoc">Calls default constructors on data.</div><div class="ttdef"><b>Definition:</b> Event.cpp:4</div></div> +<div class="ttc" id="aclassEvent_html_a7bf717630c32826689df41e0bb3ecbce"><div class="ttname"><a href="classEvent.html#a7bf717630c32826689df41e0bb3ecbce">Event::get_name</a></div><div class="ttdeci">const String & get_name() const</div><div class="ttdoc">Returns constant reference to name of event.</div><div class="ttdef"><b>Definition:</b> Event.cpp:32</div></div> +<div class="ttc" id="aclassEvent_html_ae3023ae2c487f46b3235f67554e58615"><div class="ttname"><a href="classEvent.html#ae3023ae2c487f46b3235f67554e58615">Event::get_hall</a></div><div class="ttdeci">const Hall & get_hall() const</div><div class="ttdoc">Returns constant reference Hall in which event will be held.</div><div class="ttdef"><b>Definition:</b> Event.cpp:28</div></div> +<div class="ttc" id="aclassEvent_html_ae58d2ed716836adcdacaeec4dd08c1cf"><div class="ttname"><a href="classEvent.html#ae58d2ed716836adcdacaeec4dd08c1cf">Event::read</a></div><div class="ttdeci">void read(std::istream &istr)</div><div class="ttdoc">Reads Event from stream.</div><div class="ttdef"><b>Definition:</b> Event.cpp:48</div></div> +<div class="ttc" id="aclassEvent_html_af5c84a902db8f29f8b8737026011f1f6"><div class="ttname"><a href="classEvent.html#af5c84a902db8f29f8b8737026011f1f6">Event::compare</a></div><div class="ttdeci">int compare(const Event &other)</div><div class="ttdoc">Compares two events.</div><div class="ttdef"><b>Definition:</b> Event.cpp:74</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< Ticket ></a></div></div> +<div class="ttc" id="aclassString_html"><div class="ttname"><a href="classString.html">String</a></div><div class="ttdef"><b>Definition:</b> String.h:11</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> |