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
|
<!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: sensors::AlertedSensorManager_1_0_1 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="namespacesensors.html">sensors</a></li><li class="navelem"><a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html">AlertedSensorManager_1_0_1</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="interfacesensors_1_1AlertedSensorManager__1__0__1-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sensors::AlertedSensorManager_1_0_1 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A global instance keeping track of sensors in alerted state.
<a href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#details">More...</a></p>
<p><code>import"<a class="el" href="AlertedSensorManager_8idl_source.html">AlertedSensorManager.idl</a>";</code></p>
<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="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorCounts.html">SensorCounts</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Statistics about monitored sensors. <a href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorCounts.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="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorData.html">SensorData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Data about a monitored sensor. <a href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorData.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:ab29b856eab64273f3c11d87ddb00d04a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#ab29b856eab64273f3c11d87ddb00d04a">AlertState</a> { <a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#ab29b856eab64273f3c11d87ddb00d04aafe22893da05d56e368781a4fdcbc1316">UNAVAILABLE</a>,
<a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#ab29b856eab64273f3c11d87ddb00d04aa0254a881605f249110388e117bd754fc">NORMAL</a>,
<a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#ab29b856eab64273f3c11d87ddb00d04aa3b90f81b4ef4edd7c02168ca57e374e8">CRITICAL</a>,
<a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#ab29b856eab64273f3c11d87ddb00d04aaba6d64d7791e645307a5a6159b1233b1">WARNED</a>
}</td></tr>
<tr class="memdesc:ab29b856eab64273f3c11d87ddb00d04a"><td class="mdescLeft"> </td><td class="mdescRight">Sensor alert state. <a href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#ab29b856eab64273f3c11d87ddb00d04a">More...</a><br /></td></tr>
<tr class="separator:ab29b856eab64273f3c11d87ddb00d04a"><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:a15e2440ac8f95dc8ca6cd7bb2d5dcd98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorCounts.html">SensorCounts</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#a15e2440ac8f95dc8ca6cd7bb2d5dcd98">getSensorCounts</a> ()</td></tr>
<tr class="memdesc:a15e2440ac8f95dc8ca6cd7bb2d5dcd98"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the current sensor counts. <a href="#a15e2440ac8f95dc8ca6cd7bb2d5dcd98">More...</a><br /></td></tr>
<tr class="separator:a15e2440ac8f95dc8ca6cd7bb2d5dcd98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4abe419d6fe725cd0bf6fb4184ac6980"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorData.html">SensorData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#a4abe419d6fe725cd0bf6fb4184ac6980">getAllSensors</a> ()</td></tr>
<tr class="memdesc:a4abe419d6fe725cd0bf6fb4184ac6980"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a list of all monitored sensors. <a href="#a4abe419d6fe725cd0bf6fb4184ac6980">More...</a><br /></td></tr>
<tr class="separator:a4abe419d6fe725cd0bf6fb4184ac6980"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74f29195d58b0cc7668d4ece218c8ce2"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorData.html">SensorData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#a74f29195d58b0cc7668d4ece218c8ce2">getAlertedSensors</a> ()</td></tr>
<tr class="memdesc:a74f29195d58b0cc7668d4ece218c8ce2"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a list of currently alerted sensors. <a href="#a74f29195d58b0cc7668d4ece218c8ce2">More...</a><br /></td></tr>
<tr class="separator:a74f29195d58b0cc7668d4ece218c8ce2"><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:a25db0d81e693a7a515a211c77b315c79"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#a25db0d81e693a7a515a211c77b315c79">MonitoredSensorsChangedEvent</a>: <a class="el" href="namespaceidl.html#accbdf35b0c02d64ce223e912fc2b246f">idl::Event</a> { <a class="el" href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorCounts.html">SensorCounts</a> counts</td></tr>
<tr class="memdesc:a25db0d81e693a7a515a211c77b315c79"><td class="mdescLeft"> </td><td class="mdescRight">Event: A change in the list of monitored sensors occurred. <a href="#a25db0d81e693a7a515a211c77b315c79">More...</a><br /></td></tr>
<tr class="separator:a25db0d81e693a7a515a211c77b315c79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46b5b1608b5f8859b0d7e418fb74f616"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#a46b5b1608b5f8859b0d7e418fb74f616">AlertedSensorsChangedEvent</a>: <a class="el" href="namespaceidl.html#accbdf35b0c02d64ce223e912fc2b246f">idl::Event</a> { <a class="el" href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorCounts.html">SensorCounts</a> counts</td></tr>
<tr class="memdesc:a46b5b1608b5f8859b0d7e418fb74f616"><td class="mdescLeft"> </td><td class="mdescRight">Event: One or more sensors' alert states have changed. <a href="#a46b5b1608b5f8859b0d7e418fb74f616">More...</a><br /></td></tr>
<tr class="separator:a46b5b1608b5f8859b0d7e418fb74f616"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1159afc678e4aebc21d946b3d7edc81"><td class="memItemLeft" align="right" valign="top"><a id="ac1159afc678e4aebc21d946b3d7edc81"></a>
vector< <a class="el" href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorData.html">SensorData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#ac1159afc678e4aebc21d946b3d7edc81">changedSensors</a></td></tr>
<tr class="memdesc:ac1159afc678e4aebc21d946b3d7edc81"><td class="mdescLeft"> </td><td class="mdescRight">Changed or added sensors. <br /></td></tr>
<tr class="separator:ac1159afc678e4aebc21d946b3d7edc81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83cf0cd3857ffc821b968b93da2d268c"><td class="memItemLeft" align="right" valign="top"><a id="a83cf0cd3857ffc821b968b93da2d268c"></a>
vector< <a class="el" href="interfacesensors_1_1Sensor__4__0__3.html">Sensor_4_0_3</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#a83cf0cd3857ffc821b968b93da2d268c">removedSensors</a></td></tr>
<tr class="memdesc:a83cf0cd3857ffc821b968b93da2d268c"><td class="mdescLeft"> </td><td class="mdescRight">Removed sensors. <br /></td></tr>
<tr class="separator:a83cf0cd3857ffc821b968b93da2d268c"><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 global instance keeping track of sensors in alerted state. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ab29b856eab64273f3c11d87ddb00d04a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab29b856eab64273f3c11d87ddb00d04a">◆ </a></span>AlertState</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#ab29b856eab64273f3c11d87ddb00d04a">sensors::AlertedSensorManager_1_0_1::AlertState</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sensor alert state. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab29b856eab64273f3c11d87ddb00d04aafe22893da05d56e368781a4fdcbc1316"></a>UNAVAILABLE </td><td class="fielddoc"><p>Sensor is unavailable. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab29b856eab64273f3c11d87ddb00d04aa0254a881605f249110388e117bd754fc"></a>NORMAL </td><td class="fielddoc"><p>Sensor is not alerted. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab29b856eab64273f3c11d87ddb00d04aa3b90f81b4ef4edd7c02168ca57e374e8"></a>CRITICAL </td><td class="fielddoc"><p>Sensor is in critical state. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab29b856eab64273f3c11d87ddb00d04aaba6d64d7791e645307a5a6159b1233b1"></a>WARNED </td><td class="fielddoc"><p>Sensor is in warned state. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a74f29195d58b0cc7668d4ece218c8ce2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74f29195d58b0cc7668d4ece218c8ce2">◆ </a></span>getAlertedSensors()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorData.html">SensorData</a>> sensors::AlertedSensorManager_1_0_1::getAlertedSensors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a list of currently alerted sensors. </p>
<dl class="section return"><dt>Returns</dt><dd>List of alerted sensors </dd></dl>
</div>
</div>
<a id="a4abe419d6fe725cd0bf6fb4184ac6980"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4abe419d6fe725cd0bf6fb4184ac6980">◆ </a></span>getAllSensors()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorData.html">SensorData</a>> sensors::AlertedSensorManager_1_0_1::getAllSensors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a list of all monitored sensors. </p>
<dl class="section return"><dt>Returns</dt><dd>List of monitored sensors including alert state </dd></dl>
</div>
</div>
<a id="a15e2440ac8f95dc8ca6cd7bb2d5dcd98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15e2440ac8f95dc8ca6cd7bb2d5dcd98">◆ </a></span>getSensorCounts()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsensors_1_1AlertedSensorManager__1__0__1_1_1SensorCounts.html">SensorCounts</a> sensors::AlertedSensorManager_1_0_1::getSensorCounts </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the current sensor counts. </p>
<dl class="section return"><dt>Returns</dt><dd>Current sensor counts </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a46b5b1608b5f8859b0d7e418fb74f616"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46b5b1608b5f8859b0d7e418fb74f616">◆ </a></span>AlertedSensorsChangedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject sensors::AlertedSensorManager_1_0_1::AlertedSensorsChangedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event: One or more sensors' alert states have changed. </p>
<p>This event is fired whenever the result of <a class="el" href="interfacesensors_1_1AlertedSensorManager__1__0__1.html#a74f29195d58b0cc7668d4ece218c8ce2" title="Retrieve a list of currently alerted sensors. ">getAlertedSensors()</a> changes, i.e. in the following cases:</p><ul>
<li>An existing sensor's alert state changes</li>
<li>A newly added sensor is alerted</li>
<li>A sensor that was alerted is removedSensor statistics after the change </li>
</ul>
</div>
</div>
<a id="a25db0d81e693a7a515a211c77b315c79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25db0d81e693a7a515a211c77b315c79">◆ </a></span>MonitoredSensorsChangedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject sensors::AlertedSensorManager_1_0_1::MonitoredSensorsChangedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event: A change in the list of monitored sensors occurred. </p>
<p>This event is fired when sensors are added to or removed from the list of monitored sensors. It is not fired when a monitored sensor's alert state changes.Sensor statistics after the 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="AlertedSensorManager_8idl_source.html">AlertedSensorManager.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>
|
