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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
|
<!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::PowerMeter_1_1_5 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_1PowerMeter__1__1__5.html">PowerMeter_1_1_5</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_1PowerMeter__1__1__5-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pdumodel::PowerMeter_1_1_5 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A three-phase power meter (PMC).
<a href="interfacepdumodel_1_1PowerMeter__1__1__5.html#details">More...</a></p>
<p><code>import"<a class="el" href="PowerMeter_8idl_source.html">PowerMeter.idl</a>";</code></p>
<div class="dynheader">
Inheritance diagram for pdumodel::PowerMeter_1_1_5:</div>
<div class="dyncontent">
<div class="center">
<img src="interfacepdumodel_1_1PowerMeter__1__1__5.png" usemap="#pdumodel::PowerMeter_5F1_5F1_5F5_map" alt=""/>
<map id="pdumodel::PowerMeter_5F1_5F1_5F5_map" name="pdumodel::PowerMeter_5F1_5F1_5F5_map">
<area href="interfacepdumodel_1_1Panel__1__1__5.html" title="PMC panel. " alt="pdumodel::Panel_1_1_5" shape="rect" coords="0,56,183,80"/>
</map>
</div></div>
<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_1PowerMeter__1__1__5_1_1Config.html">Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Power meter configuration. <a href="structpdumodel_1_1PowerMeter__1__1__5_1_1Config.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_1PowerMeter__1__1__5_1_1EnergyPulseSettings.html">EnergyPulseSettings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Energy LED pulse settings. <a href="structpdumodel_1_1PowerMeter__1__1__5_1_1EnergyPulseSettings.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_1PowerMeter__1__1__5_1_1Sensors.html">Sensors</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Power meter sensors. <a href="structpdumodel_1_1PowerMeter__1__1__5_1_1Sensors.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_1PowerMeter__1__1__5_1_1Settings.html">Settings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Power meter settings. <a href="structpdumodel_1_1PowerMeter__1__1__5_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:a7feec54c3ae5e8e2605c9ed708f06baf"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a7feec54c3ae5e8e2605c9ed708f06baf">Type</a> { <a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a7feec54c3ae5e8e2605c9ed708f06bafad73f2b50319b3bcf733635678b8d0199">ONE_PHASE</a>,
<a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a7feec54c3ae5e8e2605c9ed708f06bafa59e3e6eddb67c4b125ef3341da459ee3">SPLIT_PHASE</a>,
<a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a7feec54c3ae5e8e2605c9ed708f06bafa4199df7df9b2c266bd9495a803920fc3">THREE_PHASE</a>
}</td></tr>
<tr class="memdesc:a7feec54c3ae5e8e2605c9ed708f06baf"><td class="mdescLeft"> </td><td class="mdescRight">Power meter type. <a href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a7feec54c3ae5e8e2605c9ed708f06baf">More...</a><br /></td></tr>
<tr class="separator:a7feec54c3ae5e8e2605c9ed708f06baf"><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:a33a6d23d8c5226099c2338e3d615ec6e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Config.html">Config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a33a6d23d8c5226099c2338e3d615ec6e">getConfig</a> ()</td></tr>
<tr class="memdesc:a33a6d23d8c5226099c2338e3d615ec6e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the power meter configuration. <a href="#a33a6d23d8c5226099c2338e3d615ec6e">More...</a><br /></td></tr>
<tr class="separator:a33a6d23d8c5226099c2338e3d615ec6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e98b12fc589334a7aa97431642bca78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Sensors.html">Sensors</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a4e98b12fc589334a7aa97431642bca78">getSensors</a> ()</td></tr>
<tr class="memdesc:a4e98b12fc589334a7aa97431642bca78"><td class="mdescLeft"> </td><td class="mdescRight">Get the power meter sensors. <a href="#a4e98b12fc589334a7aa97431642bca78">More...</a><br /></td></tr>
<tr class="separator:a4e98b12fc589334a7aa97431642bca78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2dbe540f331bd3302212c8ccbb3eaae"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structpdumodel_1_1Pole__5__0__0.html">Pole_5_0_0</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#ad2dbe540f331bd3302212c8ccbb3eaae">getPoles</a> ()</td></tr>
<tr class="memdesc:ad2dbe540f331bd3302212c8ccbb3eaae"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of power meter poles. <a href="#ad2dbe540f331bd3302212c8ccbb3eaae">More...</a><br /></td></tr>
<tr class="separator:ad2dbe540f331bd3302212c8ccbb3eaae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1e83ad5198010e47b94e8fd41b0fa6f"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="interfacepdumodel_1_1Controller__4__0__1.html">Controller_4_0_1</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#ae1e83ad5198010e47b94e8fd41b0fa6f">getControllers</a> ()</td></tr>
<tr class="memdesc:ae1e83ad5198010e47b94e8fd41b0fa6f"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of slave controllers for this power meter. <a href="#ae1e83ad5198010e47b94e8fd41b0fa6f">More...</a><br /></td></tr>
<tr class="separator:ae1e83ad5198010e47b94e8fd41b0fa6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc30537431b6898e7fd3151f82b751a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Settings.html">Settings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#afc30537431b6898e7fd3151f82b751a7">getSettings</a> ()</td></tr>
<tr class="memdesc:afc30537431b6898e7fd3151f82b751a7"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the power meter settings. <a href="#afc30537431b6898e7fd3151f82b751a7">More...</a><br /></td></tr>
<tr class="separator:afc30537431b6898e7fd3151f82b751a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf58daf7b90e5295089da047919dcba9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#acf58daf7b90e5295089da047919dcba9">setSettings</a> (in <a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Settings.html">Settings</a> settings)</td></tr>
<tr class="memdesc:acf58daf7b90e5295089da047919dcba9"><td class="mdescLeft"> </td><td class="mdescRight">Change the power meter settings. <a href="#acf58daf7b90e5295089da047919dcba9">More...</a><br /></td></tr>
<tr class="separator:acf58daf7b90e5295089da047919dcba9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a726a659de99b702afb2ee44c5978813a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1EnergyPulseSettings.html">EnergyPulseSettings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a726a659de99b702afb2ee44c5978813a">getEnergyPulseSettings</a> ()</td></tr>
<tr class="memdesc:a726a659de99b702afb2ee44c5978813a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the energy LED pulse settings. <a href="#a726a659de99b702afb2ee44c5978813a">More...</a><br /></td></tr>
<tr class="separator:a726a659de99b702afb2ee44c5978813a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc91aba9d57abcada702ab572631f252"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#abc91aba9d57abcada702ab572631f252">setEnergyPulseSettings</a> (in <a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1EnergyPulseSettings.html">EnergyPulseSettings</a> settings)</td></tr>
<tr class="memdesc:abc91aba9d57abcada702ab572631f252"><td class="mdescLeft"> </td><td class="mdescRight">Change the energy LED pulse settings. <a href="#abc91aba9d57abcada702ab572631f252">More...</a><br /></td></tr>
<tr class="separator:abc91aba9d57abcada702ab572631f252"><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:a34168a4c2afced770fb50461a56b0fd2"><td class="memItemLeft" align="right" valign="top"><a id="a34168a4c2afced770fb50461a56b0fd2"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a34168a4c2afced770fb50461a56b0fd2">ERR_INVALID_PARAM</a> = 1</td></tr>
<tr class="memdesc:a34168a4c2afced770fb50461a56b0fd2"><td class="mdescLeft"> </td><td class="mdescRight">Invalid parameters. <br /></td></tr>
<tr class="separator:a34168a4c2afced770fb50461a56b0fd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47507266ca06600b30ef525d675d9d3f"><td class="memItemLeft" align="right" valign="top"><a id="a47507266ca06600b30ef525d675d9d3f"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a47507266ca06600b30ef525d675d9d3f">ERR_MODBUS_UNIT_IN_USE</a> = 2</td></tr>
<tr class="memdesc:a47507266ca06600b30ef525d675d9d3f"><td class="mdescLeft"> </td><td class="mdescRight">Modbus unit address is already in use. <br /></td></tr>
<tr class="separator:a47507266ca06600b30ef525d675d9d3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb01b5693bce139e97acf55cdc8a5cdf"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#adb01b5693bce139e97acf55cdc8a5cdf">SettingsChangedEvent</a>: <a class="el" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">event::UserEvent</a> { <a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Settings.html">Settings</a> oldSettings</td></tr>
<tr class="memdesc:adb01b5693bce139e97acf55cdc8a5cdf"><td class="mdescLeft"> </td><td class="mdescRight">Event: Power meter settings have changed. <a href="#adb01b5693bce139e97acf55cdc8a5cdf">More...</a><br /></td></tr>
<tr class="separator:adb01b5693bce139e97acf55cdc8a5cdf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9d8339d55804f61d278d3bb4ff8e204"><td class="memItemLeft" align="right" valign="top"><a id="af9d8339d55804f61d278d3bb4ff8e204"></a>
<a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Settings.html">Settings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#af9d8339d55804f61d278d3bb4ff8e204">newSettings</a></td></tr>
<tr class="memdesc:af9d8339d55804f61d278d3bb4ff8e204"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Settings.html" title="Power meter settings. ">Settings</a> after change. <br /></td></tr>
<tr class="separator:af9d8339d55804f61d278d3bb4ff8e204"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75c597d7c1931dd58cd1b98e54bb333b"><td class="memItemLeft" align="right" valign="top"><a id="a75c597d7c1931dd58cd1b98e54bb333b"></a>
valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a75c597d7c1931dd58cd1b98e54bb333b">EnergyPulseSettingsChangedEvent</a>: <a class="el" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">event::UserEvent</a> { <a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1EnergyPulseSettings.html">EnergyPulseSettings</a> oldSettings</td></tr>
<tr class="memdesc:a75c597d7c1931dd58cd1b98e54bb333b"><td class="mdescLeft"> </td><td class="mdescRight">Event: Energy LED pulse settings have changed. <br /></td></tr>
<tr class="separator:a75c597d7c1931dd58cd1b98e54bb333b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26b5ebe12978a44e28159984043ed54f"><td class="memItemLeft" align="right" valign="top"><a id="a26b5ebe12978a44e28159984043ed54f"></a>
<a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1EnergyPulseSettings.html">EnergyPulseSettings</a> </td><td class="memItemRight" valign="bottom"><b>newSettings</b></td></tr>
<tr class="separator:a26b5ebe12978a44e28159984043ed54f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A three-phase power meter (PMC). </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a7feec54c3ae5e8e2605c9ed708f06baf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7feec54c3ae5e8e2605c9ed708f06baf">◆ </a></span>Type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacepdumodel_1_1PowerMeter__1__1__5.html#a7feec54c3ae5e8e2605c9ed708f06baf">pdumodel::PowerMeter_1_1_5::Type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Power meter type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7feec54c3ae5e8e2605c9ed708f06bafad73f2b50319b3bcf733635678b8d0199"></a>ONE_PHASE </td><td class="fielddoc"><p>Single-phase meter (A) </p>
</td></tr>
<tr><td class="fieldname"><a id="a7feec54c3ae5e8e2605c9ed708f06bafa59e3e6eddb67c4b125ef3341da459ee3"></a>SPLIT_PHASE </td><td class="fielddoc"><p>Split-phase meter (A, B) </p>
</td></tr>
<tr><td class="fieldname"><a id="a7feec54c3ae5e8e2605c9ed708f06bafa4199df7df9b2c266bd9495a803920fc3"></a>THREE_PHASE </td><td class="fielddoc"><p>Three-phase meter (A, B, C) </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a33a6d23d8c5226099c2338e3d615ec6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33a6d23d8c5226099c2338e3d615ec6e">◆ </a></span>getConfig()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Config.html">Config</a> pdumodel::PowerMeter_1_1_5::getConfig </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the power meter configuration. </p>
<dl class="section return"><dt>Returns</dt><dd>Power meter configuration </dd></dl>
</div>
</div>
<a id="ae1e83ad5198010e47b94e8fd41b0fa6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1e83ad5198010e47b94e8fd41b0fa6f">◆ </a></span>getControllers()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="interfacepdumodel_1_1Controller__4__0__1.html">Controller_4_0_1</a>> pdumodel::PowerMeter_1_1_5::getControllers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the list of slave controllers for this power meter. </p>
<dl class="section return"><dt>Returns</dt><dd>List of controllers </dd></dl>
</div>
</div>
<a id="a726a659de99b702afb2ee44c5978813a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a726a659de99b702afb2ee44c5978813a">◆ </a></span>getEnergyPulseSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1EnergyPulseSettings.html">EnergyPulseSettings</a> pdumodel::PowerMeter_1_1_5::getEnergyPulseSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the energy LED pulse settings. </p>
<dl class="section return"><dt>Returns</dt><dd>Energy LED pulse settings </dd></dl>
</div>
</div>
<a id="ad2dbe540f331bd3302212c8ccbb3eaae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2dbe540f331bd3302212c8ccbb3eaae">◆ </a></span>getPoles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structpdumodel_1_1Pole__5__0__0.html">Pole_5_0_0</a>> pdumodel::PowerMeter_1_1_5::getPoles </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the list of power meter poles. </p>
<dl class="section return"><dt>Returns</dt><dd>List of power meter poles (A, B, C, N, PE) </dd></dl>
</div>
</div>
<a id="a4e98b12fc589334a7aa97431642bca78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e98b12fc589334a7aa97431642bca78">◆ </a></span>getSensors()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Sensors.html">Sensors</a> pdumodel::PowerMeter_1_1_5::getSensors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the power meter sensors. </p>
<dl class="section return"><dt>Returns</dt><dd>Power meter sensors </dd></dl>
</div>
</div>
<a id="afc30537431b6898e7fd3151f82b751a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc30537431b6898e7fd3151f82b751a7">◆ </a></span>getSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Settings.html">Settings</a> pdumodel::PowerMeter_1_1_5::getSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the power meter settings. </p>
<dl class="section return"><dt>Returns</dt><dd>Power meter settings </dd></dl>
</div>
</div>
<a id="abc91aba9d57abcada702ab572631f252"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc91aba9d57abcada702ab572631f252">◆ </a></span>setEnergyPulseSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pdumodel::PowerMeter_1_1_5::setEnergyPulseSettings </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1EnergyPulseSettings.html">EnergyPulseSettings</a> </td>
<td class="paramname"><em>settings</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the energy LED pulse settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>New 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></dl>
</div>
</div>
<a id="acf58daf7b90e5295089da047919dcba9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf58daf7b90e5295089da047919dcba9">◆ </a></span>setSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pdumodel::PowerMeter_1_1_5::setSettings </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_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 power meter settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>New 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 the Modbus unit address is already in use </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adb01b5693bce139e97acf55cdc8a5cdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb01b5693bce139e97acf55cdc8a5cdf">◆ </a></span>SettingsChangedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject pdumodel::PowerMeter_1_1_5::SettingsChangedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event: Power meter settings have changed. </p>
<p><a class="el" href="structpdumodel_1_1PowerMeter__1__1__5_1_1Settings.html" title="Power meter settings. ">Settings</a> before change </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="PowerMeter_8idl_source.html">PowerMeter.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>
|