File: structevent_1_1Engine__1__0__1_1_1EventDesc.html

package info (click to toggle)
raritan-json-rpc-sdk 3.6.1%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 41,748 kB
  • sloc: cs: 162,629; perl: 85,818; python: 24,275; javascript: 5,937; makefile: 21
file content (157 lines) | stat: -rw-r--r-- 11,646 bytes parent folder | download
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
<!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: event::Engine_1_0_1::EventDesc 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 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&amp;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&amp;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="namespaceevent.html">event</a></li><li class="navelem"><a class="el" href="interfaceevent_1_1Engine__1__0__1.html">Engine_1_0_1</a></li><li class="navelem"><a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html">EventDesc</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structevent_1_1Engine__1__0__1_1_1EventDesc-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">event::Engine_1_0_1::EventDesc Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>An event descriptor.  
 <a href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#details">More...</a></p>

<p><code>import&quot;<a class="el" href="EventEngine_8idl_source.html">EventEngine.idl</a>&quot;;</code></p>
<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:afb4e2d50f9fe4c66103b375f4467158c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#afb4e2d50f9fe4c66103b375f4467158c">Type</a> { <a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#afb4e2d50f9fe4c66103b375f4467158ca91055098c40a949c2d0f3e6cf6550332">NODE</a>, 
<a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#afb4e2d50f9fe4c66103b375f4467158cab4cbf8942eb4fb0befd300d2c43310f4">DYN_NODE</a>, 
<a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#afb4e2d50f9fe4c66103b375f4467158caed0a939d0114bd1fbde327de9d6750f2">LEAF</a>
 }</td></tr>
<tr class="memdesc:afb4e2d50f9fe4c66103b375f4467158c"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a> descriptor type.  <a href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#afb4e2d50f9fe4c66103b375f4467158c">More...</a><br /></td></tr>
<tr class="separator:afb4e2d50f9fe4c66103b375f4467158c"><td class="memSeparator" colspan="2">&#160;</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:aa8085b63fbbbfd736b4e716b276c4235"><td class="memItemLeft" align="right" valign="top"><a id="aa8085b63fbbbfd736b4e716b276c4235"></a>
<a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#afb4e2d50f9fe4c66103b375f4467158c">Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#aa8085b63fbbbfd736b4e716b276c4235">eventDescType</a></td></tr>
<tr class="memdesc:aa8085b63fbbbfd736b4e716b276c4235"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a> descriptor type. <br /></td></tr>
<tr class="separator:aa8085b63fbbbfd736b4e716b276c4235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43cb95a3886740fc2b2dfbba3c08ce96"><td class="memItemLeft" align="right" valign="top"><a id="a43cb95a3886740fc2b2dfbba3c08ce96"></a>
<a class="el" href="structevent_1_1Event.html#a3562b6ee4c47d93d383559286be33174">Event::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#a43cb95a3886740fc2b2dfbba3c08ce96">eventType</a></td></tr>
<tr class="memdesc:a43cb95a3886740fc2b2dfbba3c08ce96"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a> type. <br /></td></tr>
<tr class="separator:a43cb95a3886740fc2b2dfbba3c08ce96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd123580e8b2870c5c40f13569257adf"><td class="memItemLeft" align="right" valign="top"><a id="acd123580e8b2870c5c40f13569257adf"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#acd123580e8b2870c5c40f13569257adf">dynNodeContext</a></td></tr>
<tr class="memdesc:acd123580e8b2870c5c40f13569257adf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dynamic node context. <br /></td></tr>
<tr class="separator:acd123580e8b2870c5c40f13569257adf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd2919d901073c79175795ae60dfbfb8"><td class="memItemLeft" align="right" valign="top"><a id="afd2919d901073c79175795ae60dfbfb8"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#afd2919d901073c79175795ae60dfbfb8">idComp</a></td></tr>
<tr class="memdesc:afd2919d901073c79175795ae60dfbfb8"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a> ID component. <br /></td></tr>
<tr class="separator:afd2919d901073c79175795ae60dfbfb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b19d4912cff140c536daf4411329bf5"><td class="memItemLeft" align="right" valign="top"><a id="a9b19d4912cff140c536daf4411329bf5"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#a9b19d4912cff140c536daf4411329bf5">name</a></td></tr>
<tr class="memdesc:a9b19d4912cff140c536daf4411329bf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">User-defined name. <br /></td></tr>
<tr class="separator:a9b19d4912cff140c536daf4411329bf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf79edba461a3ea37c9b19c27807c08e"><td class="memItemLeft" align="right" valign="top"><a id="abf79edba461a3ea37c9b19c27807c08e"></a>
vector&lt; <a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html">EventDesc</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#abf79edba461a3ea37c9b19c27807c08e">entries</a></td></tr>
<tr class="memdesc:abf79edba461a3ea37c9b19c27807c08e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Child nodes. <br /></td></tr>
<tr class="separator:abf79edba461a3ea37c9b19c27807c08e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An event descriptor. </p>
<p>In case eventDescType is LEAF then the descriptor refers to a 'real' event. In this case eventType is set and the entries vector is empty. Otherwise eventType is a don't care and the entries vector contains sub-entries. In case eventDescType is DYN_NODE then the dynNodeContext contains a key which is used to generate a dynamic node. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="afb4e2d50f9fe4c66103b375f4467158c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb4e2d50f9fe4c66103b375f4467158c">&#9670;&nbsp;</a></span>Type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structevent_1_1Engine__1__0__1_1_1EventDesc.html#afb4e2d50f9fe4c66103b375f4467158c">event::Engine_1_0_1::EventDesc::Type</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="structevent_1_1Event.html" title="Event has a type: a STATE event indicates that a boolean state has been changed, i.e. ">Event</a> descriptor type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="afb4e2d50f9fe4c66103b375f4467158ca91055098c40a949c2d0f3e6cf6550332"></a>NODE&#160;</td><td class="fielddoc"><p>Intermediate node. </p>
</td></tr>
<tr><td class="fieldname"><a id="afb4e2d50f9fe4c66103b375f4467158cab4cbf8942eb4fb0befd300d2c43310f4"></a>DYN_NODE&#160;</td><td class="fielddoc"><p>Dynamic node. </p>
</td></tr>
<tr><td class="fieldname"><a id="afb4e2d50f9fe4c66103b375f4467158caed0a939d0114bd1fbde327de9d6750f2"></a>LEAF&#160;</td><td class="fielddoc"><p>Leaf node. </p>
</td></tr>
</table>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="EventEngine_8idl_source.html">EventEngine.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>