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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
|
<!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: icalspanlist.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
 <span id="projectnumber">3.0</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&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&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_e5788c73bf8d77f47d4a3002d26bfd20.html">libicalss</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">icalspanlist.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Code that supports collections of free/busy spans of time.
<a href="#details">More...</a></p>
<p><a href="icalspanlist_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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ab56eb13ccdb70ef4a7d6aede068d6fd4"><td class="memItemLeft" align="right" valign="top"><a id="ab56eb13ccdb70ef4a7d6aede068d6fd4"></a>
typedef struct <a class="el" href="structicalspanlist__impl.html">icalspanlist_impl</a> </td><td class="memItemRight" valign="bottom"><b>icalspanlist</b></td></tr>
<tr class="separator:ab56eb13ccdb70ef4a7d6aede068d6fd4"><td class="memSeparator" colspan="2"> </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:aca42fe723854f27dee1dbd89ac8eea43"><td class="memItemLeft" align="right" valign="top">int * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#aca42fe723854f27dee1dbd89ac8eea43">icalspanlist_as_freebusy_matrix</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *span, int delta_t)</td></tr>
<tr class="memdesc:aca42fe723854f27dee1dbd89ac8eea43"><td class="mdescLeft"> </td><td class="mdescRight">Returns an hour-by-hour array of free/busy times over a given period. <a href="icalspanlist_8h.html#aca42fe723854f27dee1dbd89ac8eea43">More...</a><br /></td></tr>
<tr class="separator:aca42fe723854f27dee1dbd89ac8eea43"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c5f900137f272a1897d8856fbd1b961"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a2c5f900137f272a1897d8856fbd1b961">icalspanlist_as_vfreebusy</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *sl, const char *organizer, const char *attendee)</td></tr>
<tr class="memdesc:a2c5f900137f272a1897d8856fbd1b961"><td class="mdescLeft"> </td><td class="mdescRight">Returns a VFREEBUSY component for a spanlist. <a href="icalspanlist_8h.html#a2c5f900137f272a1897d8856fbd1b961">More...</a><br /></td></tr>
<tr class="separator:a2c5f900137f272a1897d8856fbd1b961"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ad885ca2cbf81bfea72d04cf17b5010"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a5ad885ca2cbf81bfea72d04cf17b5010">icalspanlist_dump</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *s)</td></tr>
<tr class="memdesc:a5ad885ca2cbf81bfea72d04cf17b5010"><td class="mdescLeft"> </td><td class="mdescRight">(Debug) print out spanlist to STDOUT. <a href="icalspanlist_8h.html#a5ad885ca2cbf81bfea72d04cf17b5010">More...</a><br /></td></tr>
<tr class="separator:a5ad885ca2cbf81bfea72d04cf17b5010"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aacc49ed6cd735f495292f0cf3c464a4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#aacc49ed6cd735f495292f0cf3c464a4d">icalspanlist_free</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *spl)</td></tr>
<tr class="memdesc:aacc49ed6cd735f495292f0cf3c464a4d"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="icalspanlist_8h.html#aacc49ed6cd735f495292f0cf3c464a4d">More...</a><br /></td></tr>
<tr class="separator:aacc49ed6cd735f495292f0cf3c464a4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7178dfde5839654471d57611794eda96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a7178dfde5839654471d57611794eda96">icalspanlist_from_vfreebusy</a> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr>
<tr class="memdesc:a7178dfde5839654471d57611794eda96"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an icalspanlist from a VFREEBUSY component. <a href="icalspanlist_8h.html#a7178dfde5839654471d57611794eda96">More...</a><br /></td></tr>
<tr class="separator:a7178dfde5839654471d57611794eda96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7f6d3e48e73cf9cd2712abd101400eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#ae7f6d3e48e73cf9cd2712abd101400eb">icalspanlist_new</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> start, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> end)</td></tr>
<tr class="memdesc:ae7f6d3e48e73cf9cd2712abd101400eb"><td class="mdescLeft"> </td><td class="mdescRight">Makes a free list from a set of VEVENT components. <a href="icalspanlist_8h.html#ae7f6d3e48e73cf9cd2712abd101400eb">More...</a><br /></td></tr>
<tr class="separator:ae7f6d3e48e73cf9cd2712abd101400eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8686abb751773c3358c1a82fb79606c"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#af8686abb751773c3358c1a82fb79606c">icalspanlist_next_free_time</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *sl, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> t)</td></tr>
<tr class="memdesc:af8686abb751773c3358c1a82fb79606c"><td class="mdescLeft"> </td><td class="mdescRight">Finds the next free time span in a spanlist. <a href="icalspanlist_8h.html#af8686abb751773c3358c1a82fb79606c">More...</a><br /></td></tr>
<tr class="separator:af8686abb751773c3358c1a82fb79606c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Code that supports collections of free/busy spans of time. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aca42fe723854f27dee1dbd89ac8eea43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca42fe723854f27dee1dbd89ac8eea43">◆ </a></span>icalspanlist_as_freebusy_matrix()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int* icalspanlist_as_freebusy_matrix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td>
<td class="paramname"><em>span</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>delta_t</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an hour-by-hour array of free/busy times over a given period. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sl</td><td>A valid icalspanlist </td></tr>
<tr><td class="paramname">delta_t</td><td>The time slice to divide by, in seconds. Default 3600.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to an array of integers containing the number of busy events in each delta_t time period. The final entry contains the value -1.</dd></dl>
<p>This calculation is somewhat tricky. This is due to the fact that the time range contains the start time, but does not contain the end time. To perform a proper calculation we subtract one second off the end times to get a true containing time.</p>
<p>Also note that if you supplying a spanlist that does not start or end on a time boundary divisible by delta_t you may get results that are not quite what you expect. </p>
</div>
</div>
<a id="a2c5f900137f272a1897d8856fbd1b961"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c5f900137f272a1897d8856fbd1b961">◆ </a></span>icalspanlist_as_vfreebusy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalspanlist_as_vfreebusy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td>
<td class="paramname"><em>sl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>organizer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>attendee</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a VFREEBUSY component for a spanlist. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sl</td><td>A valid icalspanlist, from <a class="el" href="icalspanlist_8h.html#ae7f6d3e48e73cf9cd2712abd101400eb" title="Makes a free list from a set of VEVENT components.">icalspanlist_new()</a> </td></tr>
<tr><td class="paramname">organizer</td><td>The organizer specified as "MAILTO:user@domain" </td></tr>
<tr><td class="paramname">attendee</td><td>The attendee specified as "MAILTO:user@domain"</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A valid icalcomponent or NULL.</dd></dl>
<p>This function returns a VFREEBUSY component for the given spanlist. The start time is mapped to DTSTART, the end time to DTEND. Each busy span is represented as a separate FREEBUSY entry. An attendee parameter is required, and organizer parameter is optional. </p>
</div>
</div>
<a id="a5ad885ca2cbf81bfea72d04cf17b5010"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ad885ca2cbf81bfea72d04cf17b5010">◆ </a></span>icalspanlist_dump()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalspanlist_dump </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>(Debug) print out spanlist to STDOUT. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sl</td><td>A valid icalspanlist. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aacc49ed6cd735f495292f0cf3c464a4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacc49ed6cd735f495292f0cf3c464a4d">◆ </a></span>icalspanlist_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalspanlist_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td>
<td class="paramname"><em>spl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>A valid icalspanlist</td></tr>
</table>
</dd>
</dl>
<p>Frees the memory associated with the spanlist. </p>
</div>
</div>
<a id="a7178dfde5839654471d57611794eda96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7178dfde5839654471d57611794eda96">◆ </a></span>icalspanlist_from_vfreebusy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a>* icalspanlist_from_vfreebusy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td>
<td class="paramname"><em>comp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an icalspanlist from a VFREEBUSY component. </p>
<p>Constructs an icalspanlist from the VFREEBUSY component of an icalcomponent.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">comp</td><td>A valid icalcomponent.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A valid icalspanlist or NULL if no VFREEBUSY section. </dd></dl>
</div>
</div>
<a id="ae7f6d3e48e73cf9cd2712abd101400eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7f6d3e48e73cf9cd2712abd101400eb">◆ </a></span>icalspanlist_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a>* icalspanlist_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td>
<td class="paramname"><em>set</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td>
<td class="paramname"><em>end</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes a free list from a set of VEVENT components. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">set</td><td>A valid icalset containing VEVENTS </td></tr>
<tr><td class="paramname">start</td><td>The free list starts at this date/time </td></tr>
<tr><td class="paramname">end</td><td>The free list ends at this date/time</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A spanlist corresponding to the VEVENTS</dd></dl>
<p>Given a set of components, a start time and an end time return a spanlist that contains the free/busy times. <code>Start</code> and <code>end</code> should be in UTC. </p>
</div>
</div>
<a id="af8686abb751773c3358c1a82fb79606c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8686abb751773c3358c1a82fb79606c">◆ </a></span>icalspanlist_next_free_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> icalspanlist_next_free_time </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td>
<td class="paramname"><em>sl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td>
<td class="paramname"><em>t</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds the next free time span in a spanlist. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sl</td><td>The spanlist to search. </td></tr>
<tr><td class="paramname">t</td><td>The time to start looking.</td></tr>
</table>
</dd>
</dl>
<p>Given a spanlist and a time, finds the next period of time that is free. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Apr 9 2022 08:34:57 for Libical API Documentation by <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>
|
