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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan / Server Technology Xerus™ PDU JSON-RPC API: pdumodel::Outlet::State Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Raritan / Server Technology Xerus™ PDU JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacepdumodel.html">pdumodel</a></li><li class="navelem"><a class="el" href="interfacepdumodel_1_1Outlet.html">Outlet</a></li><li class="navelem"><a class="el" href="structpdumodel_1_1Outlet_1_1State.html">State</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> |
<a href="structpdumodel_1_1Outlet_1_1State-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pdumodel::Outlet::State Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Outlet state
<a href="structpdumodel_1_1Outlet_1_1State.html#details">More...</a></p>
<p><code>import"<a class="el" href="Outlet_8idl_source.html">Outlet.idl</a>";</code></p>
<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:add4468026943ed93fa9b6d6b77d135de"><td class="memItemLeft" align="right" valign="top"><a id="add4468026943ed93fa9b6d6b77d135de"></a>
boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Outlet_1_1State.html#add4468026943ed93fa9b6d6b77d135de">available</a></td></tr>
<tr class="memdesc:add4468026943ed93fa9b6d6b77d135de"><td class="mdescLeft"> </td><td class="mdescRight">powerState is available <br /></td></tr>
<tr class="separator:add4468026943ed93fa9b6d6b77d135de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aacaa08fee85f1bd64d0a0fe3c80e564a"><td class="memItemLeft" align="right" valign="top"><a id="aacaa08fee85f1bd64d0a0fe3c80e564a"></a>
<a class="el" href="interfacepdumodel_1_1Outlet.html#a25bffaad36078a861771911bdd38b953">PowerState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Outlet_1_1State.html#aacaa08fee85f1bd64d0a0fe3c80e564a">powerState</a></td></tr>
<tr class="memdesc:aacaa08fee85f1bd64d0a0fe3c80e564a"><td class="mdescLeft"> </td><td class="mdescRight">Current power state of outlet (represented by the control state of the relay, which was set by the last command sent to it) <br /></td></tr>
<tr class="separator:aacaa08fee85f1bd64d0a0fe3c80e564a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa66e878b22167fb124c708f5c49655df"><td class="memItemLeft" align="right" valign="top"><a id="aa66e878b22167fb124c708f5c49655df"></a>
boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Outlet_1_1State.html#aa66e878b22167fb124c708f5c49655df">switchOnInProgress</a></td></tr>
<tr class="memdesc:aa66e878b22167fb124c708f5c49655df"><td class="mdescLeft"> </td><td class="mdescRight"><code>true</code> if the outlet is pending to be switched on after the sequencing delay has passed. <br /></td></tr>
<tr class="separator:aa66e878b22167fb124c708f5c49655df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a7bb5f69ddfc9078f7c77bcb2d43bab"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Outlet_1_1State.html#a5a7bb5f69ddfc9078f7c77bcb2d43bab">cycleInProgress</a></td></tr>
<tr class="memdesc:a5a7bb5f69ddfc9078f7c77bcb2d43bab"><td class="mdescLeft"> </td><td class="mdescRight"><code>if</code> a power-cycle is in progress. <a href="structpdumodel_1_1Outlet_1_1State.html#a5a7bb5f69ddfc9078f7c77bcb2d43bab">More...</a><br /></td></tr>
<tr class="separator:a5a7bb5f69ddfc9078f7c77bcb2d43bab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00da3de980e23ce0346c81aad9eec346"><td class="memItemLeft" align="right" valign="top"><a id="a00da3de980e23ce0346c81aad9eec346"></a>
boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Outlet_1_1State.html#a00da3de980e23ce0346c81aad9eec346">isLoadShed</a></td></tr>
<tr class="memdesc:a00da3de980e23ce0346c81aad9eec346"><td class="mdescLeft"> </td><td class="mdescRight"><code>true</code> if the outlet is currently switched off due to being non-critical and load shedding being active <br /></td></tr>
<tr class="separator:a00da3de980e23ce0346c81aad9eec346"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8833ef31a6efc900df02c98988fa6b93"><td class="memItemLeft" align="right" valign="top"><a id="a8833ef31a6efc900df02c98988fa6b93"></a>
boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Outlet_1_1State.html#a8833ef31a6efc900df02c98988fa6b93">isSuspended</a></td></tr>
<tr class="memdesc:a8833ef31a6efc900df02c98988fa6b93"><td class="mdescLeft"> </td><td class="mdescRight">Whether the outlet was turned off automatically due to being suspected to have caused an OCP trip event. <br /></td></tr>
<tr class="separator:a8833ef31a6efc900df02c98988fa6b93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60c2d445abaa20e7bee53653d737ca09"><td class="memItemLeft" align="right" valign="top"><a id="a60c2d445abaa20e7bee53653d737ca09"></a>
boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Outlet_1_1State.html#a60c2d445abaa20e7bee53653d737ca09">hasInrushWaveform</a></td></tr>
<tr class="memdesc:a60c2d445abaa20e7bee53653d737ca09"><td class="mdescLeft"> </td><td class="mdescRight">Whether a valid waveform of last switch-on operation can be read using <a class="el" href="interfacepdumodel_1_1Outlet.html#abeb495b20c8ee5ba573ef77c75f46c9c">getInrushWaveform()</a>. <br /></td></tr>
<tr class="separator:a60c2d445abaa20e7bee53653d737ca09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60d50405a155cd24aa50d12449b6c6e8"><td class="memItemLeft" align="right" valign="top"><a id="a60d50405a155cd24aa50d12449b6c6e8"></a>
<a class="el" href="structpdumodel_1_1Outlet_1_1LedState.html">LedState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Outlet_1_1State.html#a60d50405a155cd24aa50d12449b6c6e8">ledState</a></td></tr>
<tr class="memdesc:a60d50405a155cd24aa50d12449b6c6e8"><td class="mdescLeft"> </td><td class="mdescRight">LED state (deprecated and always sent as 'off') <br /></td></tr>
<tr class="separator:a60d50405a155cd24aa50d12449b6c6e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac74dd25e50ff2bba7a44292e55a29189"><td class="memItemLeft" align="right" valign="top"><a id="ac74dd25e50ff2bba7a44292e55a29189"></a>
time </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Outlet_1_1State.html#ac74dd25e50ff2bba7a44292e55a29189">lastPowerStateChange</a></td></tr>
<tr class="memdesc:ac74dd25e50ff2bba7a44292e55a29189"><td class="mdescLeft"> </td><td class="mdescRight">Time of last power state change (UNIX timestamp, UTC) <br /></td></tr>
<tr class="separator:ac74dd25e50ff2bba7a44292e55a29189"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Outlet state </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a5a7bb5f69ddfc9078f7c77bcb2d43bab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a7bb5f69ddfc9078f7c77bcb2d43bab">◆ </a></span>cycleInProgress</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean pdumodel::Outlet::State::cycleInProgress</td>
</tr>
</table>
</div><div class="memdoc">
<p><code>if</code> a power-cycle is in progress. </p>
<p>The outlet will be switched on after the cycle delay has passed. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="Outlet_8idl_source.html">Outlet.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 17 2022 00:25:44 for Raritan / Server Technology Xerus™ PDU JSON-RPC API by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
