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
|
<!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::OverCurrentProtector_3_0_4 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_1OverCurrentProtector__3__0__4.html">OverCurrentProtector_3_0_4</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_1OverCurrentProtector__3__0__4-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pdumodel::OverCurrentProtector_3_0_4 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Overcurrent protector interface.
<a href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#details">More...</a></p>
<p><code>import"<a class="el" href="OverCurrentProtector_8idl_source.html">OverCurrentProtector.idl</a>";</code></p>
<div class="dynheader">
Inheritance diagram for pdumodel::OverCurrentProtector_3_0_4:</div>
<div class="dyncontent">
<div class="center">
<img src="interfacepdumodel_1_1OverCurrentProtector__3__0__4.png" usemap="#pdumodel::OverCurrentProtector_5F3_5F0_5F4_map" alt=""/>
<map id="pdumodel::OverCurrentProtector_5F3_5F0_5F4_map" name="pdumodel::OverCurrentProtector_5F3_5F0_5F4_map">
<area 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. " alt="pdumodel::EDevice" shape="rect" coords="0,0,238,24"/>
</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_1OverCurrentProtector__3__0__4_1_1MetaData.html">MetaData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Overcurrent protector metadata. <a href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1MetaData.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_1OverCurrentProtector__3__0__4_1_1Sensors.html">Sensors</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Overcurrent protector sensors. <a href="structpdumodel_1_1OverCurrentProtector__3__0__4_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_1OverCurrentProtector__3__0__4_1_1Settings.html">Settings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Overcurrent protector settings. <a href="structpdumodel_1_1OverCurrentProtector__3__0__4_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:ac43040744df0726776afa408d730411c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411c">Type</a> { <br />
  <a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411ca2d39c26f42d2681a3dc3a1c155957a47">BREAKER_1POLE</a>,
<a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411ca9b5456024c41a61c5d731e624f73196a">BREAKER_2POLE</a>,
<a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411ca4b671cf2695c155703154945a94cfcd3">BREAKER_3POLE</a>,
<a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411ca8cc9f84025a26634af2dfb06446fdede">FUSE</a>,
<br />
  <a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411ca1034b9d1186bd672a5e20da0dbf7dc7f">FUSE_PAIR</a>,
<a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411ca8d255c70683b4540faea5df72a865969">RCBO_2POLE</a>,
<a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411caff2390059e82ef8a496384cc6c6dc6bf">RCBO_3POLE</a>,
<a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411ca4f52e2aec5cb09ed63e5e5877805977a">RCBO_4POLE</a>
<br />
}</td></tr>
<tr class="memdesc:ac43040744df0726776afa408d730411c"><td class="mdescLeft"> </td><td class="mdescRight">Overcurrent protector type. <a href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411c">More...</a><br /></td></tr>
<tr class="separator:ac43040744df0726776afa408d730411c"><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:af63053cd833a0cbf5426907ea0242e85"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1MetaData.html">MetaData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#af63053cd833a0cbf5426907ea0242e85">getMetaData</a> ()</td></tr>
<tr class="memdesc:af63053cd833a0cbf5426907ea0242e85"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the OCP metadata. <a href="#af63053cd833a0cbf5426907ea0242e85">More...</a><br /></td></tr>
<tr class="separator:af63053cd833a0cbf5426907ea0242e85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc04785a6460c3d7b38f22e5b3f2aa31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1Sensors.html">Sensors</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#acc04785a6460c3d7b38f22e5b3f2aa31">getSensors</a> ()</td></tr>
<tr class="memdesc:acc04785a6460c3d7b38f22e5b3f2aa31"><td class="mdescLeft"> </td><td class="mdescRight">Get the OCP sensors. <a href="#acc04785a6460c3d7b38f22e5b3f2aa31">More...</a><br /></td></tr>
<tr class="separator:acc04785a6460c3d7b38f22e5b3f2aa31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf4788f35538392f53d9428325209084"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structpdumodel_1_1DoublePole__5__0__0.html">DoublePole_5_0_0</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#adf4788f35538392f53d9428325209084">getPoles</a> ()</td></tr>
<tr class="memdesc:adf4788f35538392f53d9428325209084"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of OCP poles. <a href="#adf4788f35538392f53d9428325209084">More...</a><br /></td></tr>
<tr class="separator:adf4788f35538392f53d9428325209084"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04af417b17d4e6e26c1c0c6bde4cb9bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacepdumodel_1_1Inlet__2__0__4.html">Inlet_2_0_4</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#a04af417b17d4e6e26c1c0c6bde4cb9bc">getInlet</a> ()</td></tr>
<tr class="memdesc:a04af417b17d4e6e26c1c0c6bde4cb9bc"><td class="mdescLeft"> </td><td class="mdescRight">Get the inlet this OCP is connected to. <a href="#a04af417b17d4e6e26c1c0c6bde4cb9bc">More...</a><br /></td></tr>
<tr class="separator:a04af417b17d4e6e26c1c0c6bde4cb9bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a079b3f255d0a75a41fcc2a6e214ca3a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html">OverCurrentProtector_3_0_4</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#a079b3f255d0a75a41fcc2a6e214ca3a9">getOCP</a> ()</td></tr>
<tr class="memdesc:a079b3f255d0a75a41fcc2a6e214ca3a9"><td class="mdescLeft"> </td><td class="mdescRight">Get parent OCP - next OCP going towards inlet (for cascaded OCPs). <a href="#a079b3f255d0a75a41fcc2a6e214ca3a9">More...</a><br /></td></tr>
<tr class="separator:a079b3f255d0a75a41fcc2a6e214ca3a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affb60100cac5bd8f40bed1120f83635e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1Settings.html">Settings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#affb60100cac5bd8f40bed1120f83635e">getSettings</a> ()</td></tr>
<tr class="memdesc:affb60100cac5bd8f40bed1120f83635e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the OCP settings. <a href="#affb60100cac5bd8f40bed1120f83635e">More...</a><br /></td></tr>
<tr class="separator:affb60100cac5bd8f40bed1120f83635e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0811f4563bca2a7aad9f192abd266d21"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#a0811f4563bca2a7aad9f192abd266d21">setSettings</a> (in <a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1Settings.html">Settings</a> settings)</td></tr>
<tr class="memdesc:a0811f4563bca2a7aad9f192abd266d21"><td class="mdescLeft"> </td><td class="mdescRight">Change the OCP settings. <a href="#a0811f4563bca2a7aad9f192abd266d21">More...</a><br /></td></tr>
<tr class="separator:a0811f4563bca2a7aad9f192abd266d21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_interfacepdumodel_1_1EDevice"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfacepdumodel_1_1EDevice')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="interfacepdumodel_1_1EDevice.html">pdumodel::EDevice</a></td></tr>
<tr class="memitem:a9f9025acd6973b6c1f401ea855b5d32d inherit pub_methods_interfacepdumodel_1_1EDevice"><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 inherit pub_methods_interfacepdumodel_1_1EDevice"><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 inherit pub_methods_interfacepdumodel_1_1EDevice"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2542c31d0989a203a3c3262e38f17af8 inherit pub_methods_interfacepdumodel_1_1EDevice"><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 inherit pub_methods_interfacepdumodel_1_1EDevice"><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 inherit pub_methods_interfacepdumodel_1_1EDevice"><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:acaa163db255028fd851e42c1708cde84"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#acaa163db255028fd851e42c1708cde84">SettingsChangedEvent</a>: <a class="el" href="namespaceevent.html#a2c124cd89f703231aa6031d409472a3e">event::UserEvent</a> { <a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1Settings.html">Settings</a> oldSettings</td></tr>
<tr class="memdesc:acaa163db255028fd851e42c1708cde84"><td class="mdescLeft"> </td><td class="mdescRight">Event: Overcurrent protector settings have been changed. <a href="#acaa163db255028fd851e42c1708cde84">More...</a><br /></td></tr>
<tr class="separator:acaa163db255028fd851e42c1708cde84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67b6ef1b9c0a42db4e963c26a98b990a"><td class="memItemLeft" align="right" valign="top"><a id="a67b6ef1b9c0a42db4e963c26a98b990a"></a>
<a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1Settings.html">Settings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#a67b6ef1b9c0a42db4e963c26a98b990a">newSettings</a></td></tr>
<tr class="memdesc:a67b6ef1b9c0a42db4e963c26a98b990a"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1Settings.html" title="Overcurrent protector settings. ">Settings</a> after change. <br /></td></tr>
<tr class="separator:a67b6ef1b9c0a42db4e963c26a98b990a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Overcurrent protector interface. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ac43040744df0726776afa408d730411c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac43040744df0726776afa408d730411c">◆ </a></span>Type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html#ac43040744df0726776afa408d730411c">pdumodel::OverCurrentProtector_3_0_4::Type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Overcurrent protector type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac43040744df0726776afa408d730411ca2d39c26f42d2681a3dc3a1c155957a47"></a>BREAKER_1POLE </td><td class="fielddoc"><p>Single-pole circuit breaker. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac43040744df0726776afa408d730411ca9b5456024c41a61c5d731e624f73196a"></a>BREAKER_2POLE </td><td class="fielddoc"><p>Two-pole circuit breaker. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac43040744df0726776afa408d730411ca4b671cf2695c155703154945a94cfcd3"></a>BREAKER_3POLE </td><td class="fielddoc"><p>Three-pole circuit breaker. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac43040744df0726776afa408d730411ca8cc9f84025a26634af2dfb06446fdede"></a>FUSE </td><td class="fielddoc"><p>Fuse. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac43040744df0726776afa408d730411ca1034b9d1186bd672a5e20da0dbf7dc7f"></a>FUSE_PAIR </td><td class="fielddoc"><p>Fuse Pair. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac43040744df0726776afa408d730411ca8d255c70683b4540faea5df72a865969"></a>RCBO_2POLE </td><td class="fielddoc"><p>Two-pole residual-current device including overcurrent protection. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac43040744df0726776afa408d730411caff2390059e82ef8a496384cc6c6dc6bf"></a>RCBO_3POLE </td><td class="fielddoc"><p>Three-pole residual-current device including overcurrent protection. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac43040744df0726776afa408d730411ca4f52e2aec5cb09ed63e5e5877805977a"></a>RCBO_4POLE </td><td class="fielddoc"><p>Four-pole residual-current device including overcurrent protection. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a04af417b17d4e6e26c1c0c6bde4cb9bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04af417b17d4e6e26c1c0c6bde4cb9bc">◆ </a></span>getInlet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfacepdumodel_1_1Inlet__2__0__4.html">Inlet_2_0_4</a> pdumodel::OverCurrentProtector_3_0_4::getInlet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the inlet this OCP is connected to. </p>
<dl class="section return"><dt>Returns</dt><dd>inlet </dd></dl>
</div>
</div>
<a id="af63053cd833a0cbf5426907ea0242e85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af63053cd833a0cbf5426907ea0242e85">◆ </a></span>getMetaData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1MetaData.html">MetaData</a> pdumodel::OverCurrentProtector_3_0_4::getMetaData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the OCP metadata. </p>
<dl class="section return"><dt>Returns</dt><dd>OCP metadata </dd></dl>
</div>
</div>
<a id="a079b3f255d0a75a41fcc2a6e214ca3a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a079b3f255d0a75a41fcc2a6e214ca3a9">◆ </a></span>getOCP()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfacepdumodel_1_1OverCurrentProtector__3__0__4.html">OverCurrentProtector_3_0_4</a> pdumodel::OverCurrentProtector_3_0_4::getOCP </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get parent OCP - next OCP going towards inlet (for cascaded OCPs). </p>
<dl class="section return"><dt>Returns</dt><dd>OCP or null </dd></dl>
</div>
</div>
<a id="adf4788f35538392f53d9428325209084"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf4788f35538392f53d9428325209084">◆ </a></span>getPoles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structpdumodel_1_1DoublePole__5__0__0.html">DoublePole_5_0_0</a>> pdumodel::OverCurrentProtector_3_0_4::getPoles </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the list of OCP poles. </p>
<dl class="section return"><dt>Returns</dt><dd>List of OCP poles </dd></dl>
</div>
</div>
<a id="acc04785a6460c3d7b38f22e5b3f2aa31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc04785a6460c3d7b38f22e5b3f2aa31">◆ </a></span>getSensors()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1Sensors.html">Sensors</a> pdumodel::OverCurrentProtector_3_0_4::getSensors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the OCP sensors. </p>
<dl class="section return"><dt>Returns</dt><dd>OCP sensors </dd></dl>
</div>
</div>
<a id="affb60100cac5bd8f40bed1120f83635e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affb60100cac5bd8f40bed1120f83635e">◆ </a></span>getSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1Settings.html">Settings</a> pdumodel::OverCurrentProtector_3_0_4::getSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the OCP settings. </p>
<dl class="section return"><dt>Returns</dt><dd>OCP settings </dd></dl>
</div>
</div>
<a id="a0811f4563bca2a7aad9f192abd266d21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0811f4563bca2a7aad9f192abd266d21">◆ </a></span>setSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pdumodel::OverCurrentProtector_3_0_4::setSettings </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_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 OCP settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>New OCP 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>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="acaa163db255028fd851e42c1708cde84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acaa163db255028fd851e42c1708cde84">◆ </a></span>SettingsChangedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject pdumodel::OverCurrentProtector_3_0_4::SettingsChangedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event: Overcurrent protector settings have been changed. </p>
<p><a class="el" href="structpdumodel_1_1OverCurrentProtector__3__0__4_1_1Settings.html" title="Overcurrent protector 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="OverCurrentProtector_8idl_source.html">OverCurrentProtector.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>
|