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
|
<!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::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 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_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__2__0__4.html" title="Inlet interface " alt="pdumodel::Inlet_2_0_4" shape="rect" coords="0,56,238,80"/>
<area href="interfacepdumodel_1_1Outlet__2__1__5.html" title="Outlet interface " alt="pdumodel::Outlet_2_1_5" shape="rect" coords="248,56,486,80"/>
<area href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html" title="Overcurrent protector interface. " alt="pdumodel::OverCurrentProtector_3_0_4" shape="rect" coords="496,56,734,80"/>
<area href="interfacepdumodel_1_1TransferSwitch__4__0__4.html" title="Transfer switch interface. " alt="pdumodel::TransferSwitch_4_0_4" shape="rect" coords="744,56,982,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="#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="#a2542c31d0989a203a3c3262e38f17af8">More...</a><br /></td></tr>
<tr class="separator:a2542c31d0989a203a3c3262e38f17af8"><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, such as inlets, OCPs and outlets. ">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, such as inlets, OCPs and outlets. ">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>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<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 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>
|
