File: structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.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 (132 lines) | stat: -rw-r--r-- 11,435 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
<!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: smartlock::DoorAccessControl::DoorAccessRule 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="namespacesmartlock.html">smartlock</a></li><li class="navelem"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html">DoorAccessControl</a></li><li class="navelem"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html">DoorAccessRule</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">smartlock::DoorAccessControl::DoorAccessRule Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Data representing a rule to control access to certain doors.  
 <a href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#details">More...</a></p>

<p><code>import&quot;<a class="el" href="DoorAccessControl_8idl_source.html">DoorAccessControl.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:ae53e2d7ac2260964452280d04697edd7"><td class="memItemLeft" align="right" valign="top"><a id="ae53e2d7ac2260964452280d04697edd7"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#ae53e2d7ac2260964452280d04697edd7">name</a></td></tr>
<tr class="memdesc:ae53e2d7ac2260964452280d04697edd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">A name to describe this rule. <br /></td></tr>
<tr class="separator:ae53e2d7ac2260964452280d04697edd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74a67f67678a4d237d5eb1d398aa2398"><td class="memItemLeft" align="right" valign="top"><a id="a74a67f67678a4d237d5eb1d398aa2398"></a>
vector&lt; <a class="el" href="interfaceperipheral_1_1DeviceSlot.html">peripheral::DeviceSlot</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#a74a67f67678a4d237d5eb1d398aa2398">doorHandleLocks</a></td></tr>
<tr class="memdesc:a74a67f67678a4d237d5eb1d398aa2398"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open these door handle locks. <br /></td></tr>
<tr class="separator:a74a67f67678a4d237d5eb1d398aa2398"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef955ce16492f16f59d6fe79ce17ac29"><td class="memItemLeft" align="right" valign="top"><a id="aef955ce16492f16f59d6fe79ce17ac29"></a>
<a class="el" href="structsmartlock_1_1DoorAccessControl_1_1CardCondition.html">CardCondition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#aef955ce16492f16f59d6fe79ce17ac29">cardCondition1</a></td></tr>
<tr class="memdesc:aef955ce16492f16f59d6fe79ce17ac29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Condition that has to be fulfilled when inserting a card. <br /></td></tr>
<tr class="separator:aef955ce16492f16f59d6fe79ce17ac29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace7ea6a87e7b01047ae932d24b8a80c1"><td class="memItemLeft" align="right" valign="top"><a id="ace7ea6a87e7b01047ae932d24b8a80c1"></a>
<a class="el" href="structsmartlock_1_1DoorAccessControl_1_1CardCondition.html">CardCondition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#ace7ea6a87e7b01047ae932d24b8a80c1">cardCondition2</a></td></tr>
<tr class="memdesc:ace7ea6a87e7b01047ae932d24b8a80c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Additional card condition that is needed. <br /></td></tr>
<tr class="separator:ace7ea6a87e7b01047ae932d24b8a80c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e84f32d57f6d8b595d3b81e79107322"><td class="memItemLeft" align="right" valign="top"><a id="a5e84f32d57f6d8b595d3b81e79107322"></a>
<a class="el" href="structsmartlock_1_1DoorAccessControl_1_1KeypadCondition.html">KeypadCondition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#a5e84f32d57f6d8b595d3b81e79107322">keypadCondition1</a></td></tr>
<tr class="memdesc:a5e84f32d57f6d8b595d3b81e79107322"><td class="mdescLeft">&#160;</td><td class="mdescRight">Condition that has to be fulfilled when using a keypad. <br /></td></tr>
<tr class="separator:a5e84f32d57f6d8b595d3b81e79107322"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d2edde1098747e0c84c9f3fbf9c5983"><td class="memItemLeft" align="right" valign="top"><a id="a9d2edde1098747e0c84c9f3fbf9c5983"></a>
<a class="el" href="structsmartlock_1_1DoorAccessControl_1_1KeypadCondition.html">KeypadCondition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#a9d2edde1098747e0c84c9f3fbf9c5983">keypadCondition2</a></td></tr>
<tr class="memdesc:a9d2edde1098747e0c84c9f3fbf9c5983"><td class="mdescLeft">&#160;</td><td class="mdescRight">Additional keypad condition that is needed. <br /></td></tr>
<tr class="separator:a9d2edde1098747e0c84c9f3fbf9c5983"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0aebacd64fe475b59c4c54d91c21bb9b"><td class="memItemLeft" align="right" valign="top"><a id="a0aebacd64fe475b59c4c54d91c21bb9b"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#a0aebacd64fe475b59c4c54d91c21bb9b">conditionsTimeout</a></td></tr>
<tr class="memdesc:a0aebacd64fe475b59c4c54d91c21bb9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timeout for matching multiple card / keypad conditions. <br /></td></tr>
<tr class="separator:a0aebacd64fe475b59c4c54d91c21bb9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a549168a6c9bbf9ce6c75372e15dd74fe"><td class="memItemLeft" align="right" valign="top"><a id="a549168a6c9bbf9ce6c75372e15dd74fe"></a>
<a class="el" href="structsmartlock_1_1DoorAccessControl_1_1AbsoluteTimeCondition.html">AbsoluteTimeCondition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#a549168a6c9bbf9ce6c75372e15dd74fe">absoluteTime</a></td></tr>
<tr class="memdesc:a549168a6c9bbf9ce6c75372e15dd74fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Absolute time range condition. <br /></td></tr>
<tr class="separator:a549168a6c9bbf9ce6c75372e15dd74fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2075f0af97bc037fa87340b51f893b73"><td class="memItemLeft" align="right" valign="top"><a id="a2075f0af97bc037fa87340b51f893b73"></a>
<a class="el" href="structsmartlock_1_1DoorAccessControl_1_1PeriodicTimeCondition.html">PeriodicTimeCondition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#a2075f0af97bc037fa87340b51f893b73">periodicTime</a></td></tr>
<tr class="memdesc:a2075f0af97bc037fa87340b51f893b73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Periodic time range condition. <br /></td></tr>
<tr class="separator:a2075f0af97bc037fa87340b51f893b73"><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>Data representing a rule to control access to certain doors. </p>
<p>Access is granted (i.e. the defined locks are opened) if the defined and enabled conditions are met. At least one <a class="el" href="structsmartlock_1_1DoorAccessControl_1_1CardCondition.html" title="A condition for specific cards and card readers.">CardCondition</a> or one <a class="el" href="structsmartlock_1_1DoorAccessControl_1_1KeypadCondition.html" title="A condition for keypads with a secret pin.">KeypadCondition</a> must be enabled. If multiple conditions are enabled, all conditions have to be met during the timeout that is defined in conditionsTimeout. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="DoorAccessControl_8idl_source.html">DoorAccessControl.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>