File: structevent_1_1Engine_1_1Action.html

package info (click to toggle)
raritan-json-rpc-sdk 4.0.20%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 57,236 kB
  • sloc: cs: 223,121; perl: 117,786; python: 26,872; javascript: 6,544; makefile: 27
file content (116 lines) | stat: -rw-r--r-- 8,489 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
<!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: event::Engine::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 / 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&amp;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&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.html">Engine</a></li><li class="navelem"><a class="el" href="structevent_1_1Engine_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_1Action-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">event::Engine::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_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:ae364b9774bd1ffd84ed66009bb595c30"><td class="memItemLeft" align="right" valign="top"><a id="ae364b9774bd1ffd84ed66009bb595c30"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Action.html#ae364b9774bd1ffd84ed66009bb595c30">id</a></td></tr>
<tr class="memdesc:ae364b9774bd1ffd84ed66009bb595c30"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structevent_1_1Engine_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:ae364b9774bd1ffd84ed66009bb595c30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2c904d6e01c48b9247e3e51f2b8a7a5"><td class="memItemLeft" align="right" valign="top"><a id="aa2c904d6e01c48b9247e3e51f2b8a7a5"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Action.html#aa2c904d6e01c48b9247e3e51f2b8a7a5">name</a></td></tr>
<tr class="memdesc:aa2c904d6e01c48b9247e3e51f2b8a7a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">User-defined name. <br /></td></tr>
<tr class="separator:aa2c904d6e01c48b9247e3e51f2b8a7a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11af2109ff17b2eddf04d7f7b39d97ed"><td class="memItemLeft" align="right" valign="top"><a id="a11af2109ff17b2eddf04d7f7b39d97ed"></a>
boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Action.html#a11af2109ff17b2eddf04d7f7b39d97ed">isSystem</a></td></tr>
<tr class="memdesc:a11af2109ff17b2eddf04d7f7b39d97ed"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>true</code> for system-defined actions <br /></td></tr>
<tr class="separator:a11af2109ff17b2eddf04d7f7b39d97ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f106833ce84846e3e3940bd3a4279fc"><td class="memItemLeft" align="right" valign="top"><a id="a7f106833ce84846e3e3940bd3a4279fc"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Action.html#a7f106833ce84846e3e3940bd3a4279fc">type</a></td></tr>
<tr class="memdesc:a7f106833ce84846e3e3940bd3a4279fc"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structevent_1_1Engine_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:a7f106833ce84846e3e3940bd3a4279fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada3e2283902114a9e4ff49698c0d4273"><td class="memItemLeft" align="right" valign="top"><a id="ada3e2283902114a9e4ff49698c0d4273"></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_1Action.html#ada3e2283902114a9e4ff49698c0d4273">arguments</a></td></tr>
<tr class="memdesc:ada3e2283902114a9e4ff49698c0d4273"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structevent_1_1Engine_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:ada3e2283902114a9e4ff49698c0d4273"><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><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 Mon Oct 17 2022 00:25:44 for Raritan / Server Technology Xerus™ PDU JSON-RPC API by&#160;<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>