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
|
<!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: hmi::InternalBeeper_2_0_1 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="namespacehmi.html">hmi</a></li><li class="navelem"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html">InternalBeeper_2_0_1</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfacehmi_1_1InternalBeeper__2__0__1-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hmi::InternalBeeper_2_0_1 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Internal beeper interface.
<a href="interfacehmi_1_1InternalBeeper__2__0__1.html#details">More...</a></p>
<p><code>import"<a class="el" href="InternalBeeper_8idl_source.html">InternalBeeper.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac34fc219cab2112e86c323ad0a407e87"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87">State</a> { <a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87ad37b7fdbc4b7a9180f3a5d46130239a9">OFF</a>,
<a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87a87222916ec38505e5c31ef945ba56e8f">ON_NOTIFICATION</a>,
<a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87afca0899fdc112a585eabf74eea02e0f9">ON_ACTIVATION</a>
}</td></tr>
<tr class="memdesc:ac34fc219cab2112e86c323ad0a407e87"><td class="mdescLeft"> </td><td class="mdescRight">Activation state. <a href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87">More...</a><br /></td></tr>
<tr class="separator:ac34fc219cab2112e86c323ad0a407e87"><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:a3ee648589ca8db9e9addac296df2df4c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a3ee648589ca8db9e9addac296df2df4c">mute</a> (in boolean muted)</td></tr>
<tr class="memdesc:a3ee648589ca8db9e9addac296df2df4c"><td class="mdescLeft"> </td><td class="mdescRight">Mute beeper, turn off all internal alarm notifications. <a href="#a3ee648589ca8db9e9addac296df2df4c">More...</a><br /></td></tr>
<tr class="separator:a3ee648589ca8db9e9addac296df2df4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35d2613c4b673968eb83d7537522256a"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a35d2613c4b673968eb83d7537522256a">isMuted</a> ()</td></tr>
<tr class="memdesc:a35d2613c4b673968eb83d7537522256a"><td class="mdescLeft"> </td><td class="mdescRight">Check whether beeper is currently muted. <a href="#a35d2613c4b673968eb83d7537522256a">More...</a><br /></td></tr>
<tr class="separator:a35d2613c4b673968eb83d7537522256a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1c813a5a00c4cc9b781892240cd55d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#af1c813a5a00c4cc9b781892240cd55d8">activate</a> (in boolean on, in string <a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a0f50301e6bd3b17d58d7c0064ddda70d">reason</a>, in int timeout)</td></tr>
<tr class="memdesc:af1c813a5a00c4cc9b781892240cd55d8"><td class="mdescLeft"> </td><td class="mdescRight">Activate the beeper for a given time. <a href="#af1c813a5a00c4cc9b781892240cd55d8">More...</a><br /></td></tr>
<tr class="separator:af1c813a5a00c4cc9b781892240cd55d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d22ad8b6fdca163f7d38aae3d9a87fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87">State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a9d22ad8b6fdca163f7d38aae3d9a87fd">getState</a> (out string <a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a0f50301e6bd3b17d58d7c0064ddda70d">reason</a>, out boolean mutedTemporarily)</td></tr>
<tr class="memdesc:a9d22ad8b6fdca163f7d38aae3d9a87fd"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the current beeper activation state. <a href="#a9d22ad8b6fdca163f7d38aae3d9a87fd">More...</a><br /></td></tr>
<tr class="separator:a9d22ad8b6fdca163f7d38aae3d9a87fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3279a5674a8aa795b045dfd9d69f2937"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a3279a5674a8aa795b045dfd9d69f2937">muteCurrentActivation</a> ()</td></tr>
<tr class="memdesc:a3279a5674a8aa795b045dfd9d69f2937"><td class="mdescLeft"> </td><td class="mdescRight">Mute the beeper for the current activation. <a href="#a3279a5674a8aa795b045dfd9d69f2937">More...</a><br /></td></tr>
<tr class="separator:a3279a5674a8aa795b045dfd9d69f2937"><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:a7c1fadbad489106ee21e3ed7a7789661"><td class="memItemLeft" align="right" valign="top"><a id="a7c1fadbad489106ee21e3ed7a7789661"></a>
valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a7c1fadbad489106ee21e3ed7a7789661">MuteChangedEvent</a>: <a class="el" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">event::UserEvent</a> { boolean muted</td></tr>
<tr class="memdesc:a7c1fadbad489106ee21e3ed7a7789661"><td class="mdescLeft"> </td><td class="mdescRight">Event: The beeper has been muted or unmuted. <br /></td></tr>
<tr class="separator:a7c1fadbad489106ee21e3ed7a7789661"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80f19e586dc22a5b0417fd903d4c719c"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a80f19e586dc22a5b0417fd903d4c719c">StateChangedEvent</a>: <a class="el" href="namespaceidl.html#accbdf35b0c02d64ce223e912fc2b246f">idl::Event</a> { <a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87">State</a> state</td></tr>
<tr class="memdesc:a80f19e586dc22a5b0417fd903d4c719c"><td class="mdescLeft"> </td><td class="mdescRight">Event: The beeper activation status has changed. <a href="#a80f19e586dc22a5b0417fd903d4c719c">More...</a><br /></td></tr>
<tr class="separator:a80f19e586dc22a5b0417fd903d4c719c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f50301e6bd3b17d58d7c0064ddda70d"><td class="memItemLeft" align="right" valign="top"><a id="a0f50301e6bd3b17d58d7c0064ddda70d"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a0f50301e6bd3b17d58d7c0064ddda70d">reason</a></td></tr>
<tr class="memdesc:a0f50301e6bd3b17d58d7c0064ddda70d"><td class="mdescLeft"> </td><td class="mdescRight">Activation reason. <br /></td></tr>
<tr class="separator:a0f50301e6bd3b17d58d7c0064ddda70d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afdefe55ea79e674b8e584370163d2137"><td class="memItemLeft" align="right" valign="top"><a id="afdefe55ea79e674b8e584370163d2137"></a>
boolean </td><td class="memItemRight" valign="bottom"><b>mutedTemporarily</b></td></tr>
<tr class="separator:afdefe55ea79e674b8e584370163d2137"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Internal beeper interface. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ac34fc219cab2112e86c323ad0a407e87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac34fc219cab2112e86c323ad0a407e87">◆ </a></span>State</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87">hmi::InternalBeeper_2_0_1::State</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Activation state. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac34fc219cab2112e86c323ad0a407e87ad37b7fdbc4b7a9180f3a5d46130239a9"></a>OFF </td><td class="fielddoc"><p>Beeper is currently off. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac34fc219cab2112e86c323ad0a407e87a87222916ec38505e5c31ef945ba56e8f"></a>ON_NOTIFICATION </td><td class="fielddoc"><p>Beeper is currently active due to an internal alarm notification. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac34fc219cab2112e86c323ad0a407e87afca0899fdc112a585eabf74eea02e0f9"></a>ON_ACTIVATION </td><td class="fielddoc"><p>Beeper is currently active due to an external activation. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af1c813a5a00c4cc9b781892240cd55d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1c813a5a00c4cc9b781892240cd55d8">◆ </a></span>activate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hmi::InternalBeeper_2_0_1::activate </td>
<td>(</td>
<td class="paramtype">in boolean </td>
<td class="paramname"><em>on</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"><em>reason</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in int </td>
<td class="paramname"><em>timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Activate the beeper for a given time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">activate</td><td>Whether to turn on or off the beeper </td></tr>
<tr><td class="paramname">reason</td><td>Description of the reason to turn on the beeper (only valid whtn turning on the beeper) </td></tr>
<tr><td class="paramname">timeout</td><td>Activation timeout in milliseconds (only valid when turning on the beeper, 0 = infinite activation) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9d22ad8b6fdca163f7d38aae3d9a87fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d22ad8b6fdca163f7d38aae3d9a87fd">◆ </a></span>getState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87">State</a> hmi::InternalBeeper_2_0_1::getState </td>
<td>(</td>
<td class="paramtype">out string </td>
<td class="paramname"><em>reason</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out boolean </td>
<td class="paramname"><em>mutedTemporarily</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the current beeper activation state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reason</td><td>Return value for activation reason if the beeper is currently active </td></tr>
<tr><td class="paramname">mutedTemporarily</td><td>Whether the beeper is currently muted due to a call to <a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a3279a5674a8aa795b045dfd9d69f2937">muteCurrentActivation</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current beeper state </dd></dl>
</div>
</div>
<a id="a35d2613c4b673968eb83d7537522256a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35d2613c4b673968eb83d7537522256a">◆ </a></span>isMuted()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean hmi::InternalBeeper_2_0_1::isMuted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether beeper is currently muted. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if muted, <code>false</code> if not </dd></dl>
</div>
</div>
<a id="a3ee648589ca8db9e9addac296df2df4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ee648589ca8db9e9addac296df2df4c">◆ </a></span>mute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hmi::InternalBeeper_2_0_1::mute </td>
<td>(</td>
<td class="paramtype">in boolean </td>
<td class="paramname"><em>muted</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mute beeper, turn off all internal alarm notifications. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mute</td><td><code>true</code> to mute beeper, <code>false</code> for normal mode </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3279a5674a8aa795b045dfd9d69f2937"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3279a5674a8aa795b045dfd9d69f2937">◆ </a></span>muteCurrentActivation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hmi::InternalBeeper_2_0_1::muteCurrentActivation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mute the beeper for the current activation. </p>
<p>If the beeper is currently on, it will be turned off until another call to the <a class="el" href="interfacehmi_1_1InternalBeeper__2__0__1.html#af1c813a5a00c4cc9b781892240cd55d8">activate</a> method or until a new internal notification happens. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a80f19e586dc22a5b0417fd903d4c719c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80f19e586dc22a5b0417fd903d4c719c">◆ </a></span>StateChangedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject hmi::InternalBeeper_2_0_1::StateChangedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event: The beeper activation status has changed. </p>
<p>The current beeper state </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="InternalBeeper_8idl_source.html">InternalBeeper.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>
|
