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
|
<!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: pdumodel::Unit_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="namespacepdumodel.html">pdumodel</a></li><li class="navelem"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html">Unit_2_0_1</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfacepdumodel_1_1Unit__2__0__1-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pdumodel::Unit_2_0_1 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Unit interface.
<a href="interfacepdumodel_1_1Unit__2__0__1.html#details">More...</a></p>
<p><code>import"<a class="el" href="Unit_8idl_source.html">Unit.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="structpdumodel_1_1Unit__2__0__1_1_1MetaData.html">MetaData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Unit metadata <a href="structpdumodel_1_1Unit__2__0__1_1_1MetaData.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="structpdumodel_1_1Unit__2__0__1_1_1Settings.html">Settings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Unit settings <a href="structpdumodel_1_1Unit__2__0__1_1_1Settings.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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a80d767d2b7b736032713a8c52abe8fe0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a80d767d2b7b736032713a8c52abe8fe0">Orientation</a> { <a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a80d767d2b7b736032713a8c52abe8fe0acf26e431e2931749503ce92242c51dcd">NORMAL</a>,
<a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a80d767d2b7b736032713a8c52abe8fe0a443d10dc7fc418550b0dc609995216d4">FLIPPED</a>
}</td></tr>
<tr class="memdesc:a80d767d2b7b736032713a8c52abe8fe0"><td class="mdescLeft"> </td><td class="mdescRight">Display orientation. <a href="interfacepdumodel_1_1Unit__2__0__1.html#a80d767d2b7b736032713a8c52abe8fe0">More...</a><br /></td></tr>
<tr class="separator:a80d767d2b7b736032713a8c52abe8fe0"><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:a256ede2ce08d33c9b59628b59848f474"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1Unit__2__0__1_1_1MetaData.html">MetaData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a256ede2ce08d33c9b59628b59848f474">getMetaData</a> ()</td></tr>
<tr class="memdesc:a256ede2ce08d33c9b59628b59848f474"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the unit metadata. <a href="#a256ede2ce08d33c9b59628b59848f474">More...</a><br /></td></tr>
<tr class="separator:a256ede2ce08d33c9b59628b59848f474"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5061f813892ae35e29ce96cc837ca4b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1Unit__2__0__1_1_1Settings.html">Settings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a5061f813892ae35e29ce96cc837ca4b2">getSettings</a> ()</td></tr>
<tr class="memdesc:a5061f813892ae35e29ce96cc837ca4b2"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the unit settings. <a href="#a5061f813892ae35e29ce96cc837ca4b2">More...</a><br /></td></tr>
<tr class="separator:a5061f813892ae35e29ce96cc837ca4b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6586a025eabc0d60698cccb707c6f053"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a6586a025eabc0d60698cccb707c6f053">setSettings</a> (in <a class="el" href="structpdumodel_1_1Unit__2__0__1_1_1Settings.html">Settings</a> settings)</td></tr>
<tr class="memdesc:a6586a025eabc0d60698cccb707c6f053"><td class="mdescLeft"> </td><td class="mdescRight">Change the unit settings. <a href="#a6586a025eabc0d60698cccb707c6f053">More...</a><br /></td></tr>
<tr class="separator:a6586a025eabc0d60698cccb707c6f053"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a335e266dc83b409e22226b866a78dd5f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a335e266dc83b409e22226b866a78dd5f">identify</a> (in int seconds)</td></tr>
<tr class="memdesc:a335e266dc83b409e22226b866a78dd5f"><td class="mdescLeft"> </td><td class="mdescRight">Display something distictive to identify the unit. <a href="#a335e266dc83b409e22226b866a78dd5f">More...</a><br /></td></tr>
<tr class="separator:a335e266dc83b409e22226b866a78dd5f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c7138fce439ad39b3bd9b89ce58c62e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a6c7138fce439ad39b3bd9b89ce58c62e">muteBuzzer</a> (in boolean mute)</td></tr>
<tr class="memdesc:a6c7138fce439ad39b3bd9b89ce58c62e"><td class="mdescLeft"> </td><td class="mdescRight">Mute buzzer, turn of all audible alarms. <a href="#a6c7138fce439ad39b3bd9b89ce58c62e">More...</a><br /></td></tr>
<tr class="separator:a6c7138fce439ad39b3bd9b89ce58c62e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa013941f3085aab0e01304e7db15da54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a80d767d2b7b736032713a8c52abe8fe0">Orientation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#aa013941f3085aab0e01304e7db15da54">getDisplayOrientation</a> ()</td></tr>
<tr class="memdesc:aa013941f3085aab0e01304e7db15da54"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the current orientation of the display. <a href="#aa013941f3085aab0e01304e7db15da54">More...</a><br /></td></tr>
<tr class="separator:aa013941f3085aab0e01304e7db15da54"><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:a64afeca6d8f20c9113a11592ddb3ef7e"><td class="memItemLeft" align="right" valign="top"><a id="a64afeca6d8f20c9113a11592ddb3ef7e"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a64afeca6d8f20c9113a11592ddb3ef7e">ERR_INVALID_PARAM</a> = 1</td></tr>
<tr class="memdesc:a64afeca6d8f20c9113a11592ddb3ef7e"><td class="mdescLeft"> </td><td class="mdescRight">Invalid parameters. <br /></td></tr>
<tr class="separator:a64afeca6d8f20c9113a11592ddb3ef7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a453efc86f15f3d9ae12974e1a4b00965"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a453efc86f15f3d9ae12974e1a4b00965">IdentificationStartedEvent</a>: <a class="el" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">event::UserEvent</a> { int duration</td></tr>
<tr class="memdesc:a453efc86f15f3d9ae12974e1a4b00965"><td class="mdescLeft"> </td><td class="mdescRight">Event: Unit identification requested. <a href="#a453efc86f15f3d9ae12974e1a4b00965">More...</a><br /></td></tr>
<tr class="separator:a453efc86f15f3d9ae12974e1a4b00965"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Unit interface. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a80d767d2b7b736032713a8c52abe8fe0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80d767d2b7b736032713a8c52abe8fe0">◆ </a></span>Orientation</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a80d767d2b7b736032713a8c52abe8fe0">pdumodel::Unit_2_0_1::Orientation</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Display orientation. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a80d767d2b7b736032713a8c52abe8fe0acf26e431e2931749503ce92242c51dcd"></a>NORMAL </td><td class="fielddoc"><p>Normal orientation. </p>
</td></tr>
<tr><td class="fieldname"><a id="a80d767d2b7b736032713a8c52abe8fe0a443d10dc7fc418550b0dc609995216d4"></a>FLIPPED </td><td class="fielddoc"><p>Upside-down. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa013941f3085aab0e01304e7db15da54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa013941f3085aab0e01304e7db15da54">◆ </a></span>getDisplayOrientation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfacepdumodel_1_1Unit__2__0__1.html#a80d767d2b7b736032713a8c52abe8fe0">Orientation</a> pdumodel::Unit_2_0_1::getDisplayOrientation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the current orientation of the display. </p>
<dl class="section return"><dt>Returns</dt><dd>Display orientation. </dd></dl>
</div>
</div>
<a id="a256ede2ce08d33c9b59628b59848f474"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a256ede2ce08d33c9b59628b59848f474">◆ </a></span>getMetaData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1Unit__2__0__1_1_1MetaData.html">MetaData</a> pdumodel::Unit_2_0_1::getMetaData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the unit metadata. </p>
<dl class="section return"><dt>Returns</dt><dd>Unit metadata </dd></dl>
</div>
</div>
<a id="a5061f813892ae35e29ce96cc837ca4b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5061f813892ae35e29ce96cc837ca4b2">◆ </a></span>getSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1Unit__2__0__1_1_1Settings.html">Settings</a> pdumodel::Unit_2_0_1::getSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the unit settings. </p>
<dl class="section return"><dt>Returns</dt><dd>Unit settings </dd></dl>
</div>
</div>
<a id="a335e266dc83b409e22226b866a78dd5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a335e266dc83b409e22226b866a78dd5f">◆ </a></span>identify()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pdumodel::Unit_2_0_1::identify </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>seconds</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Display something distictive to identify the unit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seconds</td><td>Number of seconds to display the identify string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6c7138fce439ad39b3bd9b89ce58c62e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c7138fce439ad39b3bd9b89ce58c62e">◆ </a></span>muteBuzzer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pdumodel::Unit_2_0_1::muteBuzzer </td>
<td>(</td>
<td class="paramtype">in boolean </td>
<td class="paramname"><em>mute</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mute buzzer, turn of all audible alarms. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mute</td><td><code>true</code> to mute buzzer, <code>false</code> for normal mode </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6586a025eabc0d60698cccb707c6f053"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6586a025eabc0d60698cccb707c6f053">◆ </a></span>setSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pdumodel::Unit_2_0_1::setSettings </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structpdumodel_1_1Unit__2__0__1_1_1Settings.html">Settings</a> </td>
<td class="paramname"><em>settings</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the unit settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>New unit settings</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
ERR_INVALID_PARAM if any parameters are invalid </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a453efc86f15f3d9ae12974e1a4b00965"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a453efc86f15f3d9ae12974e1a4b00965">◆ </a></span>IdentificationStartedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject pdumodel::Unit_2_0_1::IdentificationStartedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event: Unit identification requested. </p>
<p>Number of seconds the identification should be displayed </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="Unit_8idl_source.html">Unit.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>
|
