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
|
<!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::Rule 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&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&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_1Rule.html">Rule</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> |
<a href="structevent_1_1Engine_1_1Rule-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">event::Engine::Rule Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="structevent_1_1Engine_1_1Rule.html" title="A Rule binds an action to a condition.">Rule</a> binds an action to a condition.
<a href="structevent_1_1Engine_1_1Rule.html#details">More...</a></p>
<p><code>import"<a class="el" href="EventEngine_8idl_source.html">EventEngine.idl</a>";</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:aa50310b6afeab950426519f7c54b7127"><td class="memItemLeft" align="right" valign="top"><a id="aa50310b6afeab950426519f7c54b7127"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Rule.html#aa50310b6afeab950426519f7c54b7127">id</a></td></tr>
<tr class="memdesc:aa50310b6afeab950426519f7c54b7127"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structevent_1_1Engine_1_1Rule.html" title="A Rule binds an action to a condition.">Rule</a> ID. <br /></td></tr>
<tr class="separator:aa50310b6afeab950426519f7c54b7127"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2821853e72a14e7fc44e95b9409275a"><td class="memItemLeft" align="right" valign="top"><a id="aa2821853e72a14e7fc44e95b9409275a"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Rule.html#aa2821853e72a14e7fc44e95b9409275a">name</a></td></tr>
<tr class="memdesc:aa2821853e72a14e7fc44e95b9409275a"><td class="mdescLeft"> </td><td class="mdescRight">User-defined name. <br /></td></tr>
<tr class="separator:aa2821853e72a14e7fc44e95b9409275a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87a0c74942e05b4b20a78b1c2ec58fd4"><td class="memItemLeft" align="right" valign="top"><a id="a87a0c74942e05b4b20a78b1c2ec58fd4"></a>
boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Rule.html#a87a0c74942e05b4b20a78b1c2ec58fd4">isSystem</a></td></tr>
<tr class="memdesc:a87a0c74942e05b4b20a78b1c2ec58fd4"><td class="mdescLeft"> </td><td class="mdescRight"><code>true</code> for system-defined rules <br /></td></tr>
<tr class="separator:a87a0c74942e05b4b20a78b1c2ec58fd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2004173b3447306d216c618d9a4ece1c"><td class="memItemLeft" align="right" valign="top"><a id="a2004173b3447306d216c618d9a4ece1c"></a>
boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Rule.html#a2004173b3447306d216c618d9a4ece1c">isEnabled</a></td></tr>
<tr class="memdesc:a2004173b3447306d216c618d9a4ece1c"><td class="mdescLeft"> </td><td class="mdescRight"><code>true</code> if the rule is enabled <br /></td></tr>
<tr class="separator:a2004173b3447306d216c618d9a4ece1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac12ad5dc9dc92b838ecb95f21d465260"><td class="memItemLeft" align="right" valign="top"><a id="ac12ad5dc9dc92b838ecb95f21d465260"></a>
boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Rule.html#ac12ad5dc9dc92b838ecb95f21d465260">isAutoRearm</a></td></tr>
<tr class="memdesc:ac12ad5dc9dc92b838ecb95f21d465260"><td class="mdescLeft"> </td><td class="mdescRight"><code>true</code> for auto-rearming rules <br /></td></tr>
<tr class="separator:ac12ad5dc9dc92b838ecb95f21d465260"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b4b193a1c1e2acbd6c1cb793c912527"><td class="memItemLeft" align="right" valign="top"><a id="a2b4b193a1c1e2acbd6c1cb793c912527"></a>
boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Rule.html#a2b4b193a1c1e2acbd6c1cb793c912527">hasMatched</a></td></tr>
<tr class="memdesc:a2b4b193a1c1e2acbd6c1cb793c912527"><td class="mdescLeft"> </td><td class="mdescRight"><code>true</code> if the rule has matched since being armed <br /></td></tr>
<tr class="separator:a2b4b193a1c1e2acbd6c1cb793c912527"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff2485de5cf1cf800736a389a9f65396"><td class="memItemLeft" align="right" valign="top"><a id="aff2485de5cf1cf800736a389a9f65396"></a>
<a class="el" href="structevent_1_1Engine_1_1Condition.html">Condition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Rule.html#aff2485de5cf1cf800736a389a9f65396">condition</a></td></tr>
<tr class="memdesc:aff2485de5cf1cf800736a389a9f65396"><td class="mdescLeft"> </td><td class="mdescRight">Trigger condition. <br /></td></tr>
<tr class="separator:aff2485de5cf1cf800736a389a9f65396"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a096da7c22fce31f4d3d964df0f797904"><td class="memItemLeft" align="right" valign="top"><a id="a096da7c22fce31f4d3d964df0f797904"></a>
vector< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Rule.html#a096da7c22fce31f4d3d964df0f797904">actionIds</a></td></tr>
<tr class="memdesc:a096da7c22fce31f4d3d964df0f797904"><td class="mdescLeft"> </td><td class="mdescRight">List of action IDs. <br /></td></tr>
<tr class="separator:a096da7c22fce31f4d3d964df0f797904"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b0df30ab446db32c1e7af6f60aa18f2"><td class="memItemLeft" align="right" valign="top"><a id="a8b0df30ab446db32c1e7af6f60aa18f2"></a>
vector< <a class="el" href="structevent_1_1KeyValue.html">KeyValue</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structevent_1_1Engine_1_1Rule.html#a8b0df30ab446db32c1e7af6f60aa18f2">arguments</a></td></tr>
<tr class="memdesc:a8b0df30ab446db32c1e7af6f60aa18f2"><td class="mdescLeft"> </td><td class="mdescRight">Argument map. <br /></td></tr>
<tr class="separator:a8b0df30ab446db32c1e7af6f60aa18f2"><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 <a class="el" href="structevent_1_1Engine_1_1Rule.html" title="A Rule binds an action to a condition.">Rule</a> binds an action to a condition. </p>
<p>The 'id' is an unique identification within the scope of this event engine. The 'name' is unique as well and used by the GUI as user readable identificator. The flag 'isAutoRearm' determines whether actions are triggered again after condition reoccurres. The 'hasMatched' flag is true if the condition was true once and the rule is not rearmed yet. The 'isSystem' flag is readonly and if set marks the action as not deletable. The 'actionIds' are the actions to perform if the rule evaluates to true. The arguments are passed to the actions. </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 <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>
|
