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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
|
<!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 Interface 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="namespacesmartlock.html">smartlock</a></li><li class="navelem"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html">DoorAccessControl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfacesmartlock_1_1DoorAccessControl-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">smartlock::DoorAccessControl Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Access control for door locks.
<a href="interfacesmartlock_1_1DoorAccessControl.html#details">More...</a></p>
<p><code>import"<a class="el" href="DoorAccessControl_8idl_source.html">DoorAccessControl.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1AbsoluteTimeCondition.html">AbsoluteTimeCondition</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A condition representing an absolute time range. <a href="structsmartlock_1_1DoorAccessControl_1_1AbsoluteTimeCondition.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1CardCondition.html">CardCondition</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A condition for specific cards and card readers. <a href="structsmartlock_1_1DoorAccessControl_1_1CardCondition.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1CardReaderInfo.html">CardReaderInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Information in order to refer to a specific card reader. <a href="structsmartlock_1_1DoorAccessControl_1_1CardReaderInfo.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessDeniedEvent.html">DoorAccessDeniedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: Door access denied. <a href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessDeniedEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessGrantedEvent.html">DoorAccessGrantedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: Door access granted. <a href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessGrantedEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html">DoorAccessRule</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Data representing a rule to control access to certain doors. <a href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRuleAddedEvent.html">DoorAccessRuleAddedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: Door access rule added. <a href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRuleAddedEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRuleChangedEvent.html">DoorAccessRuleChangedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: Door access rule modified. <a href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRuleChangedEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRuleDeletedEvent.html">DoorAccessRuleDeletedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: Door access rule deleted. <a href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRuleDeletedEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1KeypadCondition.html">KeypadCondition</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A condition for keypads with a secret pin. <a href="structsmartlock_1_1DoorAccessControl_1_1KeypadCondition.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1KeypadInfo.html">KeypadInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Information in order to refer to a specific keypad. <a href="structsmartlock_1_1DoorAccessControl_1_1KeypadInfo.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsmartlock_1_1DoorAccessControl_1_1PeriodicTimeCondition.html">PeriodicTimeCondition</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A condition representing a periodic time range. <a href="structsmartlock_1_1DoorAccessControl_1_1PeriodicTimeCondition.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a8443a90e0f140c1dfdd91d315b885b38"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#a8443a90e0f140c1dfdd91d315b885b38">DoorAccessDenialReason</a> { <a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#a8443a90e0f140c1dfdd91d315b885b38a2a2528e2ed9c61fccab23fef3256280c">DENIED_NO_MATCHING_RULE</a>
, <a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#a8443a90e0f140c1dfdd91d315b885b38ae4b78e4ffa035dce64052cde2129500e">DENIED_ABSOLUTE_TIME_CONDITION</a>
, <a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#a8443a90e0f140c1dfdd91d315b885b38ae85dba4b2c8644225f4955425212bb39">DENIED_PERIODIC_TIME_CONDITION</a>
, <a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#a8443a90e0f140c1dfdd91d315b885b38a589329390e3a697765672e8bc697281c">DENIED_CONDITIONS_TIMEOUT</a>
}</td></tr>
<tr class="memdesc:a8443a90e0f140c1dfdd91d315b885b38"><td class="mdescLeft"> </td><td class="mdescRight">Door Access Denial Reason. <a href="interfacesmartlock_1_1DoorAccessControl.html#a8443a90e0f140c1dfdd91d315b885b38">More...</a><br /></td></tr>
<tr class="separator:a8443a90e0f140c1dfdd91d315b885b38"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a637fe08671b55cdea3f88da376c23c20"><td class="memItemLeft" align="right" valign="top">map< int, <a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html">DoorAccessRule</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#a637fe08671b55cdea3f88da376c23c20">getDoorAccessRules</a> ()</td></tr>
<tr class="memdesc:a637fe08671b55cdea3f88da376c23c20"><td class="mdescLeft"> </td><td class="mdescRight">Get all stored door access control rules. <a href="interfacesmartlock_1_1DoorAccessControl.html#a637fe08671b55cdea3f88da376c23c20">More...</a><br /></td></tr>
<tr class="separator:a637fe08671b55cdea3f88da376c23c20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cf5bd79478e274ca8b8ac8b4f8a86af"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#a0cf5bd79478e274ca8b8ac8b4f8a86af">setAllDoorAccessRules</a> (in map< int, <a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html">DoorAccessRule</a> > rules, out vector< int > invalidRuleIds)</td></tr>
<tr class="memdesc:a0cf5bd79478e274ca8b8ac8b4f8a86af"><td class="mdescLeft"> </td><td class="mdescRight">Replace all the currently existing rules. <a href="interfacesmartlock_1_1DoorAccessControl.html#a0cf5bd79478e274ca8b8ac8b4f8a86af">More...</a><br /></td></tr>
<tr class="separator:a0cf5bd79478e274ca8b8ac8b4f8a86af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac89de9db56534c95e7e811c710bc6be2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#ac89de9db56534c95e7e811c710bc6be2">addDoorAccessRule</a> (in <a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html">DoorAccessRule</a> rule, out int ruleId)</td></tr>
<tr class="memdesc:ac89de9db56534c95e7e811c710bc6be2"><td class="mdescLeft"> </td><td class="mdescRight">Add a door access control rule. <a href="interfacesmartlock_1_1DoorAccessControl.html#ac89de9db56534c95e7e811c710bc6be2">More...</a><br /></td></tr>
<tr class="separator:ac89de9db56534c95e7e811c710bc6be2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5a9bcebd13695ef38a11466b6d8f3d2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#ae5a9bcebd13695ef38a11466b6d8f3d2">modifyDoorAccessRule</a> (in int id, in <a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html">DoorAccessRule</a> modifiedRule)</td></tr>
<tr class="memdesc:ae5a9bcebd13695ef38a11466b6d8f3d2"><td class="mdescLeft"> </td><td class="mdescRight">Modify an existing door access control rule. <a href="interfacesmartlock_1_1DoorAccessControl.html#ae5a9bcebd13695ef38a11466b6d8f3d2">More...</a><br /></td></tr>
<tr class="separator:ae5a9bcebd13695ef38a11466b6d8f3d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab599f2824b6c7b696185e3ad11486b28"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#ab599f2824b6c7b696185e3ad11486b28">deleteDoorAccessRule</a> (in int id)</td></tr>
<tr class="memdesc:ab599f2824b6c7b696185e3ad11486b28"><td class="mdescLeft"> </td><td class="mdescRight">Delete an existing door access control rule. <a href="interfacesmartlock_1_1DoorAccessControl.html#ab599f2824b6c7b696185e3ad11486b28">More...</a><br /></td></tr>
<tr class="separator:ab599f2824b6c7b696185e3ad11486b28"><td class="memSeparator" colspan="2"> </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:a90a5329f73321314a499a08ac5c24f07"><td class="memItemLeft" align="right" valign="top"><a id="a90a5329f73321314a499a08ac5c24f07"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#a90a5329f73321314a499a08ac5c24f07">ERR_INVALID_SETTINGS</a> = 1</td></tr>
<tr class="memdesc:a90a5329f73321314a499a08ac5c24f07"><td class="mdescLeft"> </td><td class="mdescRight">Invalid settings. <br /></td></tr>
<tr class="separator:a90a5329f73321314a499a08ac5c24f07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac193535d02266decbed4650a7f5cc55a"><td class="memItemLeft" align="right" valign="top"><a id="ac193535d02266decbed4650a7f5cc55a"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#ac193535d02266decbed4650a7f5cc55a">ERR_NO_SUCH_ID</a> = 2</td></tr>
<tr class="memdesc:ac193535d02266decbed4650a7f5cc55a"><td class="mdescLeft"> </td><td class="mdescRight">No such ID. <br /></td></tr>
<tr class="separator:ac193535d02266decbed4650a7f5cc55a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4b14676d02a7861710d62883add913c"><td class="memItemLeft" align="right" valign="top"><a id="ac4b14676d02a7861710d62883add913c"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#ac4b14676d02a7861710d62883add913c">ERR_MAX_RULES_REACHED</a> = 3</td></tr>
<tr class="memdesc:ac4b14676d02a7861710d62883add913c"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of rules. <br /></td></tr>
<tr class="separator:ac4b14676d02a7861710d62883add913c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Access control for door locks. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a8443a90e0f140c1dfdd91d315b885b38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8443a90e0f140c1dfdd91d315b885b38">◆ </a></span>DoorAccessDenialReason</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacesmartlock_1_1DoorAccessControl.html#a8443a90e0f140c1dfdd91d315b885b38">smartlock::DoorAccessControl::DoorAccessDenialReason</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Door Access Denial Reason. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a8443a90e0f140c1dfdd91d315b885b38a2a2528e2ed9c61fccab23fef3256280c"></a>DENIED_NO_MATCHING_RULE </td><td class="fielddoc"><p>No rule that matches the triggering event. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8443a90e0f140c1dfdd91d315b885b38ae4b78e4ffa035dce64052cde2129500e"></a>DENIED_ABSOLUTE_TIME_CONDITION </td><td class="fielddoc"><p>Absolute time condition was not met. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8443a90e0f140c1dfdd91d315b885b38ae85dba4b2c8644225f4955425212bb39"></a>DENIED_PERIODIC_TIME_CONDITION </td><td class="fielddoc"><p>Periodic time condition was not met. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8443a90e0f140c1dfdd91d315b885b38a589329390e3a697765672e8bc697281c"></a>DENIED_CONDITIONS_TIMEOUT </td><td class="fielddoc"><p>A needed condition was not fulfilled during conditionsTimeout. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac89de9db56534c95e7e811c710bc6be2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac89de9db56534c95e7e811c710bc6be2">◆ </a></span>addDoorAccessRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int smartlock::DoorAccessControl::addDoorAccessRule </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html">DoorAccessRule</a> </td>
<td class="paramname"><em>rule</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out int </td>
<td class="paramname"><em>ruleId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a door access control rule. </p>
<p>If successful, the id of the new rule will be returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rule</td><td>the new rule</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if rule has invalid values </dd>
<dd>
3 if maximum number of rules reached </dd></dl>
</div>
</div>
<a id="ab599f2824b6c7b696185e3ad11486b28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab599f2824b6c7b696185e3ad11486b28">◆ </a></span>deleteDoorAccessRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int smartlock::DoorAccessControl::deleteDoorAccessRule </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete an existing door access control rule. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>id of the rule to delete</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
2 if no rule with this id </dd></dl>
</div>
</div>
<a id="a637fe08671b55cdea3f88da376c23c20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a637fe08671b55cdea3f88da376c23c20">◆ </a></span>getDoorAccessRules()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">map<int, <a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html">DoorAccessRule</a>> smartlock::DoorAccessControl::getDoorAccessRules </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all stored door access control rules. </p>
<dl class="section return"><dt>Returns</dt><dd>list of rules by id </dd></dl>
</div>
</div>
<a id="ae5a9bcebd13695ef38a11466b6d8f3d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5a9bcebd13695ef38a11466b6d8f3d2">◆ </a></span>modifyDoorAccessRule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int smartlock::DoorAccessControl::modifyDoorAccessRule </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html">DoorAccessRule</a> </td>
<td class="paramname"><em>modifiedRule</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Modify an existing door access control rule. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>id of the rule to modify </td></tr>
<tr><td class="paramname">modifiedRule</td><td>rule containing the new settings</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if modifiedRule has invalid values </dd>
<dd>
2 if no rule with this id </dd></dl>
</div>
</div>
<a id="a0cf5bd79478e274ca8b8ac8b4f8a86af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cf5bd79478e274ca8b8ac8b4f8a86af">◆ </a></span>setAllDoorAccessRules()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int smartlock::DoorAccessControl::setAllDoorAccessRules </td>
<td>(</td>
<td class="paramtype">in map< int, <a class="el" href="structsmartlock_1_1DoorAccessControl_1_1DoorAccessRule.html">DoorAccessRule</a> > </td>
<td class="paramname"><em>rules</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out vector< int > </td>
<td class="paramname"><em>invalidRuleIds</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Replace all the currently existing rules. </p>
<p>Note that this not only adds and modifies rules, but also deletes existing rules that are not present in the given rule set.</p>
<p>In case of any rule being invalid, no changes will be made at all.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rules</td><td>the new rule set </td></tr>
<tr><td class="paramname">invalidRules</td><td>in case of an error, return ids of invalid rules</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if the rule set contains a rule with invalid values </dd></dl>
</div>
</div>
<hr/>The documentation for this interface 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 <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>
|
