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
|
<!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: pdumodel::PowerMeterController 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="namespacepdumodel.html">pdumodel</a></li><li class="navelem"><a class="el" href="interfacepdumodel_1_1PowerMeterController.html">PowerMeterController</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="interfacepdumodel_1_1PowerMeterController-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pdumodel::PowerMeterController Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Power Meter <a class="el" href="interfacepdumodel_1_1Controller.html" title="Sub controller interface.">Controller</a> (PMC) interface.
<a href="interfacepdumodel_1_1PowerMeterController.html#details">More...</a></p>
<p><code>import"<a class="el" href="PowerMeterController_8idl_source.html">PowerMeterController.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_1PowerMeterController_1_1PanelCreatedEvent.html">PanelCreatedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: A panel was created. <a href="structpdumodel_1_1PowerMeterController_1_1PanelCreatedEvent.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_1PowerMeterController_1_1PanelDeletedEvent.html">PanelDeletedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event:: A panel was deleted. <a href="structpdumodel_1_1PowerMeterController_1_1PanelDeletedEvent.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_1PowerMeterController_1_1PowerMeterCreatedEvent.html">PowerMeterCreatedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: A power meter or panel was created. <a href="structpdumodel_1_1PowerMeterController_1_1PowerMeterCreatedEvent.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_1PowerMeterController_1_1PowerMeterDeletedEvent.html">PowerMeterDeletedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: A power meter was deleted. <a href="structpdumodel_1_1PowerMeterController_1_1PowerMeterDeletedEvent.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_1PowerMeterController_1_1ScanResult.html">ScanResult</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Meter board scan result. <a href="structpdumodel_1_1PowerMeterController_1_1ScanResult.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:a59bf91220ce6e809f18fe41860608c11"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeterController.html#a59bf91220ce6e809f18fe41860608c11">scanMeterBoard</a> (in int powerMeterId, out <a class="el" href="structpdumodel_1_1PowerMeterController_1_1ScanResult.html">ScanResult</a> result)</td></tr>
<tr class="memdesc:a59bf91220ce6e809f18fe41860608c11"><td class="mdescLeft"> </td><td class="mdescRight">Scan for presence and configuration of a meter board. <a href="interfacepdumodel_1_1PowerMeterController.html#a59bf91220ce6e809f18fe41860608c11">More...</a><br /></td></tr>
<tr class="separator:a59bf91220ce6e809f18fe41860608c11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1f30391ee9c313c1cdc97babe449b28"><td class="memItemLeft" align="right" valign="top">map< int, <a class="el" href="interfacepdumodel_1_1PowerMeter.html">PowerMeter</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeterController.html#ac1f30391ee9c313c1cdc97babe449b28">getPowerMeters</a> ()</td></tr>
<tr class="memdesc:ac1f30391ee9c313c1cdc97babe449b28"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the list of power meters and panels. <a href="interfacepdumodel_1_1PowerMeterController.html#ac1f30391ee9c313c1cdc97babe449b28">More...</a><br /></td></tr>
<tr class="separator:ac1f30391ee9c313c1cdc97babe449b28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15d8eae14388dac59b62cf5c903daf06"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeterController.html#a15d8eae14388dac59b62cf5c903daf06">createPowerMeter</a> (out <a class="el" href="interfacepdumodel_1_1PowerMeter.html">PowerMeter</a> powerMeter, in <a class="el" href="structpdumodel_1_1PowerMeter_1_1Config.html">PowerMeter::Config</a> config, in <a class="el" href="structpdumodel_1_1PowerMeter_1_1Settings.html">PowerMeter::Settings</a> settings)</td></tr>
<tr class="memdesc:a15d8eae14388dac59b62cf5c903daf06"><td class="mdescLeft"> </td><td class="mdescRight">Create a new standalone power meter (no panel). <a href="interfacepdumodel_1_1PowerMeterController.html#a15d8eae14388dac59b62cf5c903daf06">More...</a><br /></td></tr>
<tr class="separator:a15d8eae14388dac59b62cf5c903daf06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ac99c0ad5054a23b2e9828dbce9f989"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeterController.html#a5ac99c0ad5054a23b2e9828dbce9f989">createPanel</a> (out <a class="el" href="interfacepdumodel_1_1Panel.html">Panel</a> panel, in <a class="el" href="structpdumodel_1_1PowerMeter_1_1Config.html">PowerMeter::Config</a> config, in <a class="el" href="structpdumodel_1_1PowerMeter_1_1Settings.html">PowerMeter::Settings</a> powerMeterSettings, in <a class="el" href="structpdumodel_1_1Panel_1_1PanelSettings.html">Panel::PanelSettings</a> panelSettings)</td></tr>
<tr class="memdesc:a5ac99c0ad5054a23b2e9828dbce9f989"><td class="mdescLeft"> </td><td class="mdescRight">Create a new panel. <a href="interfacepdumodel_1_1PowerMeterController.html#a5ac99c0ad5054a23b2e9828dbce9f989">More...</a><br /></td></tr>
<tr class="separator:a5ac99c0ad5054a23b2e9828dbce9f989"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abced7c3c2c9413ee78b9a04de1fc33b0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeterController.html#abced7c3c2c9413ee78b9a04de1fc33b0">deletePowerMeter</a> (in int powerMeterId)</td></tr>
<tr class="memdesc:abced7c3c2c9413ee78b9a04de1fc33b0"><td class="mdescLeft"> </td><td class="mdescRight">Delete a panel or power meter. <a href="interfacepdumodel_1_1PowerMeterController.html#abced7c3c2c9413ee78b9a04de1fc33b0">More...</a><br /></td></tr>
<tr class="separator:abced7c3c2c9413ee78b9a04de1fc33b0"><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:a33c8b1419cf1f108098e40bd4dc0d2e2"><td class="memItemLeft" align="right" valign="top"><a id="a33c8b1419cf1f108098e40bd4dc0d2e2"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeterController.html#a33c8b1419cf1f108098e40bd4dc0d2e2">ERR_INVALID_PARAM</a> = 1</td></tr>
<tr class="memdesc:a33c8b1419cf1f108098e40bd4dc0d2e2"><td class="mdescLeft"> </td><td class="mdescRight">Invalid parameters. <br /></td></tr>
<tr class="separator:a33c8b1419cf1f108098e40bd4dc0d2e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae141667140316224170d204d4140e08f"><td class="memItemLeft" align="right" valign="top"><a id="ae141667140316224170d204d4140e08f"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeterController.html#ae141667140316224170d204d4140e08f">ERR_METER_BOARD_BUSY</a> = 2</td></tr>
<tr class="memdesc:ae141667140316224170d204d4140e08f"><td class="mdescLeft"> </td><td class="mdescRight">A power meter with the given ID already exists. <br /></td></tr>
<tr class="separator:ae141667140316224170d204d4140e08f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Power Meter <a class="el" href="interfacepdumodel_1_1Controller.html" title="Sub controller interface.">Controller</a> (PMC) interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a5ac99c0ad5054a23b2e9828dbce9f989"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ac99c0ad5054a23b2e9828dbce9f989">◆ </a></span>createPanel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pdumodel::PowerMeterController::createPanel </td>
<td>(</td>
<td class="paramtype">out <a class="el" href="interfacepdumodel_1_1Panel.html">Panel</a> </td>
<td class="paramname"><em>panel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structpdumodel_1_1PowerMeter_1_1Config.html">PowerMeter::Config</a> </td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structpdumodel_1_1PowerMeter_1_1Settings.html">PowerMeter::Settings</a> </td>
<td class="paramname"><em>powerMeterSettings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structpdumodel_1_1Panel_1_1PanelSettings.html">Panel::PanelSettings</a> </td>
<td class="paramname"><em>panelSettings</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new panel. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">panel</td><td>Result: Newly created instance </td></tr>
<tr><td class="paramname">config</td><td>New power meter config </td></tr>
<tr><td class="paramname">powerMeterSettings</td><td>Power meter settings </td></tr>
<tr><td class="paramname">panelSettings</td><td><a class="el" href="interfacepdumodel_1_1Panel.html" title="PMC panel.">Panel</a> settings</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if any parameters are invalid </dd>
<dd>
2 if a power meter with the given ID already exists </dd></dl>
</div>
</div>
<a id="a15d8eae14388dac59b62cf5c903daf06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15d8eae14388dac59b62cf5c903daf06">◆ </a></span>createPowerMeter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pdumodel::PowerMeterController::createPowerMeter </td>
<td>(</td>
<td class="paramtype">out <a class="el" href="interfacepdumodel_1_1PowerMeter.html">PowerMeter</a> </td>
<td class="paramname"><em>powerMeter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structpdumodel_1_1PowerMeter_1_1Config.html">PowerMeter::Config</a> </td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structpdumodel_1_1PowerMeter_1_1Settings.html">PowerMeter::Settings</a> </td>
<td class="paramname"><em>settings</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new standalone power meter (no panel). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">powerMeter</td><td>Result: Newly created instance </td></tr>
<tr><td class="paramname">config</td><td>New power meter config </td></tr>
<tr><td class="paramname">settings</td><td>Power meter settings</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if any parameters are invalid </dd>
<dd>
2 if a power meter with the given ID already exists </dd></dl>
</div>
</div>
<a id="abced7c3c2c9413ee78b9a04de1fc33b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abced7c3c2c9413ee78b9a04de1fc33b0">◆ </a></span>deletePowerMeter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pdumodel::PowerMeterController::deletePowerMeter </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>powerMeterId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a panel or power meter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">powerMeterId</td><td>Power meter ID</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the power meter ID is invalid </dd></dl>
</div>
</div>
<a id="ac1f30391ee9c313c1cdc97babe449b28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1f30391ee9c313c1cdc97babe449b28">◆ </a></span>getPowerMeters()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">map<int, <a class="el" href="interfacepdumodel_1_1PowerMeter.html">PowerMeter</a>> pdumodel::PowerMeterController::getPowerMeters </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the list of power meters and panels. </p>
<dl class="section return"><dt>Returns</dt><dd>Power meter and panel instances, indexed by power meter ID </dd></dl>
</div>
</div>
<a id="a59bf91220ce6e809f18fe41860608c11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59bf91220ce6e809f18fe41860608c11">◆ </a></span>scanMeterBoard()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pdumodel::PowerMeterController::scanMeterBoard </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>powerMeterId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out <a class="el" href="structpdumodel_1_1PowerMeterController_1_1ScanResult.html">ScanResult</a> </td>
<td class="paramname"><em>result</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Scan for presence and configuration of a meter board. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">powerMeterId</td><td>ID of meter board to be scanned </td></tr>
<tr><td class="paramname">result</td><td>Detected meter board properties</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the meter board ID is out of range </dd></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="PowerMeterController_8idl_source.html">PowerMeterController.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>
|
