diff options
Added files from project 1 (mirror)
1 files changed, 371 insertions, 0 deletions
| -rw-r--r-- | Year 1/Object-oriented Programming/Project 1/docs/html/classDate.html | 371 |
diff --git a/Year 1/Object-oriented Programming/Project 1/docs/html/classDate.html b/Year 1/Object-oriented Programming/Project 1/docs/html/classDate.html new file mode 100644 index 0000000..b37fe98 --- /dev/null +++ b/Year 1/Object-oriented Programming/Project 1/docs/html/classDate.html @@ -0,0 +1,371 @@ +<!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: Date 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="classDate-members.html">List of all members</a> </div> + <div class="headertitle"><div class="title">Date Class Reference</div></div> +</div><!--header--> +<div class="contents"> + +<p>Stores a day, month and year. + <a href="classDate.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="Date_8h_source.html">Date.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:a4e59ed4ba66eec61c27460c5d09fa1bd"><td class="memItemLeft" align="right" valign="top"><a id="a4e59ed4ba66eec61c27460c5d09fa1bd" name="a4e59ed4ba66eec61c27460c5d09fa1bd"></a> + </td><td class="memItemRight" valign="bottom"><b>Date</b> ()</td></tr> +<tr class="memdesc:a4e59ed4ba66eec61c27460c5d09fa1bd"><td class="mdescLeft"> </td><td class="mdescRight">Sets date as 01 May 2022. <br /></td></tr> +<tr class="separator:a4e59ed4ba66eec61c27460c5d09fa1bd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a99d57b698afdacd18f5a414cdc7524fd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDate.html#a99d57b698afdacd18f5a414cdc7524fd">Date</a> (const char *str)</td></tr> +<tr class="memdesc:a99d57b698afdacd18f5a414cdc7524fd"><td class="mdescLeft"> </td><td class="mdescRight">Parses string. <a href="classDate.html#a99d57b698afdacd18f5a414cdc7524fd">More...</a><br /></td></tr> +<tr class="separator:a99d57b698afdacd18f5a414cdc7524fd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a87b3c3ede7dee726e8779eebfcc0a299"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDate.html#a87b3c3ede7dee726e8779eebfcc0a299">Date</a> (unsigned short day, unsigned short month, unsigned short year)</td></tr> +<tr class="memdesc:a87b3c3ede7dee726e8779eebfcc0a299"><td class="mdescLeft"> </td><td class="mdescRight">Sets day, month and year. <a href="classDate.html#a87b3c3ede7dee726e8779eebfcc0a299">More...</a><br /></td></tr> +<tr class="separator:a87b3c3ede7dee726e8779eebfcc0a299"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2e4dc4249f8cccd40acc5950b42e1339"><td class="memItemLeft" align="right" valign="top"><a id="a2e4dc4249f8cccd40acc5950b42e1339" name="a2e4dc4249f8cccd40acc5950b42e1339"></a> +unsigned short </td><td class="memItemRight" valign="bottom"><b>get_day</b> () const</td></tr> +<tr class="memdesc:a2e4dc4249f8cccd40acc5950b42e1339"><td class="mdescLeft"> </td><td class="mdescRight">Returns the day. <br /></td></tr> +<tr class="separator:a2e4dc4249f8cccd40acc5950b42e1339"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acaf0c3ee1b2d36edf4f870ddd8acce08"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDate.html#acaf0c3ee1b2d36edf4f870ddd8acce08">set_day</a> (unsigned short day)</td></tr> +<tr class="memdesc:acaf0c3ee1b2d36edf4f870ddd8acce08"><td class="mdescLeft"> </td><td class="mdescRight">Sets the day. <a href="classDate.html#acaf0c3ee1b2d36edf4f870ddd8acce08">More...</a><br /></td></tr> +<tr class="separator:acaf0c3ee1b2d36edf4f870ddd8acce08"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a79ebbf3cb46f892604dc79ffc82bcfcc"><td class="memItemLeft" align="right" valign="top"><a id="a79ebbf3cb46f892604dc79ffc82bcfcc" name="a79ebbf3cb46f892604dc79ffc82bcfcc"></a> +unsigned short </td><td class="memItemRight" valign="bottom"><b>get_month</b> () const</td></tr> +<tr class="memdesc:a79ebbf3cb46f892604dc79ffc82bcfcc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the month. <br /></td></tr> +<tr class="separator:a79ebbf3cb46f892604dc79ffc82bcfcc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad0a591a557ddde0871389c3d716e6044"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDate.html#ad0a591a557ddde0871389c3d716e6044">set_month</a> (unsigned short month)</td></tr> +<tr class="memdesc:ad0a591a557ddde0871389c3d716e6044"><td class="mdescLeft"> </td><td class="mdescRight">Sets the month. <a href="classDate.html#ad0a591a557ddde0871389c3d716e6044">More...</a><br /></td></tr> +<tr class="separator:ad0a591a557ddde0871389c3d716e6044"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a025aae2b290ba357e049d054085f91e3"><td class="memItemLeft" align="right" valign="top"><a id="a025aae2b290ba357e049d054085f91e3" name="a025aae2b290ba357e049d054085f91e3"></a> +unsigned short </td><td class="memItemRight" valign="bottom"><b>get_year</b> () const</td></tr> +<tr class="memdesc:a025aae2b290ba357e049d054085f91e3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the year. <br /></td></tr> +<tr class="separator:a025aae2b290ba357e049d054085f91e3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6a0f3124e1850cd9f1514ebffcdd0cae"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDate.html#a6a0f3124e1850cd9f1514ebffcdd0cae">set_year</a> (unsigned short year)</td></tr> +<tr class="memdesc:a6a0f3124e1850cd9f1514ebffcdd0cae"><td class="mdescLeft"> </td><td class="mdescRight">Sets the year. <a href="classDate.html#a6a0f3124e1850cd9f1514ebffcdd0cae">More...</a><br /></td></tr> +<tr class="separator:a6a0f3124e1850cd9f1514ebffcdd0cae"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6e00ace9f8c923c96188bd76f1e064c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDate.html#a6e00ace9f8c923c96188bd76f1e064c2">createString</a> () const</td></tr> +<tr class="memdesc:a6e00ace9f8c923c96188bd76f1e064c2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the date as a <a class="el" href="classString.html">String</a> object. <a href="classDate.html#a6e00ace9f8c923c96188bd76f1e064c2">More...</a><br /></td></tr> +<tr class="separator:a6e00ace9f8c923c96188bd76f1e064c2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a982c0c9098056aa33c5cbc9eba093852"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDate.html#a982c0c9098056aa33c5cbc9eba093852">read</a> (std::istream &istr)</td></tr> +<tr class="memdesc:a982c0c9098056aa33c5cbc9eba093852"><td class="mdescLeft"> </td><td class="mdescRight">Reads date from stream. <a href="classDate.html#a982c0c9098056aa33c5cbc9eba093852">More...</a><br /></td></tr> +<tr class="separator:a982c0c9098056aa33c5cbc9eba093852"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9c728831f35f27abf3348132a13b7844"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDate.html#a9c728831f35f27abf3348132a13b7844">write</a> (std::ostream &ostr)</td></tr> +<tr class="memdesc:a9c728831f35f27abf3348132a13b7844"><td class="mdescLeft"> </td><td class="mdescRight">Writes date to stream. <a href="classDate.html#a9c728831f35f27abf3348132a13b7844">More...</a><br /></td></tr> +<tr class="separator:a9c728831f35f27abf3348132a13b7844"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3cda588bf2f65b84639303a1aa1105be"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDate.html#a3cda588bf2f65b84639303a1aa1105be">compare</a> (const <a class="el" href="classDate.html">Date</a> &other) const</td></tr> +<tr class="memdesc:a3cda588bf2f65b84639303a1aa1105be"><td class="mdescLeft"> </td><td class="mdescRight">Compares two dates. <a href="classDate.html#a3cda588bf2f65b84639303a1aa1105be">More...</a><br /></td></tr> +<tr class="separator:a3cda588bf2f65b84639303a1aa1105be"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p >Stores a day, month and year. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a99d57b698afdacd18f5a414cdc7524fd" name="a99d57b698afdacd18f5a414cdc7524fd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a99d57b698afdacd18f5a414cdc7524fd">◆ </a></span>Date() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Date::Date </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>str</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Parses string. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">str</td><td>C-style string</td></tr> + </table> + </dd> +</dl> +<p>Values are initialized with zeroes. Then it parses the string:</p> +<p >Skips spaces, saves day with atoi, skips two characters, skips spaces, saves month with atoi, skips two characters, skips spaces, saves year with atoi.</p> +<p >Values are validated with setters. You should always have spaces between day, month and year and no non-numeric characters between them.</p> +<dl class="section remark"><dt>Remarks</dt><dd>If there are non-numeric characters, as per atoi() spec, the appropriate property is zero. </dd></dl> + +</div> +</div> +<a id="a87b3c3ede7dee726e8779eebfcc0a299" name="a87b3c3ede7dee726e8779eebfcc0a299"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a87b3c3ede7dee726e8779eebfcc0a299">◆ </a></span>Date() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Date::Date </td> + <td>(</td> + <td class="paramtype">unsigned short </td> + <td class="paramname"><em>day</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned short </td> + <td class="paramname"><em>month</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned short </td> + <td class="paramname"><em>year</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets day, month and year. </p> +<p >Initializes values with zeroes and then uses setters to save the function arguments. </p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a3cda588bf2f65b84639303a1aa1105be" name="a3cda588bf2f65b84639303a1aa1105be"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3cda588bf2f65b84639303a1aa1105be">◆ </a></span>compare()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int Date::compare </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classDate.html">Date</a> & </td> + <td class="paramname"><em>other</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Compares two dates. </p> +<dl class="section return"><dt>Returns</dt><dd>-1 if this < other, 1 if this > other, 0 if this == other </dd></dl> + +</div> +</div> +<a id="a6e00ace9f8c923c96188bd76f1e064c2" name="a6e00ace9f8c923c96188bd76f1e064c2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6e00ace9f8c923c96188bd76f1e064c2">◆ </a></span>createString()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classString.html">String</a> Date::createString </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns the date as a <a class="el" href="classString.html">String</a> object. </p> +<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classString.html">String</a> object in the format "day.month.year"</dd></dl> +<dl class="section note"><dt>Note</dt><dd>Currently there isn't any way to change the formatting </dd></dl> + +</div> +</div> +<a id="a982c0c9098056aa33c5cbc9eba093852" name="a982c0c9098056aa33c5cbc9eba093852"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a982c0c9098056aa33c5cbc9eba093852">◆ </a></span>read()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void Date::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 date 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="classDate.html#a982c0c9098056aa33c5cbc9eba093852" title="Reads date 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="acaf0c3ee1b2d36edf4f870ddd8acce08" name="acaf0c3ee1b2d36edf4f870ddd8acce08"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acaf0c3ee1b2d36edf4f870ddd8acce08">◆ </a></span>set_day()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool Date::set_day </td> + <td>(</td> + <td class="paramtype">unsigned short </td> + <td class="paramname"><em>newDay</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets the day. </p> +<dl class="section return"><dt>Returns</dt><dd>Whether newDay was saved or not</dd></dl> +<p>If newDay is equal to 0, or is more than the appropriate days in the month, the day isn't set. </p> + +</div> +</div> +<a id="ad0a591a557ddde0871389c3d716e6044" name="ad0a591a557ddde0871389c3d716e6044"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad0a591a557ddde0871389c3d716e6044">◆ </a></span>set_month()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool Date::set_month </td> + <td>(</td> + <td class="paramtype">unsigned short </td> + <td class="paramname"><em>newMonth</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets the month. </p> +<dl class="section return"><dt>Returns</dt><dd>Whether newMonth was saved or not</dd></dl> +<p>If newMonth is equal to 0 or is more than 12, the month isn't set. </p> + +</div> +</div> +<a id="a6a0f3124e1850cd9f1514ebffcdd0cae" name="a6a0f3124e1850cd9f1514ebffcdd0cae"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6a0f3124e1850cd9f1514ebffcdd0cae">◆ </a></span>set_year()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool Date::set_year </td> + <td>(</td> + <td class="paramtype">unsigned short </td> + <td class="paramname"><em>newYear</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets the year. </p> +<dl class="section return"><dt>Returns</dt><dd>Whether year was saved or not</dd></dl> +<p>Year isn't set when newYear is zero </p> + +</div> +</div> +<a id="a9c728831f35f27abf3348132a13b7844" name="a9c728831f35f27abf3348132a13b7844"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9c728831f35f27abf3348132a13b7844">◆ </a></span>write()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void Date::write </td> + <td>(</td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>ostr</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Writes date 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="classDate.html#a9c728831f35f27abf3348132a13b7844" title="Writes date 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> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>src/Generic/Date/<a class="el" href="Date_8h_source.html">Date.h</a></li> +<li>src/Generic/Date/Date.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> |
