File: structevent_1_1Engine__1__0__1_1_1Action.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 (118 lines) | stat: -rw-r--r-- 8,533 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
<!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::Action 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_1Action.html">Action</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structevent_1_1Engine__1__0__1_1_1Action-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">event::Engine_1_0_1::Action Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>An action is a tuple of 'id' (unique within the scope of this event engine), 'name' which is unique as well and used by the GUI as user readable identificator, 'isSystem' which denotes the action as system action, 'type' which defines what it is, and an argument vector that vary depending on type and which is passed to the action.  
 <a href="structevent_1_1Engine__1__0__1_1_1Action.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-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7d469d8a261519c06c4cc3762083d3b8"><td class="memItemLeft" align="right" valign="top"><a id="a7d469d8a261519c06c4cc3762083d3b8"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1Action.html#a7d469d8a261519c06c4cc3762083d3b8">id</a></td></tr>
<tr class="memdesc:a7d469d8a261519c06c4cc3762083d3b8"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structevent_1_1Engine__1__0__1_1_1Action.html" title="An action is a tuple of &#39;id&#39; (unique within the scope of this event engine), &#39;name&#39; which is unique a...">Action</a> ID. <br /></td></tr>
<tr class="separator:a7d469d8a261519c06c4cc3762083d3b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8608c595355ed5ad9bee82ccb13fa18e"><td class="memItemLeft" align="right" valign="top"><a id="a8608c595355ed5ad9bee82ccb13fa18e"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1Action.html#a8608c595355ed5ad9bee82ccb13fa18e">name</a></td></tr>
<tr class="memdesc:a8608c595355ed5ad9bee82ccb13fa18e"><td class="mdescLeft">&#160;</td><td class="mdescRight">User-defined name. <br /></td></tr>
<tr class="separator:a8608c595355ed5ad9bee82ccb13fa18e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0649f1cce90a3649d6201520ce72f08"><td class="memItemLeft" align="right" valign="top"><a id="aa0649f1cce90a3649d6201520ce72f08"></a>
boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1Action.html#aa0649f1cce90a3649d6201520ce72f08">isSystem</a></td></tr>
<tr class="memdesc:aa0649f1cce90a3649d6201520ce72f08"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>true</code> for system-defined actions <br /></td></tr>
<tr class="separator:aa0649f1cce90a3649d6201520ce72f08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c9e1341e298f287e2bc7ff0dad8bfe1"><td class="memItemLeft" align="right" valign="top"><a id="a1c9e1341e298f287e2bc7ff0dad8bfe1"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1Action.html#a1c9e1341e298f287e2bc7ff0dad8bfe1">type</a></td></tr>
<tr class="memdesc:a1c9e1341e298f287e2bc7ff0dad8bfe1"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structevent_1_1Engine__1__0__1_1_1Action.html" title="An action is a tuple of &#39;id&#39; (unique within the scope of this event engine), &#39;name&#39; which is unique a...">Action</a> type. <br /></td></tr>
<tr class="separator:a1c9e1341e298f287e2bc7ff0dad8bfe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a700034fc14da94ca0ae65450f5bd750f"><td class="memItemLeft" align="right" valign="top"><a id="a700034fc14da94ca0ae65450f5bd750f"></a>
vector&lt; <a class="el" href="structevent_1_1KeyValue.html">KeyValue</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine__1__0__1_1_1Action.html#a700034fc14da94ca0ae65450f5bd750f">arguments</a></td></tr>
<tr class="memdesc:a700034fc14da94ca0ae65450f5bd750f"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structevent_1_1Engine__1__0__1_1_1Action.html" title="An action is a tuple of &#39;id&#39; (unique within the scope of this event engine), &#39;name&#39; which is unique a...">Action</a> argument map. <br /></td></tr>
<tr class="separator:a700034fc14da94ca0ae65450f5bd750f"><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 action is a tuple of 'id' (unique within the scope of this event engine), 'name' which is unique as well and used by the GUI as user readable identificator, 'isSystem' which denotes the action as system action, 'type' which defines what it is, and an argument vector that vary depending on type and which is passed to the action. </p>
<p>The 'isSystem' flag is readonly and if set marks the action as not deletable. </p>
</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>