diff options
Added files from project 1 (mirror)
1 files changed, 297 insertions, 0 deletions
| -rw-r--r-- | Year 1/Object-oriented Programming/Project 1/docs/html/classReservation.html | 297 |
diff --git a/Year 1/Object-oriented Programming/Project 1/docs/html/classReservation.html b/Year 1/Object-oriented Programming/Project 1/docs/html/classReservation.html new file mode 100644 index 0000000..eff838a --- /dev/null +++ b/Year 1/Object-oriented Programming/Project 1/docs/html/classReservation.html @@ -0,0 +1,297 @@ +<!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: Reservation Class Reference</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><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#friends">Friends</a> | +<a href="classReservation-members.html">List of all members</a> </div> + <div class="headertitle"><div class="title">Reservation Class Reference</div></div> +</div><!--header--> +<div class="contents"> + +<p>Each Reservations contains a ticket, a password and a note. + <a href="classReservation.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="Reservation_8h_source.html">Reservation.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a63b283053695e6f50fa44c50da2b3de5"><td class="memItemLeft" align="right" valign="top"><a id="a63b283053695e6f50fa44c50da2b3de5" name="a63b283053695e6f50fa44c50da2b3de5"></a> + </td><td class="memItemRight" valign="bottom"><b>Reservation</b> ()</td></tr> +<tr class="memdesc:a63b283053695e6f50fa44c50da2b3de5"><td class="mdescLeft"> </td><td class="mdescRight">Sets ticket as default value and leaves password and note blank. <br /></td></tr> +<tr class="separator:a63b283053695e6f50fa44c50da2b3de5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7320a032f87c7d45cf287a146c73695c"><td class="memItemLeft" align="right" valign="top"><a id="a7320a032f87c7d45cf287a146c73695c" name="a7320a032f87c7d45cf287a146c73695c"></a> + </td><td class="memItemRight" valign="bottom"><b>Reservation</b> (const <a class="el" href="classTicket.html">Ticket</a> &ticket)</td></tr> +<tr class="memdesc:a7320a032f87c7d45cf287a146c73695c"><td class="mdescLeft"> </td><td class="mdescRight">Sets ticket and leaves password and note blank. <br /></td></tr> +<tr class="separator:a7320a032f87c7d45cf287a146c73695c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac6fdecd9bc06f3de2e28129ab370f4f7"><td class="memItemLeft" align="right" valign="top"><a id="ac6fdecd9bc06f3de2e28129ab370f4f7" name="ac6fdecd9bc06f3de2e28129ab370f4f7"></a> + </td><td class="memItemRight" valign="bottom"><b>Reservation</b> (const <a class="el" href="classTicket.html">Ticket</a> &ticket, const char *password, const char *note)</td></tr> +<tr class="memdesc:ac6fdecd9bc06f3de2e28129ab370f4f7"><td class="mdescLeft"> </td><td class="mdescRight">Sets ticket, password and note. <br /></td></tr> +<tr class="separator:ac6fdecd9bc06f3de2e28129ab370f4f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af1b95b3d7c46f506dec4d275d6821cdb"><td class="memItemLeft" align="right" valign="top"><a id="af1b95b3d7c46f506dec4d275d6821cdb" name="af1b95b3d7c46f506dec4d275d6821cdb"></a> +const <a class="el" href="classTicket.html">Ticket</a> & </td><td class="memItemRight" valign="bottom"><b>get_ticket</b> () const</td></tr> +<tr class="memdesc:af1b95b3d7c46f506dec4d275d6821cdb"><td class="mdescLeft"> </td><td class="mdescRight">Returns constant reference to ticket. <br /></td></tr> +<tr class="separator:af1b95b3d7c46f506dec4d275d6821cdb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa34cd16a057a4a483e569ec5d7527ad9"><td class="memItemLeft" align="right" valign="top"><a id="aa34cd16a057a4a483e569ec5d7527ad9" name="aa34cd16a057a4a483e569ec5d7527ad9"></a> +const char * </td><td class="memItemRight" valign="bottom"><b>get_password</b> () const</td></tr> +<tr class="memdesc:aa34cd16a057a4a483e569ec5d7527ad9"><td class="mdescLeft"> </td><td class="mdescRight">Returns constant C-style string to password. <br /></td></tr> +<tr class="separator:aa34cd16a057a4a483e569ec5d7527ad9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2285881510bf07f469bf360bb1050f12"><td class="memItemLeft" align="right" valign="top"><a id="a2285881510bf07f469bf360bb1050f12" name="a2285881510bf07f469bf360bb1050f12"></a> +const char * </td><td class="memItemRight" valign="bottom"><b>get_note</b> () const</td></tr> +<tr class="memdesc:a2285881510bf07f469bf360bb1050f12"><td class="mdescLeft"> </td><td class="mdescRight">Returns constant C-style string to note. <br /></td></tr> +<tr class="separator:a2285881510bf07f469bf360bb1050f12"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a03f0d1a522edb2c5fba7538f0c879573"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classReservation.html#a03f0d1a522edb2c5fba7538f0c879573">read</a> (std::istream &istr)</td></tr> +<tr class="memdesc:a03f0d1a522edb2c5fba7538f0c879573"><td class="mdescLeft"> </td><td class="mdescRight">Reads <a class="el" href="classReservation.html" title="Each Reservations contains a ticket, a password and a note.">Reservation</a> from stream. <a href="classReservation.html#a03f0d1a522edb2c5fba7538f0c879573">More...</a><br /></td></tr> +<tr class="separator:a03f0d1a522edb2c5fba7538f0c879573"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1aba46b8e181750bd89fdfca6ff8ba32"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classReservation.html#a1aba46b8e181750bd89fdfca6ff8ba32">write</a> (std::ostream &ostr) const</td></tr> +<tr class="memdesc:a1aba46b8e181750bd89fdfca6ff8ba32"><td class="mdescLeft"> </td><td class="mdescRight">Writes <a class="el" href="classReservation.html" title="Each Reservations contains a ticket, a password and a note.">Reservation</a> to stream. <a href="classReservation.html#a1aba46b8e181750bd89fdfca6ff8ba32">More...</a><br /></td></tr> +<tr class="separator:a1aba46b8e181750bd89fdfca6ff8ba32"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a31cc66beeaf85befe2185dfc88086d38"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classReservation.html#a31cc66beeaf85befe2185dfc88086d38">compare</a> (const <a class="el" href="classReservation.html">Reservation</a> &other) const</td></tr> +<tr class="memdesc:a31cc66beeaf85befe2185dfc88086d38"><td class="mdescLeft"> </td><td class="mdescRight">Compares two Reservations. <a href="classReservation.html#a31cc66beeaf85befe2185dfc88086d38">More...</a><br /></td></tr> +<tr class="separator:a31cc66beeaf85befe2185dfc88086d38"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a> +Friends</h2></td></tr> +<tr class="memitem:a2b7331e532f77bbc67eab217bfeb1f25"><td class="memItemLeft" align="right" valign="top">std::istream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classReservation.html#a2b7331e532f77bbc67eab217bfeb1f25">operator>></a> (std::istream &istr, <a class="el" href="classReservation.html">Reservation</a> &reservation)</td></tr> +<tr class="memdesc:a2b7331e532f77bbc67eab217bfeb1f25"><td class="mdescLeft"> </td><td class="mdescRight">Reads <a class="el" href="classReservation.html" title="Each Reservations contains a ticket, a password and a note.">Reservation</a> from stream with >> operator. <a href="classReservation.html#a2b7331e532f77bbc67eab217bfeb1f25">More...</a><br /></td></tr> +<tr class="separator:a2b7331e532f77bbc67eab217bfeb1f25"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abf734c0a55da55ef89dab1e2f12b8ebd"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classReservation.html#abf734c0a55da55ef89dab1e2f12b8ebd">operator<<</a> (std::ostream &ostr, const <a class="el" href="classReservation.html">Reservation</a> &reservation)</td></tr> +<tr class="memdesc:abf734c0a55da55ef89dab1e2f12b8ebd"><td class="mdescLeft"> </td><td class="mdescRight">Writes <a class="el" href="classReservation.html" title="Each Reservations contains a ticket, a password and a note.">Reservation</a> to stream with << operator. <a href="classReservation.html#abf734c0a55da55ef89dab1e2f12b8ebd">More...</a><br /></td></tr> +<tr class="separator:abf734c0a55da55ef89dab1e2f12b8ebd"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p >Each Reservations contains a ticket, a password and a note. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a31cc66beeaf85befe2185dfc88086d38" name="a31cc66beeaf85befe2185dfc88086d38"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a31cc66beeaf85befe2185dfc88086d38">◆ </a></span>compare()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int Reservation::compare </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classReservation.html">Reservation</a> & </td> + <td class="paramname"><em>other</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Compares two Reservations. </p> +<dl class="section return"><dt>Returns</dt><dd>Compares tickets </dd></dl> + +</div> +</div> +<a id="a03f0d1a522edb2c5fba7538f0c879573" name="a03f0d1a522edb2c5fba7538f0c879573"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a03f0d1a522edb2c5fba7538f0c879573">◆ </a></span>read()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void Reservation::read </td> + <td>(</td> + <td class="paramtype">std::istream & </td> + <td class="paramname"><em>istr</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Reads <a class="el" href="classReservation.html" title="Each Reservations contains a ticket, a password and a note.">Reservation</a> from stream. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">istr</td><td>An input stream</td></tr> + </table> + </dd> +</dl> +<p>Directly reads bytes from stream (calls <a class="el" href="classReservation.html#a03f0d1a522edb2c5fba7538f0c879573" title="Reads Reservation from stream.">read()</a> function). Uses ticket's <a class="el" href="classReservation.html#a03f0d1a522edb2c5fba7538f0c879573" title="Reads Reservation from stream.">read()</a> function.</p> +<dl class="section remark"><dt>Remarks</dt><dd>Doesn't alter the stream in any other way. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Best used with binary ifstream </dd></dl> + +</div> +</div> +<a id="a1aba46b8e181750bd89fdfca6ff8ba32" name="a1aba46b8e181750bd89fdfca6ff8ba32"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1aba46b8e181750bd89fdfca6ff8ba32">◆ </a></span>write()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void Reservation::write </td> + <td>(</td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>ostr</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Writes <a class="el" href="classReservation.html" title="Each Reservations contains a ticket, a password and a note.">Reservation</a> to stream. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">ostr</td><td>An output stream</td></tr> + </table> + </dd> +</dl> +<p>Directly writes bytes to stream (calls <a class="el" href="classReservation.html#a1aba46b8e181750bd89fdfca6ff8ba32" title="Writes Reservation to stream.">write()</a> function). Uses ticket's <a class="el" href="classReservation.html#a1aba46b8e181750bd89fdfca6ff8ba32" title="Writes Reservation to stream.">write()</a> function.</p> +<dl class="section remark"><dt>Remarks</dt><dd>Doesn't alter the stream in any other way. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Best used with binary ofstream </dd></dl> + +</div> +</div> +<h2 class="groupheader">Friends And Related Function Documentation</h2> +<a id="abf734c0a55da55ef89dab1e2f12b8ebd" name="abf734c0a55da55ef89dab1e2f12b8ebd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abf734c0a55da55ef89dab1e2f12b8ebd">◆ </a></span>operator<<</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::ostream & operator<< </td> + <td>(</td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>ostr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classReservation.html">Reservation</a> & </td> + <td class="paramname"><em>reservation</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">friend</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Writes <a class="el" href="classReservation.html" title="Each Reservations contains a ticket, a password and a note.">Reservation</a> to stream with << operator. </p> +<p >Uses the stream's << operator to write the ticket only.</p> +<dl class="section note"><dt>Note</dt><dd>Best used with std::cout or text std::ofstream </dd></dl> + +</div> +</div> +<a id="a2b7331e532f77bbc67eab217bfeb1f25" name="a2b7331e532f77bbc67eab217bfeb1f25"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2b7331e532f77bbc67eab217bfeb1f25">◆ </a></span>operator>></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::istream & operator>> </td> + <td>(</td> + <td class="paramtype">std::istream & </td> + <td class="paramname"><em>istr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classReservation.html">Reservation</a> & </td> + <td class="paramname"><em>reservation</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">friend</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Reads <a class="el" href="classReservation.html" title="Each Reservations contains a ticket, a password and a note.">Reservation</a> from stream with >> operator. </p> +<p >Uses the stream's >> operator to read and parse the ticket. Password and note are left blank.</p> +<dl class="section note"><dt>Note</dt><dd>Best used with std::cin or text std::ifstream </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>src/Models/<a class="el" href="Reservation_8h_source.html">Reservation.h</a></li> +<li>src/Models/Reservation.cpp</li> +</ul> +</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> |