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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
|
<!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"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan PX2/PX3 JSON-RPC API: event::TimerEventManager_2_0_0 Interface 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">Raritan PX2/PX3 JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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');
/* @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="namespaceevent.html">event</a></li><li class="navelem"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html">TimerEventManager_2_0_0</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfaceevent_1_1TimerEventManager__2__0__0-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">event::TimerEventManager_2_0_0 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>TimerEventManager interface.
<a href="interfaceevent_1_1TimerEventManager__2__0__0.html#details">More...</a></p>
<p><code>import"<a class="el" href="TimerEventManager_8idl_source.html">TimerEventManager.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1Range.html">Range</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1Range.html" title="Range structure. ">Range</a> structure. <a href="structevent_1_1TimerEventManager__2__0__0_1_1Range.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1Schedule.html">Schedule</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1Schedule.html" title="Schedule structure. ">Schedule</a> structure. <a href="structevent_1_1TimerEventManager__2__0__0_1_1Schedule.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1TimerEvent.html">TimerEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1TimerEvent.html" title="TimerEvent structure. ">TimerEvent</a> structure. <a href="structevent_1_1TimerEventManager__2__0__0_1_1TimerEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa92644a272db3d76dad8d20721e9ffc7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#aa92644a272db3d76dad8d20721e9ffc7">addTimerEvent</a> (in <a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1Schedule.html">Schedule</a> schedule, out vector< string > eventId)</td></tr>
<tr class="memdesc:aa92644a272db3d76dad8d20721e9ffc7"><td class="mdescLeft"> </td><td class="mdescRight">Add a new timer event. <a href="#aa92644a272db3d76dad8d20721e9ffc7">More...</a><br /></td></tr>
<tr class="separator:aa92644a272db3d76dad8d20721e9ffc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b3d3339e0a9bbf49696291fcf48902c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a6b3d3339e0a9bbf49696291fcf48902c">modifyTimerEvent</a> (in vector< string > eventId, in <a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1Schedule.html">Schedule</a> schedule)</td></tr>
<tr class="memdesc:a6b3d3339e0a9bbf49696291fcf48902c"><td class="mdescLeft"> </td><td class="mdescRight">Modify a timer event. <a href="#a6b3d3339e0a9bbf49696291fcf48902c">More...</a><br /></td></tr>
<tr class="separator:a6b3d3339e0a9bbf49696291fcf48902c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57f58aaa3c79ef68e1fa25fb41ffee80"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a57f58aaa3c79ef68e1fa25fb41ffee80">deleteTimerEvent</a> (in vector< string > eventId)</td></tr>
<tr class="memdesc:a57f58aaa3c79ef68e1fa25fb41ffee80"><td class="mdescLeft"> </td><td class="mdescRight">Delete a timer event. <a href="#a57f58aaa3c79ef68e1fa25fb41ffee80">More...</a><br /></td></tr>
<tr class="separator:a57f58aaa3c79ef68e1fa25fb41ffee80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7f89bce42350604db70fbd742c0ec73"><td class="memItemLeft" align="right" valign="top"><a id="ac7f89bce42350604db70fbd742c0ec73"></a>
vector< <a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1TimerEvent.html">TimerEvent</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#ac7f89bce42350604db70fbd742c0ec73">listTimerEvents</a> ()</td></tr>
<tr class="memdesc:ac7f89bce42350604db70fbd742c0ec73"><td class="mdescLeft"> </td><td class="mdescRight">List all timer events. <br /></td></tr>
<tr class="separator:ac7f89bce42350604db70fbd742c0ec73"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a4e9943cae9904bc1d965e8ef26dfb926"><td class="memItemLeft" align="right" valign="top">constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a4e9943cae9904bc1d965e8ef26dfb926">NO_ERROR</a> = 0</td></tr>
<tr class="memdesc:a4e9943cae9904bc1d965e8ef26dfb926"><td class="mdescLeft"> </td><td class="mdescRight">Error codes. <a href="#a4e9943cae9904bc1d965e8ef26dfb926">More...</a><br /></td></tr>
<tr class="separator:a4e9943cae9904bc1d965e8ef26dfb926"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6ee88152a200bdf80f7e24cdf84366a"><td class="memItemLeft" align="right" valign="top"><a id="ac6ee88152a200bdf80f7e24cdf84366a"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#ac6ee88152a200bdf80f7e24cdf84366a">ERR_INVALID_SCHEDULE</a> = 1</td></tr>
<tr class="memdesc:ac6ee88152a200bdf80f7e24cdf84366a"><td class="mdescLeft"> </td><td class="mdescRight">failure in schedule <br /></td></tr>
<tr class="separator:ac6ee88152a200bdf80f7e24cdf84366a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48f279effc83c50063d103e12b1d9e5d"><td class="memItemLeft" align="right" valign="top"><a id="a48f279effc83c50063d103e12b1d9e5d"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a48f279effc83c50063d103e12b1d9e5d">ERR_UNKNOWN_EVENT_ID</a> = 2</td></tr>
<tr class="memdesc:a48f279effc83c50063d103e12b1d9e5d"><td class="mdescLeft"> </td><td class="mdescRight">unknown eventId <br /></td></tr>
<tr class="separator:a48f279effc83c50063d103e12b1d9e5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7db521412afeabf25e4cf595ef3c26cc"><td class="memItemLeft" align="right" valign="top"><a id="a7db521412afeabf25e4cf595ef3c26cc"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a7db521412afeabf25e4cf595ef3c26cc">ERR_CREATE_EVENT_ID_FAILED</a> = 3</td></tr>
<tr class="memdesc:a7db521412afeabf25e4cf595ef3c26cc"><td class="mdescLeft"> </td><td class="mdescRight">creating eventId failed <br /></td></tr>
<tr class="separator:a7db521412afeabf25e4cf595ef3c26cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c5d3b858ea94aba76e4e5c134c26b41"><td class="memItemLeft" align="right" valign="top"><a id="a3c5d3b858ea94aba76e4e5c134c26b41"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a3c5d3b858ea94aba76e4e5c134c26b41">ERR_MAX_TIMERS_CREATED</a> = 4</td></tr>
<tr class="memdesc:a3c5d3b858ea94aba76e4e5c134c26b41"><td class="mdescLeft"> </td><td class="mdescRight">max number of timers have been created <br /></td></tr>
<tr class="separator:a3c5d3b858ea94aba76e4e5c134c26b41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b07d5d6f30d3addb6521c52766eca40"><td class="memItemLeft" align="right" valign="top">constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a0b07d5d6f30d3addb6521c52766eca40">JAN</a> = 1</td></tr>
<tr class="memdesc:a0b07d5d6f30d3addb6521c52766eca40"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1Schedule.html" title="Schedule structure. ">Schedule</a> defines and structures. <a href="#a0b07d5d6f30d3addb6521c52766eca40">More...</a><br /></td></tr>
<tr class="separator:a0b07d5d6f30d3addb6521c52766eca40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d2854e466cca12c5e77268c7157cea7"><td class="memItemLeft" align="right" valign="top"><a id="a4d2854e466cca12c5e77268c7157cea7"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a4d2854e466cca12c5e77268c7157cea7">FEB</a> = 2</td></tr>
<tr class="memdesc:a4d2854e466cca12c5e77268c7157cea7"><td class="mdescLeft"> </td><td class="mdescRight">February. <br /></td></tr>
<tr class="separator:a4d2854e466cca12c5e77268c7157cea7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5680af65b22dc9940b30a84e6d37c55f"><td class="memItemLeft" align="right" valign="top"><a id="a5680af65b22dc9940b30a84e6d37c55f"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a5680af65b22dc9940b30a84e6d37c55f">MAR</a> = 3</td></tr>
<tr class="memdesc:a5680af65b22dc9940b30a84e6d37c55f"><td class="mdescLeft"> </td><td class="mdescRight">March. <br /></td></tr>
<tr class="separator:a5680af65b22dc9940b30a84e6d37c55f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad3f7dcb5e50f880538bfe5bef100891"><td class="memItemLeft" align="right" valign="top"><a id="aad3f7dcb5e50f880538bfe5bef100891"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#aad3f7dcb5e50f880538bfe5bef100891">APR</a> = 4</td></tr>
<tr class="memdesc:aad3f7dcb5e50f880538bfe5bef100891"><td class="mdescLeft"> </td><td class="mdescRight">April. <br /></td></tr>
<tr class="separator:aad3f7dcb5e50f880538bfe5bef100891"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af72cde8de296d5a027f98a447f151055"><td class="memItemLeft" align="right" valign="top"><a id="af72cde8de296d5a027f98a447f151055"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#af72cde8de296d5a027f98a447f151055">MAY</a> = 5</td></tr>
<tr class="memdesc:af72cde8de296d5a027f98a447f151055"><td class="mdescLeft"> </td><td class="mdescRight">May. <br /></td></tr>
<tr class="separator:af72cde8de296d5a027f98a447f151055"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31cfd16467c580ab794e1fdbadf502a3"><td class="memItemLeft" align="right" valign="top"><a id="a31cfd16467c580ab794e1fdbadf502a3"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a31cfd16467c580ab794e1fdbadf502a3">JUN</a> = 6</td></tr>
<tr class="memdesc:a31cfd16467c580ab794e1fdbadf502a3"><td class="mdescLeft"> </td><td class="mdescRight">June. <br /></td></tr>
<tr class="separator:a31cfd16467c580ab794e1fdbadf502a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7074355e21d199b927328aab4063f197"><td class="memItemLeft" align="right" valign="top"><a id="a7074355e21d199b927328aab4063f197"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a7074355e21d199b927328aab4063f197">JUL</a> = 7</td></tr>
<tr class="memdesc:a7074355e21d199b927328aab4063f197"><td class="mdescLeft"> </td><td class="mdescRight">July. <br /></td></tr>
<tr class="separator:a7074355e21d199b927328aab4063f197"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4dbd88e72508ba5414dfa61109463197"><td class="memItemLeft" align="right" valign="top"><a id="a4dbd88e72508ba5414dfa61109463197"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a4dbd88e72508ba5414dfa61109463197">AUG</a> = 8</td></tr>
<tr class="memdesc:a4dbd88e72508ba5414dfa61109463197"><td class="mdescLeft"> </td><td class="mdescRight">August. <br /></td></tr>
<tr class="separator:a4dbd88e72508ba5414dfa61109463197"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad85b41bea178549902bd2ef0c113a125"><td class="memItemLeft" align="right" valign="top"><a id="ad85b41bea178549902bd2ef0c113a125"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#ad85b41bea178549902bd2ef0c113a125">SEP</a> = 9</td></tr>
<tr class="memdesc:ad85b41bea178549902bd2ef0c113a125"><td class="mdescLeft"> </td><td class="mdescRight">September. <br /></td></tr>
<tr class="separator:ad85b41bea178549902bd2ef0c113a125"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade3afcfb9d11729b5bc7cd6bedc5c827"><td class="memItemLeft" align="right" valign="top"><a id="ade3afcfb9d11729b5bc7cd6bedc5c827"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#ade3afcfb9d11729b5bc7cd6bedc5c827">OCT</a> = 10</td></tr>
<tr class="memdesc:ade3afcfb9d11729b5bc7cd6bedc5c827"><td class="mdescLeft"> </td><td class="mdescRight">October. <br /></td></tr>
<tr class="separator:ade3afcfb9d11729b5bc7cd6bedc5c827"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a728f9b5419e5af3ac08a0dd10f70f897"><td class="memItemLeft" align="right" valign="top"><a id="a728f9b5419e5af3ac08a0dd10f70f897"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a728f9b5419e5af3ac08a0dd10f70f897">NOV</a> = 11</td></tr>
<tr class="memdesc:a728f9b5419e5af3ac08a0dd10f70f897"><td class="mdescLeft"> </td><td class="mdescRight">November. <br /></td></tr>
<tr class="separator:a728f9b5419e5af3ac08a0dd10f70f897"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaff82a154efd6d2a04ef6cc82c3fd687"><td class="memItemLeft" align="right" valign="top"><a id="aaff82a154efd6d2a04ef6cc82c3fd687"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#aaff82a154efd6d2a04ef6cc82c3fd687">DEC</a> = 12</td></tr>
<tr class="memdesc:aaff82a154efd6d2a04ef6cc82c3fd687"><td class="mdescLeft"> </td><td class="mdescRight">December. <br /></td></tr>
<tr class="separator:aaff82a154efd6d2a04ef6cc82c3fd687"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a062688be20b89970061bc7fb962de8b0"><td class="memItemLeft" align="right" valign="top">constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a062688be20b89970061bc7fb962de8b0">SUN</a> = 0</td></tr>
<tr class="memdesc:a062688be20b89970061bc7fb962de8b0"><td class="mdescLeft"> </td><td class="mdescRight">Days of week. <a href="#a062688be20b89970061bc7fb962de8b0">More...</a><br /></td></tr>
<tr class="separator:a062688be20b89970061bc7fb962de8b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c39b6a1e0394272b89c2f48d1f56069"><td class="memItemLeft" align="right" valign="top"><a id="a6c39b6a1e0394272b89c2f48d1f56069"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a6c39b6a1e0394272b89c2f48d1f56069">MON</a> = 1</td></tr>
<tr class="memdesc:a6c39b6a1e0394272b89c2f48d1f56069"><td class="mdescLeft"> </td><td class="mdescRight">Monday. <br /></td></tr>
<tr class="separator:a6c39b6a1e0394272b89c2f48d1f56069"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80055367f0523978ba29e29f8c6e5329"><td class="memItemLeft" align="right" valign="top"><a id="a80055367f0523978ba29e29f8c6e5329"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a80055367f0523978ba29e29f8c6e5329">TUE</a> = 2</td></tr>
<tr class="memdesc:a80055367f0523978ba29e29f8c6e5329"><td class="mdescLeft"> </td><td class="mdescRight">Tuesday. <br /></td></tr>
<tr class="separator:a80055367f0523978ba29e29f8c6e5329"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff5f7515e28454fb6953a7bcb4a4ce7d"><td class="memItemLeft" align="right" valign="top"><a id="aff5f7515e28454fb6953a7bcb4a4ce7d"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#aff5f7515e28454fb6953a7bcb4a4ce7d">WED</a> = 3</td></tr>
<tr class="memdesc:aff5f7515e28454fb6953a7bcb4a4ce7d"><td class="mdescLeft"> </td><td class="mdescRight">Wednesday. <br /></td></tr>
<tr class="separator:aff5f7515e28454fb6953a7bcb4a4ce7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac561b9a562233163a5318797502f65a0"><td class="memItemLeft" align="right" valign="top"><a id="ac561b9a562233163a5318797502f65a0"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#ac561b9a562233163a5318797502f65a0">THU</a> = 4</td></tr>
<tr class="memdesc:ac561b9a562233163a5318797502f65a0"><td class="mdescLeft"> </td><td class="mdescRight">Thursday. <br /></td></tr>
<tr class="separator:ac561b9a562233163a5318797502f65a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51deaa37bcf7f1b49fef5192b85dafdf"><td class="memItemLeft" align="right" valign="top"><a id="a51deaa37bcf7f1b49fef5192b85dafdf"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a51deaa37bcf7f1b49fef5192b85dafdf">FRI</a> = 5</td></tr>
<tr class="memdesc:a51deaa37bcf7f1b49fef5192b85dafdf"><td class="mdescLeft"> </td><td class="mdescRight">Friday. <br /></td></tr>
<tr class="separator:a51deaa37bcf7f1b49fef5192b85dafdf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a862c5791e1199cc135906c55c4828b5a"><td class="memItemLeft" align="right" valign="top"><a id="a862c5791e1199cc135906c55c4828b5a"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1TimerEventManager__2__0__0.html#a862c5791e1199cc135906c55c4828b5a">SAT</a> = 6</td></tr>
<tr class="memdesc:a862c5791e1199cc135906c55c4828b5a"><td class="mdescLeft"> </td><td class="mdescRight">Saturday. <br /></td></tr>
<tr class="separator:a862c5791e1199cc135906c55c4828b5a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>TimerEventManager interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa92644a272db3d76dad8d20721e9ffc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa92644a272db3d76dad8d20721e9ffc7">◆ </a></span>addTimerEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::TimerEventManager_2_0_0::addTimerEvent </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1Schedule.html">Schedule</a> </td>
<td class="paramname"><em>schedule</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out vector< string > </td>
<td class="paramname"><em>eventId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a new timer event. </p>
<p>The timer event id field is allocated automatically and returned in the timerEventId parameter.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">schedule</td><td>schedule for timer </td></tr>
<tr><td class="paramname">eventId</td><td>created event id </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR if OK </dd>
<dd>
ERR_INVALID_SCHEDULE if schedule is invalid </dd>
<dd>
ERR_CREATE_EVENT_ID_FAILED if generating the eventId failed </dd>
<dd>
ERR_MAX_TIMERS_CREATED if max timer count already created </dd></dl>
</div>
</div>
<a id="a57f58aaa3c79ef68e1fa25fb41ffee80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57f58aaa3c79ef68e1fa25fb41ffee80">◆ </a></span>deleteTimerEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::TimerEventManager_2_0_0::deleteTimerEvent </td>
<td>(</td>
<td class="paramtype">in vector< string > </td>
<td class="paramname"><em>eventId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a timer event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eventId</td><td>event id </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR if OK </dd>
<dd>
ERR_UNKNOWN_EVENT_ID if eventId is unknown </dd></dl>
</div>
</div>
<a id="a6b3d3339e0a9bbf49696291fcf48902c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b3d3339e0a9bbf49696291fcf48902c">◆ </a></span>modifyTimerEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::TimerEventManager_2_0_0::modifyTimerEvent </td>
<td>(</td>
<td class="paramtype">in vector< string > </td>
<td class="paramname"><em>eventId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1Schedule.html">Schedule</a> </td>
<td class="paramname"><em>schedule</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Modify a timer event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eventId</td><td>event id </td></tr>
<tr><td class="paramname">schedule</td><td>new schedule for timer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR if OK </dd>
<dd>
ERR_INVALID_SCHEDULE if schedule is invalid </dd>
<dd>
ERR_UNKNOWN_EVENT_ID if eventId is unknown </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0b07d5d6f30d3addb6521c52766eca40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b07d5d6f30d3addb6521c52766eca40">◆ </a></span>JAN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant int event::TimerEventManager_2_0_0::JAN = 1</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structevent_1_1TimerEventManager__2__0__0_1_1Schedule.html" title="Schedule structure. ">Schedule</a> defines and structures. </p>
<p>The goal of the following declarations is to express crontab entries in a structured way. Months January </p>
</div>
</div>
<a id="a4e9943cae9904bc1d965e8ef26dfb926"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e9943cae9904bc1d965e8ef26dfb926">◆ </a></span>NO_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant int event::TimerEventManager_2_0_0::NO_ERROR = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Error codes. </p>
<p>operation successful, no error </p>
</div>
</div>
<a id="a062688be20b89970061bc7fb962de8b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a062688be20b89970061bc7fb962de8b0">◆ </a></span>SUN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant int event::TimerEventManager_2_0_0::SUN = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Days of week. </p>
<p>Sunday </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="TimerEventManager_8idl_source.html">TimerEventManager.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|
