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
|
<!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/Switch.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">Switch.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 2012 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 __SENSORS_SWITCH_IDL__</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define __SENSORS_SWITCH_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 <StateSensor.idl></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <UserEvent.idl></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/** Sensors Model */</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> module <a class="code" href="namespacesensors.html">sensors</a> {</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></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> <span class="comment"> * Switch is an actuator and an extension to StateSensor. </span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * An actuator actively outputs its state. In case of a Dry-Contact, </span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * for instance, the switch may output ON or OFF.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Because Switch is a StateSensor it is also possible to</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * query the actual state of the Switch.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * The type of switch is determined by the sensor's TypeSpec</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> */</span></div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="interfacesensors_1_1Switch__2__0__5.html"> 23</a></span>  <span class="keyword">interface </span><a class="code" href="interfacesensors_1_1Switch__2__0__5.html">Switch_2_0_5</a> <span class="keyword">extends</span> <a class="code" href="interfacesensors_1_1StateSensor__4__0__3.html">StateSensor_4_0_3</a> {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  constant <span class="keywordtype">int</span> ERR_INVALID_PARAMETER = 1;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  constant <span class="keywordtype">int</span> ERR_NOT_AVAILABLE = 2;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  constant <span class="keywordtype">int</span> ERR_PDC_POWER_LIMIT = 3;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /**</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * This method outputs the given value. The int input value</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * is the counterpart of the value returned by StateSensor's</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * getState method. Valid values are determined by the</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * StateSensor's TypeSpec</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * @param newState the new state the switch shall switch to</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * @return ERR_INVALID_PARAMETER if invalid parameter</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * @return ERR_NOT_AVAILABLE if unable to set new state</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> */</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">int</span> setState(in <span class="keywordtype">int</span> newState);</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"> /** SwitchEvent: new state set to switch via setState */</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  valueobject SwitchEvent extends <span class="keyword">event</span>.UserEvent {</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="interfacesensors_1_1Switch__2__0__5.html#acb155dcff10467e4a6e312bf7eb180aa"> 42</a></span>  <span class="keywordtype">int</span> targetState; <span class="comment">///< target state as set via setState</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span> };</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  };</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> }</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="interfacesensors_1_1Switch__2__0__5_html"><div class="ttname"><a href="interfacesensors_1_1Switch__2__0__5.html">sensors::Switch_2_0_5</a></div><div class="ttdoc">Switch is an actuator and an extension to StateSensor. </div><div class="ttdef"><b>Definition:</b> Switch.idl:23</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="interfacesensors_1_1StateSensor__4__0__3_html"><div class="ttname"><a href="interfacesensors_1_1StateSensor__4__0__3.html">sensors::StateSensor_4_0_3</a></div><div class="ttdoc">Sensor with discrete readings. </div><div class="ttdef"><b>Definition:</b> StateSensor.idl:43</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>
|
