summaryrefslogtreecommitdiff
path: root/sigalatvision/doc/html/classTSortedCollection.html
blob: ac88d85b8e4dac44dd354e2774877d42df68a93e (plain)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>TSortedCollection class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>TSortedCollection  Class Reference</h1>Sorted, streamable collection of objects. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="objects_8h-source.html">objects.h</a>&gt;</code>
<p>
<p>Inheritance diagram for TSortedCollection::
<p><center><img src="classTSortedCollection.gif" usemap="#TSortedCollection_map" border="0"></center>
<map name="TSortedCollection_map">
<area href="classTNSSortedCollection.html" alt="TNSSortedCollection" shape="rect" coords="0,112,129,136">
<area href="classTCollection.html" alt="TCollection" shape="rect" coords="208,112,337,136">
<area href="classTNSCollection.html" alt="TNSCollection" shape="rect" coords="0,56,129,80">
<area href="classTNSCollection.html" alt="TNSCollection" shape="rect" coords="139,56,268,80">
<area href="classTStreamable.html" alt="TStreamable" shape="rect" coords="278,56,407,80">
<area href="classTObject.html" alt="TObject" shape="rect" coords="0,0,129,24">
<area href="classTObject.html" alt="TObject" shape="rect" coords="139,0,268,24">
<area href="classTFileCollection.html" alt="TFileCollection" shape="rect" coords="34,224,163,248">
<area href="classTStringCollection.html" alt="TStringCollection" shape="rect" coords="173,224,302,248">
<area href="classTResourceCollection.html" alt="TResourceCollection" shape="rect" coords="173,280,302,304">
</map>
<a href="classTSortedCollection-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classTSortedCollection.html#a0">TSortedCollection</a> (<a class="el" href="ttypes_8h.html#a5">ccIndex</a> aLimit, <a class="el" href="ttypes_8h.html#a5">ccIndex</a> aDelta)</td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>const char* const&nbsp;</td><td valign=bottom><a class="el" href="classTSortedCollection.html#p0">name</a></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classTSortedCollection.html#b0">TSortedCollection</a> (<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>)</td></tr>
<tr><td nowrap align=right valign=top>virtual void*&nbsp;</td><td valign=bottom><a class="el" href="classTSortedCollection.html#b1">read</a> (<a class="el" href="classipstream.html">ipstream</a> &amp;is)</td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classTSortedCollection.html#b2">write</a> (<a class="el" href="classopstream.html">opstream</a> &amp;os)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The abstract class TSortedCollection is a specialized derivative of both <a class="el" href="classTCollection.html">TCollection</a> and <a class="el" href="classTNSSortedCollection.html">TNSSortedCollection</a>. It implements streamable collections sorted by a key (with or without duplicates).
<p>
No instances of TSortedCollection are allowed. It exists solely as a base for other standard or user-defined derived classes. 
<p>

<p>
Definition at line <a class="el" href="objects_8h-source.html#l00449">449</a> of file <a class="el" href="objects_8h-source.html">objects.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="TSortedCollection::TSortedCollection"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
TSortedCollection::TSortedCollection (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="ttypes_8h.html#a5">ccIndex</a> <em>aLimit</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
<a class="el" href="ttypes_8h.html#a5">ccIndex</a> <em>aDelta</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Invokes the <a class="el" href="classTCollection.html">TCollection</a> constructor to set <a class="el" href="classTNSCollection.html#n1">count</a> and <a class="el" href="classTNSCollection.html#n0">items</a> data members to 0; calls setLimit(aLimit) to set the collection <a class="el" href="classTNSCollection.html#n2">limit</a> to `aLimit', then sets <a class="el" href="classTNSCollection.html#n3">delta</a> to `aDelta'. Note that ccIndex is a typedef of int.
<p>
<a class="el" href="classTNSSortedCollection.html#m0">duplicates</a> is set to False. If you want to allow duplicate keys, you must set <a class="el" href="classTNSSortedCollection.html#m0">duplicates</a> True. 
<p>
Definition at line <a class="el" href="objects_8h-source.html#l00461">461</a> of file <a class="el" href="objects_8h-source.html">objects.h</a>.    </td>
  </tr>
</table>
<a name="b0" doxytag="TSortedCollection::TSortedCollection"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
TSortedCollection::TSortedCollection (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>&nbsp;)<code> [protected]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Each streamable class needs a "builder" to allocate the correct memory for its objects together with the initialized vtable pointers. This is achieved by calling this constructor with an argument of type <a class="el" href="ttypes_8h.html#a14">StreamableInit</a>.     </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b1" doxytag="TSortedCollection::read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
void * TSortedCollection::read (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="classipstream.html">ipstream</a> &amp; <em>is</em>&nbsp;)<code> [protected, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Reads a sorted collection from the input stream `is'. 
<p>
Reimplemented from <a class="el" href="classTCollection.html#b1">TCollection</a>.    </td>
  </tr>
</table>
<a name="b2" doxytag="TSortedCollection::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
void TSortedCollection::write (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="classopstream.html">opstream</a> &amp; <em>os</em>&nbsp;)<code> [protected, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Writes the associated TSortedCollection object to the output stream `os'. 
<p>
Reimplemented from <a class="el" href="classTCollection.html#b2">TCollection</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="p0" doxytag="TSortedCollection::name"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
const char *const TSortedCollection::name<code> [static]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Undocumented. 
<p>
Reimplemented from <a class="el" href="classTCollection.html#p0">TCollection</a>.
<p>
Reimplemented in <a class="el" href="classTStringCollection.html#p0">TStringCollection</a>, <a class="el" href="classTResourceCollection.html#p0">TResourceCollection</a>, and <a class="el" href="classTFileCollection.html#p0">TFileCollection</a>.
<p>
Definition at line <a class="el" href="objects_8h-source.html#l00506">506</a> of file <a class="el" href="objects_8h-source.html">objects.h</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="objects_8h-source.html">objects.h</a></ul>
<hr><address><small>Generated at Sat Sep 22 20:19:34 2001 for TVision by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.8.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>