summaryrefslogtreecommitdiff
path: root/apidocs/astime_8h.html
blob: a6c096720530fe290523f90ee3dbd1a272c21a22 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!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=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: astime.h File 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 style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Libical API Documentation
   &#160;<span id="projectnumber">3.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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_b7a0ea939f6e83384f3c571d31a84be9.html">libical</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">astime.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>contains definitions of structures used for time calculations.  
<a href="#details">More...</a></p>

<p><a href="astime_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structut__instant.html">ut_instant</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structut__instant__int.html">ut_instant_int</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a5b01abbbfd83d9f52f295b5044c0c9af"><td class="memItemLeft" align="right" valign="top"><a id="a5b01abbbfd83d9f52f295b5044c0c9af"></a>
typedef struct <a class="el" href="structut__instant.html">ut_instant</a>&#160;</td><td class="memItemRight" valign="bottom"><b>UTinstant</b></td></tr>
<tr class="separator:a5b01abbbfd83d9f52f295b5044c0c9af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf71d20e9d2a8908c5182028dc43cd76"><td class="memItemLeft" align="right" valign="top"><a id="abf71d20e9d2a8908c5182028dc43cd76"></a>
typedef struct <a class="el" href="structut__instant__int.html">ut_instant_int</a>&#160;</td><td class="memItemRight" valign="bottom"><b>UTinstantInt</b></td></tr>
<tr class="separator:abf71d20e9d2a8908c5182028dc43cd76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c97395a86f10cc5a6048c5ab47e644d"><td class="memItemLeft" align="right" valign="top"><a id="a5c97395a86f10cc5a6048c5ab47e644d"></a>
typedef struct <a class="el" href="structut__instant__int.html">ut_instant_int</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>UTinstantIntPtr</b></td></tr>
<tr class="separator:a5c97395a86f10cc5a6048c5ab47e644d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a639fb49015ff3b958bc16062a7c783d5"><td class="memItemLeft" align="right" valign="top"><a id="a639fb49015ff3b958bc16062a7c783d5"></a>
typedef struct <a class="el" href="structut__instant.html">ut_instant</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>UTinstantPtr</b></td></tr>
<tr class="separator:a639fb49015ff3b958bc16062a7c783d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a45de6b3b6e622aed44641b4014bd85d1"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="astime_8h.html#a45de6b3b6e622aed44641b4014bd85d1">caldat</a> (<a class="el" href="structut__instant.html">UTinstantPtr</a>))</td></tr>
<tr class="separator:a45de6b3b6e622aed44641b4014bd85d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade0421d368a2914b2e2cf0634bdd1a1b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="astime_8h.html#ade0421d368a2914b2e2cf0634bdd1a1b">caldat_int</a> (<a class="el" href="structut__instant__int.html">UTinstantIntPtr</a>)</td></tr>
<tr class="separator:ade0421d368a2914b2e2cf0634bdd1a1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c6a160930d1c125892a81813a0d8d4b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="astime_8h.html#a1c6a160930d1c125892a81813a0d8d4b">juldat</a> (<a class="el" href="structut__instant.html">UTinstantPtr</a>))</td></tr>
<tr class="separator:a1c6a160930d1c125892a81813a0d8d4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cc1a455b453977f754842b9666440a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="astime_8h.html#a3cc1a455b453977f754842b9666440a2">juldat_int</a> (<a class="el" href="structut__instant__int.html">UTinstantIntPtr</a>)</td></tr>
<tr class="separator:a3cc1a455b453977f754842b9666440a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>contains definitions of structures used for time calculations. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a45de6b3b6e622aed44641b4014bd85d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45de6b3b6e622aed44641b4014bd85d1">&#9670;&nbsp;</a></span>caldat()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">long caldat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structut__instant.html">UTinstantPtr</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Converts julian date to year,mo,da </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>use <a class="el" href="astime_8h.html#ade0421d368a2914b2e2cf0634bdd1a1b">caldat_int()</a> instead </dd></dl>

</div>
</div>
<a id="ade0421d368a2914b2e2cf0634bdd1a1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade0421d368a2914b2e2cf0634bdd1a1b">&#9670;&nbsp;</a></span>caldat_int()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void caldat_int </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structut__instant__int.html">UTinstantIntPtr</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>caldat computes the day of the week, the day of the year the gregorian (or julian) calendar date from the julian decimal date. for astronomical purposes, The Gregorian calendar reform occurred on 15 Oct. 1582. This is 05 Oct 1582 by the julian calendar.</p>
<p>Input: a <a class="el" href="structut__instant.html">ut_instant</a> structure pointer, where the j_date element has been set. ( = 0 for 01 Jan 4713 B.C.)</p>
<p>output: will set all the other elements of the structure. As a convenience, the function will also return the year.</p>
<p>Reference: Astronomial formulae for calculators, meeus, p 23 from fortran program by F. Espenak - April 1982 Page 277, 50 Year canon of solar eclipses: 1986-2035 </p>

</div>
</div>
<a id="a1c6a160930d1c125892a81813a0d8d4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c6a160930d1c125892a81813a0d8d4b">&#9670;&nbsp;</a></span>juldat()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double juldat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structut__instant.html">UTinstantPtr</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns julian day from year,mo,da </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>use <a class="el" href="astime_8h.html#a3cc1a455b453977f754842b9666440a2">juldat_int()</a> instead </dd></dl>

</div>
</div>
<a id="a3cc1a455b453977f754842b9666440a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cc1a455b453977f754842b9666440a2">&#9670;&nbsp;</a></span>juldat_int()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void juldat_int </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structut__instant__int.html">UTinstantIntPtr</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>juldat computes the julian decimal date (j_date) from the gregorian (or Julian) calendar date. for astronomical purposes, The Gregorian calendar reform occurred on 15 Oct. 1582. This is 05 Oct 1582 by the julian calendar. Input: a <a class="el" href="structut__instant.html">ut_instant</a> structure pointer where Day, Month, Year have been set for the date in question.</p>
<p>Output: the j_date and weekday elements of the structure will be set. Also, the return value of the function will be the j_date too.</p>
<p>Reference: Astronomial formulae for calculators, meeus, p 23 from fortran program by F. Espenak - April 1982 Page 276, 50 Year canon of solar eclipses: 1986-2035 </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Apr 9 2022 08:46:36 for Libical API Documentation by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>