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
|
<!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>Raritan / Server Technology Xerus™ PDU JSON-RPC API: event::AlarmManager 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 / Server Technology Xerus™ PDU JSON-RPC API
</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="namespaceevent.html">event</a></li><li class="navelem"><a class="el" href="interfaceevent_1_1AlarmManager.html">AlarmManager</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_1AlarmManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">event::AlarmManager Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="interfaceevent_1_1AlarmManager.html" title="AlarmManager interface.">AlarmManager</a> interface.
<a href="interfaceevent_1_1AlarmManager.html#details">More...</a></p>
<p><code>import"<a class="el" href="AlarmManager_8idl_source.html">AlarmManager.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_1AlarmManager_1_1Alarm.html">Alarm</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1AlarmManager_1_1Alarm.html" title="Alarm structure.">Alarm</a> structure. <a href="structevent_1_1AlarmManager_1_1Alarm.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_1AlarmManager_1_1AlarmAcknowledgedEvent.html">AlarmAcknowledgedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Existing alarm acknowledgement event. <a href="structevent_1_1AlarmManager_1_1AlarmAcknowledgedEvent.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_1AlarmManager_1_1AlarmAddedEvent.html">AlarmAddedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">New alarm added event. <a href="structevent_1_1AlarmManager_1_1AlarmAddedEvent.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_1AlarmManager_1_1AlarmUpdatedEvent.html">AlarmUpdatedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1AlarmManager_1_1Alarm.html" title="Alarm structure.">Alarm</a> updated event. <a href="structevent_1_1AlarmManager_1_1AlarmUpdatedEvent.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_1AlarmManager_1_1Alert.html">Alert</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1AlarmManager_1_1Alert.html" title="Alert structure.">Alert</a> structure. <a href="structevent_1_1AlarmManager_1_1Alert.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:a9899b3680c96cd15e2388b867b442736"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1AlarmManager.html#a9899b3680c96cd15e2388b867b442736">acknowledgeAlarm</a> (in string alarmId)</td></tr>
<tr class="memdesc:a9899b3680c96cd15e2388b867b442736"><td class="mdescLeft"> </td><td class="mdescRight">Acknowledges an alarm. <a href="interfaceevent_1_1AlarmManager.html#a9899b3680c96cd15e2388b867b442736">More...</a><br /></td></tr>
<tr class="separator:a9899b3680c96cd15e2388b867b442736"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a094476746ad026dd347f7bc62ca6fcf8"><td class="memItemLeft" align="right" valign="top"><a id="a094476746ad026dd347f7bc62ca6fcf8"></a>
vector< <a class="el" href="structevent_1_1AlarmManager_1_1Alarm.html">Alarm</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1AlarmManager.html#a094476746ad026dd347f7bc62ca6fcf8">listAlarms</a> ()</td></tr>
<tr class="memdesc:a094476746ad026dd347f7bc62ca6fcf8"><td class="mdescLeft"> </td><td class="mdescRight">List alarms that need to be acknowledged. <br /></td></tr>
<tr class="separator:a094476746ad026dd347f7bc62ca6fcf8"><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:aad08bdb70f1581a790da41b1fb4c42b2"><td class="memItemLeft" align="right" valign="top">constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1AlarmManager.html#aad08bdb70f1581a790da41b1fb4c42b2">NO_ERROR</a> = 0</td></tr>
<tr class="memdesc:aad08bdb70f1581a790da41b1fb4c42b2"><td class="mdescLeft"> </td><td class="mdescRight">Error codes. <a href="interfaceevent_1_1AlarmManager.html#aad08bdb70f1581a790da41b1fb4c42b2">More...</a><br /></td></tr>
<tr class="separator:aad08bdb70f1581a790da41b1fb4c42b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1f22e2d3b2a2364f80059cbf70660b7"><td class="memItemLeft" align="right" valign="top"><a id="ac1f22e2d3b2a2364f80059cbf70660b7"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1AlarmManager.html#ac1f22e2d3b2a2364f80059cbf70660b7">ERR_UNKNOWN_ALARM_ID</a> = 1</td></tr>
<tr class="memdesc:ac1f22e2d3b2a2364f80059cbf70660b7"><td class="mdescLeft"> </td><td class="mdescRight">unknown alarmId <br /></td></tr>
<tr class="separator:ac1f22e2d3b2a2364f80059cbf70660b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c9b200a288ae7b13c11238296388f4f"><td class="memItemLeft" align="right" valign="top"><a id="a9c9b200a288ae7b13c11238296388f4f"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceevent_1_1AlarmManager.html#a9c9b200a288ae7b13c11238296388f4f">ERR_EXECUTING_ACTIONS</a> = 2</td></tr>
<tr class="memdesc:a9c9b200a288ae7b13c11238296388f4f"><td class="mdescLeft"> </td><td class="mdescRight">failure during executing actions <br /></td></tr>
<tr class="separator:a9c9b200a288ae7b13c11238296388f4f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="interfaceevent_1_1AlarmManager.html" title="AlarmManager interface.">AlarmManager</a> interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9899b3680c96cd15e2388b867b442736"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9899b3680c96cd15e2388b867b442736">◆ </a></span>acknowledgeAlarm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int event::AlarmManager::acknowledgeAlarm </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>alarmId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Acknowledges an alarm. </p>
<p>This stops notification sending and will remove the specified alarm from the alarm list.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">alarmId</td><td>alarm id </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR if OK </dd>
<dd>
ERR_UNKNOWN_ALARM_ID if alarmId is unknown </dd>
<dd>
ERR_EXECUTING_ACTIONS if failure during executing acknowledgment actions </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aad08bdb70f1581a790da41b1fb4c42b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad08bdb70f1581a790da41b1fb4c42b2">◆ </a></span>NO_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant int event::AlarmManager::NO_ERROR = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Error codes. </p>
<p>operation successful, no error </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="AlarmManager_8idl_source.html">AlarmManager.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 17 2022 00:25:44 for Raritan / Server Technology Xerus™ PDU JSON-RPC API 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>
|
