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
|
<!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: pdu-json-rpc-api/idl/Circuit.idl Source File</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="dir_6f2e57e4ed4c9ccdca310d1229964312.html">pdu-json-rpc-api</a></li><li class="navelem"><a class="el" href="dir_8ea0db9e05c169824aafe6441489b6ed.html">idl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Circuit.idl</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* SPDX-License-Identifier: BSD-3-Clause */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2015 Raritan Inc. All rights reserved.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef __PDUMODEL_CIRCUIT_IDL__</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define __PDUMODEL_CIRCUIT_IDL__</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <NumericSensor.idl></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <Pole.idl></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <UserEvent.idl></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/**</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * PDU Model</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> module <a class="code" href="namespacepdumodel.html">pdumodel</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> /**</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * BCM circuit</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Circuit__1__0__3.html"> 21</a></span>  <span class="keyword">interface </span><a class="code" href="interfacepdumodel_1_1Circuit__1__0__3.html">Circuit_1_0_3</a> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Circuit__1__0__3.html#a296a68a406299d53c2c590e659a482a9"> 23</a></span>  constant <span class="keywordtype">int</span> ERR_INVALID_PARAM = 1; <span class="comment">///< Invalid parameters</span></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Circuit__1__0__3.html#a8ca7f1ac85d1b4c6971397ad5f32369d"> 24</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_METER_CHANNEL_BUSY = 2; <span class="comment">///< Meter channel already in use</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> /** Circuit type */</span></div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249"> 27</a></span>  enumeration <a class="code" href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249">Type</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249a7c362114a0a219a4d966035355526fde"> 28</a></span>  <a class="code" href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249a7c362114a0a219a4d966035355526fde">ONE_PHASE_LN</a>, <span class="comment">///< One-phase line-neutral</span></div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249afe11ada2f88f041af3ee7965c29cfc43"> 29</a></span> <span class="comment"></span> <a class="code" href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249afe11ada2f88f041af3ee7965c29cfc43">ONE_PHASE_LL</a>, <span class="comment">///< One-phase line-line</span></div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249a99d903028050919897c84dcc0983880d"> 30</a></span> <span class="comment"></span> <a class="code" href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249a99d903028050919897c84dcc0983880d">ONE_PHASE_LLN</a>, <span class="comment">///< One-phase line-line-neutral</span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249a7a949b8f07d18d630c190ceb424f2f11"> 31</a></span> <span class="comment"></span> THREE_PHASE <span class="comment">///< Three-phase</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span> };</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /** Circuit configuration */</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Config.html"> 35</a></span>  structure <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Config.html">Config</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Config.html#ac3b27561ef2d24c13f5b14dd1bcb6733"> 36</a></span>  <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Config.html#ac3b27561ef2d24c13f5b14dd1bcb6733">position</a>; <span class="comment">///< Circuit position of first pole</span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Config.html#ad80216e4c2a4aefccfd40dfc69e92435"> 37</a></span> <span class="comment"></span> <a class="code" href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249">Type</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Config.html#ad80216e4c2a4aefccfd40dfc69e92435">type</a>; <span class="comment">///< Circuit type</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span> };</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> /**</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * Retrieve the circuit configuration.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> *</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @return Circuit configuration</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> */</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Config.html">Config</a> getConfig();</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /** Circuit sensors */</span></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html"> 48</a></span>  structure <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html">Sensors</a> {</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#add3264ea7248f35ca25d835f619c7c6c"> 49</a></span>  <a class="code" href="namespacesensors.html">sensors</a>.<a class="code" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#add3264ea7248f35ca25d835f619c7c6c">current</a>; <span class="comment">///< RMS current sensor</span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#ae006b2f6458aa96880cf4497754ff0b1"> 50</a></span> <span class="comment"></span> <a class="code" href="namespacesensors.html">sensors</a>.<a class="code" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#ae006b2f6458aa96880cf4497754ff0b1">activePower</a>; <span class="comment">///< Active power sensor</span></div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#acb205595b3bc4cc8e0bbe78983efb4a3"> 51</a></span> <span class="comment"></span> <a class="code" href="namespacesensors.html">sensors</a>.<a class="code" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#acb205595b3bc4cc8e0bbe78983efb4a3">reactivePower</a>; <span class="comment">///< Reactive power sensor</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a096598f4725b89ea02a86cf006ade635"> 52</a></span> <span class="comment"></span> <a class="code" href="namespacesensors.html">sensors</a>.<a class="code" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a096598f4725b89ea02a86cf006ade635">apparentPower</a>; <span class="comment">///< Apparent power sensor</span></div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a02aada213cf83a84a2605e4a63bba2c2"> 53</a></span> <span class="comment"></span> <a class="code" href="namespacesensors.html">sensors</a>.<a class="code" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a02aada213cf83a84a2605e4a63bba2c2">powerFactor</a>; <span class="comment">///< Power factor sensor</span></div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a672e8f1a3c934118df5480f08b0907d8"> 54</a></span> <span class="comment"></span> <a class="code" href="namespacesensors.html">sensors</a>.<a class="code" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a672e8f1a3c934118df5480f08b0907d8">phaseAngle</a>; <span class="comment">///< Phase angle sensor</span></div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a31acf52b3527a27abb608e3d65b6bfcc"> 55</a></span> <span class="comment"></span> <a class="code" href="namespacesensors.html">sensors</a>.<a class="code" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a31acf52b3527a27abb608e3d65b6bfcc">displacementPowerFactor</a>; <span class="comment">///< Displacement power factor</span></div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a519c4ed5213db5edd959a709f3b8c63c"> 56</a></span> <span class="comment"></span> <a class="code" href="namespacesensors.html">sensors</a>.<a class="code" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a519c4ed5213db5edd959a709f3b8c63c">activeEnergy</a>; <span class="comment">///< Active energy sensor</span></div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a01a328bff0d3871c4249445959b42533"> 57</a></span> <span class="comment"></span> <a class="code" href="namespacesensors.html">sensors</a>.<a class="code" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a01a328bff0d3871c4249445959b42533">unbalancedCurrent</a>; <span class="comment">///< Current unbalance sensor</span></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a1c4f079a888f73b60dc34bef9ae96551"> 58</a></span> <span class="comment"></span> <a class="code" href="namespacesensors.html">sensors</a>.<a class="code" href="interfacesensors_1_1NumericSensor__4__0__3.html">NumericSensor_4_0_3</a> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a1c4f079a888f73b60dc34bef9ae96551">crestFactor</a>; <span class="comment">///< Crest factor sensor</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> };</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /**</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * Retrieve the circuit sensors.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> *</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @return Circuit sensors</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> */</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html">Sensors</a> getSensors();</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> /**</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * Retrieve the list of circuit poles.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> *</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @return List of circuit poles</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> */</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  vector<Pole_5_0_0> getPoles();</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /** Circuit pole settings */</span></div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings.html"> 76</a></span>  structure <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings.html">PoleSettings</a> {</div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings.html#a884e1384df05117de06c4742087064c8"> 77</a></span>  <a class="code" href="namespacepdumodel.html">pdumodel</a>.PowerLine_2_0_0 <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings.html#a884e1384df05117de06c4742087064c8">line</a>; <span class="comment">///< Power line</span></div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings.html#af6d3b7b5e503a2308d9388bdfb622260"> 78</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings.html#af6d3b7b5e503a2308d9388bdfb622260">meterChannel</a>; <span class="comment">///< Meter channel index; -1 for unmetered poles</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span> };</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"></span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /** Circuit settings */</span></div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html"> 82</a></span>  structure <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html">Settings</a> {</div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a6c93151cfe254e94c29a195b4c770998"> 83</a></span>  <span class="keywordtype">string</span> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a6c93151cfe254e94c29a195b4c770998">name</a>; <span class="comment">///< Circuit name</span></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a1883a3263d3d3e1c91b5e3bba95bc885"> 84</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a1883a3263d3d3e1c91b5e3bba95bc885">rating</a>; <span class="comment">///< Circuit current rating</span></div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a0c26108596e8697fa27eae4b1dac4b29"> 85</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a0c26108596e8697fa27eae4b1dac4b29">ctRating</a>; <span class="comment">///< Current transformer rating</span></div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a5809bdaf9935a33dadff24186f0d538a"> 86</a></span> <span class="comment"></span> vector<PoleSettings> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a5809bdaf9935a33dadff24186f0d538a">poleSettings</a>; <span class="comment">///< Pole settings (excluding Neutral)</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span> };</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> /** Event: Circuit settings have changed */</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  valueobject SettingsChangedEvent extends <span class="keyword">event</span>.UserEvent {</div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Circuit__1__0__3.html#adf20c3f1b76357f59504267c3b4b2c08"> 91</a></span>  <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html">Settings</a> oldSettings; <span class="comment">///< Settings before change</span></div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Circuit__1__0__3.html#a23ea8b6b12aa364e3e21309284196cf2"> 92</a></span> <span class="comment"></span> <a class="code" href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html">Settings</a> <a class="code" href="interfacepdumodel_1_1Circuit__1__0__3.html#a23ea8b6b12aa364e3e21309284196cf2">newSettings</a>; <span class="comment">///< Settings after change</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span> };</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> /**</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * Get the circuit settings.</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> *</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @return Circuit settings</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  Settings getSettings();</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /**</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * Change the circuit settings.</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> *</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @param settings New circuit settings</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> *</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @return 1 if any parameters are invalid</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @return 2 if the requested meter channel is already in used</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> */</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">int</span> setSettings(in Settings settings);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  };</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> }</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html_ae006b2f6458aa96880cf4497754ff0b1"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#ae006b2f6458aa96880cf4497754ff0b1">pdumodel::Circuit_1_0_3::Sensors::activePower</a></div><div class="ttdeci">sensors::NumericSensor_4_0_3 activePower</div><div class="ttdoc">Active power sensor. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:50</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Config_html"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Config.html">pdumodel::Circuit_1_0_3::Config</a></div><div class="ttdoc">Circuit configuration. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:35</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html_a672e8f1a3c934118df5480f08b0907d8"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a672e8f1a3c934118df5480f08b0907d8">pdumodel::Circuit_1_0_3::Sensors::phaseAngle</a></div><div class="ttdeci">sensors::NumericSensor_4_0_3 phaseAngle</div><div class="ttdoc">Phase angle sensor. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:54</div></div>
<div class="ttc" id="interfacepdumodel_1_1Circuit__1__0__3_html_a23ea8b6b12aa364e3e21309284196cf2"><div class="ttname"><a href="interfacepdumodel_1_1Circuit__1__0__3.html#a23ea8b6b12aa364e3e21309284196cf2">pdumodel::Circuit_1_0_3::newSettings</a></div><div class="ttdeci">Settings newSettings</div><div class="ttdoc">Settings after change. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:92</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Settings_html"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html">pdumodel::Circuit_1_0_3::Settings</a></div><div class="ttdoc">Circuit settings. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:82</div></div>
<div class="ttc" id="interfacepdumodel_1_1Circuit__1__0__3_html"><div class="ttname"><a href="interfacepdumodel_1_1Circuit__1__0__3.html">pdumodel::Circuit_1_0_3</a></div><div class="ttdoc">BCM circuit. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:21</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html_a096598f4725b89ea02a86cf006ade635"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a096598f4725b89ea02a86cf006ade635">pdumodel::Circuit_1_0_3::Sensors::apparentPower</a></div><div class="ttdeci">sensors::NumericSensor_4_0_3 apparentPower</div><div class="ttdoc">Apparent power sensor. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:52</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html_a1c4f079a888f73b60dc34bef9ae96551"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a1c4f079a888f73b60dc34bef9ae96551">pdumodel::Circuit_1_0_3::Sensors::crestFactor</a></div><div class="ttdeci">sensors::NumericSensor_4_0_3 crestFactor</div><div class="ttdoc">Crest factor sensor. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:58</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html_a31acf52b3527a27abb608e3d65b6bfcc"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a31acf52b3527a27abb608e3d65b6bfcc">pdumodel::Circuit_1_0_3::Sensors::displacementPowerFactor</a></div><div class="ttdeci">sensors::NumericSensor_4_0_3 displacementPowerFactor</div><div class="ttdoc">Displacement power factor. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:55</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Settings_html_a6c93151cfe254e94c29a195b4c770998"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a6c93151cfe254e94c29a195b4c770998">pdumodel::Circuit_1_0_3::Settings::name</a></div><div class="ttdeci">string name</div><div class="ttdoc">Circuit name. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:83</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Config_html_ad80216e4c2a4aefccfd40dfc69e92435"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Config.html#ad80216e4c2a4aefccfd40dfc69e92435">pdumodel::Circuit_1_0_3::Config::type</a></div><div class="ttdeci">Type type</div><div class="ttdoc">Circuit type. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:37</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings_html_a884e1384df05117de06c4742087064c8"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings.html#a884e1384df05117de06c4742087064c8">pdumodel::Circuit_1_0_3::PoleSettings::line</a></div><div class="ttdeci">pdumodel::PowerLine_2_0_0 line</div><div class="ttdoc">Power line. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:77</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html_a01a328bff0d3871c4249445959b42533"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a01a328bff0d3871c4249445959b42533">pdumodel::Circuit_1_0_3::Sensors::unbalancedCurrent</a></div><div class="ttdeci">sensors::NumericSensor_4_0_3 unbalancedCurrent</div><div class="ttdoc">Current unbalance sensor. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:57</div></div>
<div class="ttc" id="interfacepdumodel_1_1Circuit__1__0__3_html_a443446e659b69935869db3626448f249a99d903028050919897c84dcc0983880d"><div class="ttname"><a href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249a99d903028050919897c84dcc0983880d">pdumodel::Circuit_1_0_3::ONE_PHASE_LLN</a></div><div class="ttdoc">One-phase line-line-neutral. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:30</div></div>
<div class="ttc" id="interfacepdumodel_1_1Circuit__1__0__3_html_a443446e659b69935869db3626448f249"><div class="ttname"><a href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249">pdumodel::Circuit_1_0_3::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">Circuit type. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:27</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html_a519c4ed5213db5edd959a709f3b8c63c"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a519c4ed5213db5edd959a709f3b8c63c">pdumodel::Circuit_1_0_3::Sensors::activeEnergy</a></div><div class="ttdeci">sensors::NumericSensor_4_0_3 activeEnergy</div><div class="ttdoc">Active energy sensor. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:56</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html_add3264ea7248f35ca25d835f619c7c6c"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#add3264ea7248f35ca25d835f619c7c6c">pdumodel::Circuit_1_0_3::Sensors::current</a></div><div class="ttdeci">sensors::NumericSensor_4_0_3 current</div><div class="ttdoc">RMS current sensor. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:49</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html">pdumodel::Circuit_1_0_3::Sensors</a></div><div class="ttdoc">Circuit sensors. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:48</div></div>
<div class="ttc" id="namespacesensors_html"><div class="ttname"><a href="namespacesensors.html">sensors</a></div><div class="ttdoc">Sensors Model. </div><div class="ttdef"><b>Definition:</b> AccumulatingNumericSensor.idl:13</div></div>
<div class="ttc" id="namespacepdumodel_html"><div class="ttname"><a href="namespacepdumodel.html">pdumodel</a></div><div class="ttdoc">PDU Model. </div><div class="ttdef"><b>Definition:</b> Ade.idl:12</div></div>
<div class="ttc" id="interfacepdumodel_1_1Circuit__1__0__3_html_a443446e659b69935869db3626448f249a7c362114a0a219a4d966035355526fde"><div class="ttname"><a href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249a7c362114a0a219a4d966035355526fde">pdumodel::Circuit_1_0_3::ONE_PHASE_LN</a></div><div class="ttdoc">One-phase line-neutral. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:28</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Config_html_ac3b27561ef2d24c13f5b14dd1bcb6733"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Config.html#ac3b27561ef2d24c13f5b14dd1bcb6733">pdumodel::Circuit_1_0_3::Config::position</a></div><div class="ttdeci">int position</div><div class="ttdoc">Circuit position of first pole. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:36</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html_a02aada213cf83a84a2605e4a63bba2c2"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#a02aada213cf83a84a2605e4a63bba2c2">pdumodel::Circuit_1_0_3::Sensors::powerFactor</a></div><div class="ttdeci">sensors::NumericSensor_4_0_3 powerFactor</div><div class="ttdoc">Power factor sensor. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:53</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Settings_html_a1883a3263d3d3e1c91b5e3bba95bc885"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a1883a3263d3d3e1c91b5e3bba95bc885">pdumodel::Circuit_1_0_3::Settings::rating</a></div><div class="ttdeci">int rating</div><div class="ttdoc">Circuit current rating. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:84</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Settings_html_a0c26108596e8697fa27eae4b1dac4b29"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a0c26108596e8697fa27eae4b1dac4b29">pdumodel::Circuit_1_0_3::Settings::ctRating</a></div><div class="ttdeci">int ctRating</div><div class="ttdoc">Current transformer rating. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:85</div></div>
<div class="ttc" id="interfacesensors_1_1NumericSensor__4__0__3_html"><div class="ttname"><a href="interfacesensors_1_1NumericSensor__4__0__3.html">sensors::NumericSensor_4_0_3</a></div><div class="ttdoc">A sensor with numeric readings. </div><div class="ttdef"><b>Definition:</b> NumericSensor.idl:17</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings_html_af6d3b7b5e503a2308d9388bdfb622260"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings.html#af6d3b7b5e503a2308d9388bdfb622260">pdumodel::Circuit_1_0_3::PoleSettings::meterChannel</a></div><div class="ttdeci">int meterChannel</div><div class="ttdoc">Meter channel index; -1 for unmetered poles. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:78</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Settings_html_a5809bdaf9935a33dadff24186f0d538a"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Settings.html#a5809bdaf9935a33dadff24186f0d538a">pdumodel::Circuit_1_0_3::Settings::poleSettings</a></div><div class="ttdeci">vector< PoleSettings > poleSettings</div><div class="ttdoc">Pole settings (excluding Neutral) </div><div class="ttdef"><b>Definition:</b> Circuit.idl:86</div></div>
<div class="ttc" id="interfacepdumodel_1_1Circuit__1__0__3_html_a443446e659b69935869db3626448f249afe11ada2f88f041af3ee7965c29cfc43"><div class="ttname"><a href="interfacepdumodel_1_1Circuit__1__0__3.html#a443446e659b69935869db3626448f249afe11ada2f88f041af3ee7965c29cfc43">pdumodel::Circuit_1_0_3::ONE_PHASE_LL</a></div><div class="ttdoc">One-phase line-line. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:29</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings_html"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1PoleSettings.html">pdumodel::Circuit_1_0_3::PoleSettings</a></div><div class="ttdoc">Circuit pole settings. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:76</div></div>
<div class="ttc" id="structpdumodel_1_1Circuit__1__0__3_1_1Sensors_html_acb205595b3bc4cc8e0bbe78983efb4a3"><div class="ttname"><a href="structpdumodel_1_1Circuit__1__0__3_1_1Sensors.html#acb205595b3bc4cc8e0bbe78983efb4a3">pdumodel::Circuit_1_0_3::Sensors::reactivePower</a></div><div class="ttdeci">sensors::NumericSensor_4_0_3 reactivePower</div><div class="ttdoc">Reactive power sensor. </div><div class="ttdef"><b>Definition:</b> Circuit.idl:51</div></div>
</div><!-- fragment --></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>
|
