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
|
<!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::EDevice 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_1EDevice.html">EDevice</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="interfacepdumodel_1_1EDevice-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pdumodel::EDevice Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Common base interface for any kind of electrical device that is used in the PDU model, such as inlets, OCPs and outlets.
<a href="interfacepdumodel_1_1EDevice.html#details">More...</a></p>
<p><code>import"<a class="el" href="EDevice_8idl_source.html">EDevice.idl</a>";</code></p>
<div class="dynheader">
Inheritance diagram for pdumodel::EDevice:</div>
<div class="dyncontent">
<div class="center">
<img src="interfacepdumodel_1_1EDevice.png" usemap="#pdumodel::EDevice_map" alt=""/>
<map id="pdumodel::EDevice_map" name="pdumodel::EDevice_map">
<area href="interfacepdumodel_1_1Inlet.html" title="Inlet interface" alt="pdumodel::Inlet" shape="rect" coords="0,56,196,80"/>
<area href="interfacepdumodel_1_1Outlet.html" title="Outlet interface" alt="pdumodel::Outlet" shape="rect" coords="206,56,402,80"/>
<area href="interfacepdumodel_1_1OverCurrentProtector.html" title="Overcurrent protector interface." alt="pdumodel::OverCurrentProtector" shape="rect" coords="412,56,608,80"/>
<area href="interfacepdumodel_1_1TransferSwitch.html" title="Transfer switch interface." alt="pdumodel::TransferSwitch" shape="rect" coords="618,56,814,80"/>
</map>
</div></div>
<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:a9f9025acd6973b6c1f401ea855b5d32d"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="interfacepdumodel_1_1EDevice.html">EDevice</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1EDevice.html#a9f9025acd6973b6c1f401ea855b5d32d">getParents</a> ()</td></tr>
<tr class="memdesc:a9f9025acd6973b6c1f401ea855b5d32d"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of devices that provide energy to this device. <a href="interfacepdumodel_1_1EDevice.html#a9f9025acd6973b6c1f401ea855b5d32d">More...</a><br /></td></tr>
<tr class="separator:a9f9025acd6973b6c1f401ea855b5d32d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2542c31d0989a203a3c3262e38f17af8"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="interfacepdumodel_1_1EDevice.html">EDevice</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1EDevice.html#a2542c31d0989a203a3c3262e38f17af8">getChildren</a> ()</td></tr>
<tr class="memdesc:a2542c31d0989a203a3c3262e38f17af8"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of devices that are directly fed by this device. <a href="interfacepdumodel_1_1EDevice.html#a2542c31d0989a203a3c3262e38f17af8">More...</a><br /></td></tr>
<tr class="separator:a2542c31d0989a203a3c3262e38f17af8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0e393dba318fe0862094131dc1d3aae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1Waveform.html">Waveform</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1EDevice.html#af0e393dba318fe0862094131dc1d3aae">getWaveform</a> ()</td></tr>
<tr class="memdesc:af0e393dba318fe0862094131dc1d3aae"><td class="mdescLeft"> </td><td class="mdescRight">Get the current voltage and current waveforms for this device. <a href="interfacepdumodel_1_1EDevice.html#af0e393dba318fe0862094131dc1d3aae">More...</a><br /></td></tr>
<tr class="separator:af0e393dba318fe0862094131dc1d3aae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d99f95f4417bccdc1266c2ca787abb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1Waveform.html">Waveform</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1EDevice.html#a7d99f95f4417bccdc1266c2ca787abb4">getPoleWaveform</a> (in <a class="el" href="namespacepdumodel.html#a08e231c1613085177db1d4dc694bd239">PowerLine</a> line)</td></tr>
<tr class="memdesc:a7d99f95f4417bccdc1266c2ca787abb4"><td class="mdescLeft"> </td><td class="mdescRight">Get the current voltage and current waveforms for a pole of this device. <a href="interfacepdumodel_1_1EDevice.html#a7d99f95f4417bccdc1266c2ca787abb4">More...</a><br /></td></tr>
<tr class="separator:a7d99f95f4417bccdc1266c2ca787abb4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Common base interface for any kind of electrical device that is used in the PDU model, such as inlets, OCPs and outlets. </p>
<p>EDevices form a hierarchy of parent-child relationships. An <a class="el" href="interfacepdumodel_1_1EDevice.html" title="Common base interface for any kind of electrical device that is used in the PDU model,...">EDevice</a> is defined to be the parent of another if it "provides energy" to the latter. E.g. an inlet could be the parent of a number of OCPs, wires or outlets.</p>
<p>An <a class="el" href="interfacepdumodel_1_1EDevice.html" title="Common base interface for any kind of electrical device that is used in the PDU model,...">EDevice</a> can have multiple parents, e.g. in case of transfer switches which select power from multiple sources. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2542c31d0989a203a3c3262e38f17af8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2542c31d0989a203a3c3262e38f17af8">◆ </a></span>getChildren()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="interfacepdumodel_1_1EDevice.html">EDevice</a>> pdumodel::EDevice::getChildren </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the list of devices that are directly fed by this device. </p>
<dl class="section return"><dt>Returns</dt><dd>List of child devices </dd></dl>
</div>
</div>
<a id="a9f9025acd6973b6c1f401ea855b5d32d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f9025acd6973b6c1f401ea855b5d32d">◆ </a></span>getParents()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="interfacepdumodel_1_1EDevice.html">EDevice</a>> pdumodel::EDevice::getParents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the list of devices that provide energy to this device. </p>
<dl class="section return"><dt>Returns</dt><dd>List of parent devices </dd></dl>
</div>
</div>
<a id="a7d99f95f4417bccdc1266c2ca787abb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d99f95f4417bccdc1266c2ca787abb4">◆ </a></span>getPoleWaveform()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1Waveform.html">Waveform</a> pdumodel::EDevice::getPoleWaveform </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="namespacepdumodel.html#a08e231c1613085177db1d4dc694bd239">PowerLine</a> </td>
<td class="paramname"><em>line</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current voltage and current waveforms for a pole of this device. </p>
<dl class="section note"><dt>Note</dt><dd>If waveform reading is not supported, an empty waveform is returned.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structpdumodel_1_1Waveform.html" title="Waveform data, including metadata.">Waveform</a> samples </dd></dl>
</div>
</div>
<a id="af0e393dba318fe0862094131dc1d3aae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0e393dba318fe0862094131dc1d3aae">◆ </a></span>getWaveform()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1Waveform.html">Waveform</a> pdumodel::EDevice::getWaveform </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current voltage and current waveforms for this device. </p>
<dl class="section note"><dt>Note</dt><dd>If waveform reading is not supported, an empty waveform is returned.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structpdumodel_1_1Waveform.html" title="Waveform data, including metadata.">Waveform</a> samples </dd></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="EDevice_8idl_source.html">EDevice.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>
|
