ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/vendor/libpeak-0.1.2/doc/html/group__time.html
Revision: 3251
Committed: Wed Apr 2 16:58:30 2014 UTC (9 years, 11 months ago) by michael
Content type: text/html
File size: 6928 byte(s)
Log Message:
- Imported libpeak-0.1.2

File Contents

# Content
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>PEAK Library: Time</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.3.5 -->
7 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a></div>
8 <h1>Time</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
9 This little Time module has been added in order to provide optimized simple time related methods. Systems provide similar features but you are invited to use PEAK's ones instead.
10 <p>
11 <table border=0 cellpadding=0 cellspacing=0>
12 <tr><td></td></tr>
13 <tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
14 <tr><td class="memItemLeft" nowrap align=right valign=top>struct &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structpeak__time__date.html">peak_time_date</a></td></tr>
15
16 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gregorian date structure. </em> <a href="structpeak__time__date.html#_details">More...</a><em><br><br></td></tr>
17 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
18 <tr><td class="memItemLeft" nowrap align=right valign=top>time_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__time.html#ga0">peak_time</a> (void)</td></tr>
19
20 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get current time. <a href="#ga0"></a><br><br></td></tr>
21 <tr><td class="memItemLeft" nowrap align=right valign=top>double&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__time.html#ga1">peak_time_float</a> (void)</td></tr>
22
23 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get current time with precision. <a href="#ga1"></a><br><br></td></tr>
24 <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structpeak__time__date.html">peak_time_date</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__time.html#ga2">peak_time_get_date</a> (double t, <a class="el" href="group__tz.html#ga0">peak_tz</a> tz)</td></tr>
25
26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Converts an Unix time value into a Gregorian date. <a href="#ga2"></a><br><br></td></tr>
27 </table>
28 <hr><h2>Function Documentation</h2>
29 <a class="anchor" name="ga0" doxytag="time.h::peak_time" ></a><p>
30 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
31 <tr>
32 <td class="mdRow">
33 <table cellpadding="0" cellspacing="0" border="0">
34 <tr>
35 <td class="md" nowrap valign="top"> time_t peak_time </td>
36 <td class="md" valign="top">(&nbsp;</td>
37 <td class="md" nowrap valign="top">void&nbsp;</td>
38 <td class="mdname1" valign="top" nowrap> </td>
39 <td class="md" valign="top">&nbsp;)&nbsp;</td>
40 <td class="md" nowrap></td>
41 </tr>
42
43 </table>
44 </td>
45 </tr>
46 </table>
47 <table cellspacing=5 cellpadding=0 border=0>
48 <tr>
49 <td>
50 &nbsp;
51 </td>
52 <td>
53
54 <p>
55 Get current time.
56 <p>
57 <dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="group__time.html#ga6">peak_time()</a> function returns the value of time in seconds since 0 hours, 0 minutes, 0 seconds, January 1, 1970, Coordinated Universal Time (the "epoch"). </dd></dl>
58 </td>
59 </tr>
60 </table>
61 <a class="anchor" name="ga1" doxytag="time.h::peak_time_float" ></a><p>
62 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
63 <tr>
64 <td class="mdRow">
65 <table cellpadding="0" cellspacing="0" border="0">
66 <tr>
67 <td class="md" nowrap valign="top"> double peak_time_float </td>
68 <td class="md" valign="top">(&nbsp;</td>
69 <td class="md" nowrap valign="top">void&nbsp;</td>
70 <td class="mdname1" valign="top" nowrap> </td>
71 <td class="md" valign="top">&nbsp;)&nbsp;</td>
72 <td class="md" nowrap></td>
73 </tr>
74
75 </table>
76 </td>
77 </tr>
78 </table>
79 <table cellspacing=5 cellpadding=0 border=0>
80 <tr>
81 <td>
82 &nbsp;
83 </td>
84 <td>
85
86 <p>
87 Get current time with precision.
88 <p>
89 <dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="group__time.html#ga7">peak_time_float()</a> function returns the value of time in seconds since 0 hours, 0 minutes, 0 seconds, January 1, 1970, Coordinated Universal Time (the "epoch"). </dd></dl>
90 </td>
91 </tr>
92 </table>
93 <a class="anchor" name="ga2" doxytag="time.h::peak_time_get_date" ></a><p>
94 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
95 <tr>
96 <td class="mdRow">
97 <table cellpadding="0" cellspacing="0" border="0">
98 <tr>
99 <td class="md" nowrap valign="top"> <a class="el" href="structpeak__time__date.html">peak_time_date</a> peak_time_get_date </td>
100 <td class="md" valign="top">(&nbsp;</td>
101 <td class="md" nowrap valign="top">double&nbsp;</td>
102 <td class="mdname" nowrap> <em>t</em>, </td>
103 </tr>
104 <tr>
105 <td></td>
106 <td></td>
107 <td class="md" nowrap><a class="el" href="group__tz.html#ga0">peak_tz</a>&nbsp;</td>
108 <td class="mdname" nowrap> <em>tz</em></td>
109 </tr>
110 <tr>
111 <td></td>
112 <td class="md">)&nbsp;</td>
113 <td class="md" colspan="2"></td>
114 </tr>
115
116 </table>
117 </td>
118 </tr>
119 </table>
120 <table cellspacing=5 cellpadding=0 border=0>
121 <tr>
122 <td>
123 &nbsp;
124 </td>
125 <td>
126
127 <p>
128 Converts an Unix time value into a Gregorian date.
129 <p>
130 <dl compact><dt><b>Parameters:</b></dt><dd>
131 <table border="0" cellspacing="2" cellpadding="0">
132 <tr><td valign=top><em>t</em>&nbsp;</td><td>Unix time value in second. Pass the result of <a class="el" href="group__time.html#ga7">peak_time_float()</a> to get current date. </td></tr>
133 <tr><td valign=top><em>tz</em>&nbsp;</td><td>Optional Time Zone reference. See <a class="el" href="group__tz.html#ga12">peak_tz_create()</a>. If provided, necessary time zone's conversions will be performed.</td></tr>
134 </table>
135 </dl>
136 <dl compact><dt><b>Returns:</b></dt><dd>The Gregorian date equivalent for the specified time value since 0 hours, 0 minutes, 0 seconds, January 1, 1970, Coordinated Universal Time (the "epoch"). </dd></dl>
137 </td>
138 </tr>
139 </table>
140 <hr size="1"><address style="align: right;"><small>Generated on Sat Jan 17 21:41:54 2004 for the PEAK Library by
141 <a href="http://www.doxygen.org/index.html">
142 <img src="doxygen.png" alt="doxygen" align="middle" border="0" >
143 </a></small>&nbsp; &nbsp; <a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=98146&amp;type=1" width="88" height="31" align="middle" border="0" alt="SourceForge.net Logo" /></a></address>
144 </body>
145 </html>
146