<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
<title>edelib: Time Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">edelib
 <span id="projectnumber">2.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceedelib.html">edelib</a> </li>
<li class="navelem"><a class="el" href="classedelib_1_1Time.html">Time</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Time Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="edelib::Time" -->
<p>A class for time manipulation.
<a href="classedelib_1_1Time.html#details">More...</a></p>
<p><code>#include <<a class="el" href="DateTime_8h_source.html">edelib/DateTime.h</a>></code></p>
<p><a href="classedelib_1_1Time-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#a38b0285424ae98cbe324c635b300c750">Time</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#a576b0c38902945277a5217a4e7c2b1bc">Time</a> (const <a class="el" href="classedelib_1_1Time.html">Time</a> &t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classedelib_1_1Time.html">Time</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#ab9031a176e64b3962cc75f2649048302">operator=</a> (const <a class="el" href="classedelib_1_1Time.html">Time</a> &t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#af3bc16485bfe955f9cd4ebde7399c135">~Time</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#a352b83b79f429bd2f767ecd9e8696b4e">set</a> (unsigned char h, unsigned char m, unsigned char s=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#a3927dc22378884b7dcedcb4dccb6e236">set_now</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#abfe16813a01e97ef0ce11831362f7bde">system_set</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#a7c80e4e8744c595b1e4c357d90cf7389">hour</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#abb613651c6387b26f72b9b727874d9b0">minute</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#a83e7744626aef30a8fcb8e3aa6cdad7a">second</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classedelib_1_1Time.html">Time</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#a0d0aca197847dae28c6177db7bcc3443">operator++</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classedelib_1_1Time.html">Time</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#ad7c5633dcec4b8a8803ae65d2b1a8ec1">operator++</a> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classedelib_1_1Time.html">Time</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#aa5353bf1bbee8a069fe531af40838a07">operator--</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classedelib_1_1Time.html">Time</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#a3c0803b4e6edfab3173a773856f2eed7">operator--</a> (int)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1Time.html#a1cad40fe967bff54a14beb6de8de7185">is_valid</a> (unsigned char h, unsigned char m, unsigned char s)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A class for time manipulation. </p>
<p>This class allows you to manipulate with time, fetch or set one. Hour can be 0 <= hour < 24. Minutes and seconds are in 0 <= val < 60.</p>
<dl class="note"><dt><b>Note:</b></dt><dd><a class="el" href="classedelib_1_1Time.html" title="A class for time manipulation.">Time</a> where hour is 0 is always less than time where hour is 23.</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd><a class="el" href="classedelib_1_1Time.html" title="A class for time manipulation.">Time</a> is missing local/UTC option. </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a38b0285424ae98cbe324c635b300c750"></a><!-- doxytag: member="edelib::Time::Time" ref="a38b0285424ae98cbe324c635b300c750" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1Time.html">Time</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor that will set all time members to 0. This is valid time. </p>
</div>
</div>
<a class="anchor" id="a576b0c38902945277a5217a4e7c2b1bc"></a><!-- doxytag: member="edelib::Time::Time" ref="a576b0c38902945277a5217a4e7c2b1bc" args="(const Time &t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1Time.html">Time</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classedelib_1_1Time.html">Time</a> & </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct time via previously declared value </p>
</div>
</div>
<a class="anchor" id="af3bc16485bfe955f9cd4ebde7399c135"></a><!-- doxytag: member="edelib::Time::~Time" ref="af3bc16485bfe955f9cd4ebde7399c135" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classedelib_1_1Time.html">Time</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7c80e4e8744c595b1e4c357d90cf7389"></a><!-- doxytag: member="edelib::Time::hour" ref="a7c80e4e8744c595b1e4c357d90cf7389" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="classedelib_1_1Time.html#a7c80e4e8744c595b1e4c357d90cf7389">hour</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns hour </p>
</div>
</div>
<a class="anchor" id="a1cad40fe967bff54a14beb6de8de7185"></a><!-- doxytag: member="edelib::Time::is_valid" ref="a1cad40fe967bff54a14beb6de8de7185" args="(unsigned char h, unsigned char m, unsigned char s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classedelib_1_1Time.html#a1cad40fe967bff54a14beb6de8de7185">is_valid</a> </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if given parameters can be valid time</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if time is valid </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">h</td><td>is hour </td></tr>
<tr><td class="paramname">m</td><td>is minutes </td></tr>
<tr><td class="paramname">s</td><td>is seconds </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abb613651c6387b26f72b9b727874d9b0"></a><!-- doxytag: member="edelib::Time::minute" ref="abb613651c6387b26f72b9b727874d9b0" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="classedelib_1_1Time.html#abb613651c6387b26f72b9b727874d9b0">minute</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns minutes </p>
</div>
</div>
<a class="anchor" id="a0d0aca197847dae28c6177db7bcc3443"></a><!-- doxytag: member="edelib::Time::operator++" ref="a0d0aca197847dae28c6177db7bcc3443" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1Time.html">Time</a>& operator++ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increase current time by one. First seconds are increased; when they reach 59, minutes are increased and seconds are set to 0. The same applies for minutes/hour case. When hour reach for 23, it is set to 0 (the same behaviour as you see from your digital clock). </p>
</div>
</div>
<a class="anchor" id="ad7c5633dcec4b8a8803ae65d2b1a8ec1"></a><!-- doxytag: member="edelib::Time::operator++" ref="ad7c5633dcec4b8a8803ae65d2b1a8ec1" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1Time.html">Time</a> operator++ </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Suffix increment </p>
</div>
</div>
<a class="anchor" id="aa5353bf1bbee8a069fe531af40838a07"></a><!-- doxytag: member="edelib::Time::operator--" ref="aa5353bf1bbee8a069fe531af40838a07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1Time.html">Time</a>& operator-- </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reverse from <a class="el" href="classedelib_1_1Time.html#a0d0aca197847dae28c6177db7bcc3443">operator++()</a> </p>
</div>
</div>
<a class="anchor" id="a3c0803b4e6edfab3173a773856f2eed7"></a><!-- doxytag: member="edelib::Time::operator--" ref="a3c0803b4e6edfab3173a773856f2eed7" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1Time.html">Time</a> operator-- </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Suffix decrement </p>
</div>
</div>
<a class="anchor" id="ab9031a176e64b3962cc75f2649048302"></a><!-- doxytag: member="edelib::Time::operator=" ref="ab9031a176e64b3962cc75f2649048302" args="(const Time &t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1Time.html">Time</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classedelib_1_1Time.html">Time</a> & </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign previously declared value. Current time will be replaced. </p>
</div>
</div>
<a class="anchor" id="a83e7744626aef30a8fcb8e3aa6cdad7a"></a><!-- doxytag: member="edelib::Time::second" ref="a83e7744626aef30a8fcb8e3aa6cdad7a" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="classedelib_1_1Time.html#a83e7744626aef30a8fcb8e3aa6cdad7a">second</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns seconds </p>
</div>
</div>
<a class="anchor" id="a352b83b79f429bd2f767ecd9e8696b4e"></a><!-- doxytag: member="edelib::Time::set" ref="a352b83b79f429bd2f767ecd9e8696b4e" args="(unsigned char h, unsigned char m, unsigned char s=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1Time.html#a352b83b79f429bd2f767ecd9e8696b4e">set</a> </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>s</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set time values. Values should be valid time, or assertion will be triggered.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">h</td><td>is hour </td></tr>
<tr><td class="paramname">m</td><td>is minutes </td></tr>
<tr><td class="paramname">s</td><td>is seconds </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3927dc22378884b7dcedcb4dccb6e236"></a><!-- doxytag: member="edelib::Time::set_now" ref="a3927dc22378884b7dcedcb4dccb6e236" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1Time.html#a3927dc22378884b7dcedcb4dccb6e236">set_now</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read system time and fill internal values</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>This should be probably a static function </dd></dl>
</div>
</div>
<a class="anchor" id="abfe16813a01e97ef0ce11831362f7bde"></a><!-- doxytag: member="edelib::Time::system_set" ref="abfe16813a01e97ef0ce11831362f7bde" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classedelib_1_1Time.html#abfe16813a01e97ef0ce11831362f7bde">system_set</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tries to set system time with current values. This function requires priviledged user. It behaves the same as <a class="el" href="classedelib_1_1Date.html#abfe16813a01e97ef0ce11831362f7bde">Date::system_set()</a> (see it's documentation for detail description).</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>This should be probably a static function </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>edelib/<a class="el" href="DateTime_8h_source.html">DateTime.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 5 2012 17:49:02 for edelib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
