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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XML-Security-C: DSIGReferenceList Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>DSIGReferenceList Class Reference<br>
<small>
[<a class="el" href="group__pubsig.html">Main Signature API</a>]</small>
</h1><code>#include <<a class="el" href="DSIGReferenceList_8hpp-source.html">DSIGReferenceList.hpp</a>></code>
<p>
<a href="classDSIGReferenceList-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Holds a list of reference elements.
<p>
The library holds a Signature's list of references using this class. Manifest lists are similarly held. Developers can obtain the list from the Signature library using <a class="el" href="classDSIGSignature.html#z46_2">DSIGSignature::getReferenceList</a> and then iterate through each reference.<p>
The library also uses the List as the owner of the memory associated with References. So when a list is deleted, the references are deleted at the same time.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< <a class="el" href="classDSIGReference.html">DSIGReference</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReferenceList.html#w0">ReferenceListVectorType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReferenceList.html#w1">size_type</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReferenceList.html#z40_0">DSIGReferenceList</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a list. <a href="#z40_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReferenceList.html#z40_1">~DSIGReferenceList</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a list. <a href="#z40_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">List manipulation</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReferenceList.html#z41_0">addReference</a> (<a class="el" href="classDSIGReference.html">DSIGReference</a> *ref)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a reference to the list. <a href="#z41_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGReference.html">DSIGReference</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReferenceList.html#z41_1">removeReference</a> (<a class="el" href="classDSIGReferenceList.html#w1">size_type</a> index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a reference from the list. <a href="#z41_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGReference.html">DSIGReference</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReferenceList.html#z41_2">item</a> (<a class="el" href="classDSIGReferenceList.html#w1">size_type</a> index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a reference from the list. <a href="#z41_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGReferenceList.html#w1">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReferenceList.html#z41_3">getSize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find the number of elements in the list. <a href="#z41_3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReferenceList.html#z41_4">empty</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear out the list. <a href="#z41_4"></a><br></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="w0" doxytag="DSIGReferenceList::ReferenceListVectorType"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">typedef std::vector<<a class="el" href="classDSIGReference.html">DSIGReference</a> *> <a class="el" href="classDSIGReferenceList.html#w0">DSIGReferenceList::ReferenceListVectorType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="w1" doxytag="DSIGReferenceList::size_type"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">typedef size_t <a class="el" href="classDSIGReferenceList.html#w1">DSIGReferenceList::size_type</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z40_0" doxytag="DSIGReferenceList::DSIGReferenceList"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">DSIGReferenceList::DSIGReferenceList </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct a list.
<p>
</td>
</tr>
</table>
<a class="anchor" name="z40_1" doxytag="DSIGReferenceList::~DSIGReferenceList"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">DSIGReferenceList::~DSIGReferenceList </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destroy a list.
<p>
Standard destructor to close down the list.<p>
<dl compact><dt><b>Note:</b></dt><dd>Destroys the references as well as the list </dd></dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z41_0" doxytag="DSIGReferenceList::addReference"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void DSIGReferenceList::addReference </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGReference.html">DSIGReference</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>ref</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add a reference to the list.
<p>
Appends the reference to the end of the list and takes ownership of associated memory. </td>
</tr>
</table>
<a class="anchor" name="z41_4" doxytag="DSIGReferenceList::empty"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool DSIGReferenceList::empty </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Clear out the list.
<p>
Simply clears the list. Does not delete the reference elements themselves. </td>
</tr>
</table>
<a class="anchor" name="z41_3" doxytag="DSIGReferenceList::getSize"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGReferenceList.html#w1">size_type</a> DSIGReferenceList::getSize </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Find the number of elements in the list.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The number of elements in the list </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z41_2" doxytag="DSIGReferenceList::item"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGReference.html">DSIGReference</a>* DSIGReferenceList::item </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGReferenceList.html#w1">size_type</a> </td>
<td class="mdname1" valign="top" nowrap> <em>index</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return a reference from the list.
<p>
Gets the reference at point index in the list<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>The pointer into the list </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z41_1" doxytag="DSIGReferenceList::removeReference"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGReference.html">DSIGReference</a>* DSIGReferenceList::removeReference </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGReferenceList.html#w1">size_type</a> </td>
<td class="mdname1" valign="top" nowrap> <em>index</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Remove a reference from the list.
<p>
Removes the reference at the index point and returns a pointer to the reference removed.<p>
<dl compact><dt><b>Note:</b></dt><dd>This also releases ownership. It is the responsibility of the caller to ensure the reference is deleted.<p>
This does not currently delete the reference from the Signature</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>Point in the list to remove </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DSIGReferenceList_8hpp-source.html">DSIGReferenceList.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:41:17 2005 for XML-Security-C by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
