summaryrefslogtreecommitdiff
path: root/old/dw/html/classlout_1_1identity_1_1IdentifiableObject.html
blob: a82090f2da929e0a4d0c78600527055ffe1be911 (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
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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.8"/>
<title>Dillo: lout::identity::IdentifiableObject Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="https://www.dillo.org/dw/html/jquery.js"></script>
<script type="text/javascript" src="dynsections.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 style="padding-left: 0.5em;">
   <div id="projectname">Dillo
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacelout.html">lout</a></li><li class="navelem"><a class="el" href="namespacelout_1_1identity.html">identity</a></li><li class="navelem"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html">IdentifiableObject</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classlout_1_1identity_1_1IdentifiableObject.html#nested-classes">Classes</a> &#124;
<a href="classlout_1_1identity_1_1IdentifiableObject.html#pub-methods">Public Member Functions</a> &#124;
<a href="classlout_1_1identity_1_1IdentifiableObject.html#pro-methods">Protected Member Functions</a> &#124;
<a href="classlout_1_1identity_1_1IdentifiableObject.html#pri-attribs">Private Attributes</a> &#124;
<a href="classlout_1_1identity_1_1IdentifiableObject.html#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classlout_1_1identity_1_1IdentifiableObject-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">lout::identity::IdentifiableObject Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Instances of classes, which are sub classes of this class, may be identified at run-time.  
 <a href="classlout_1_1identity_1_1IdentifiableObject.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="identity_8hh_source.html">identity.hh</a>&gt;</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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject_1_1Class.html">Class</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a31c98db27c4bc38ba30ba0e4e1a23066"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a31c98db27c4bc38ba30ba0e4e1a23066">IdentifiableObject</a> ()</td></tr>
<tr class="separator:a31c98db27c4bc38ba30ba0e4e1a23066"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec2a59a4bf234606c2eb5231d1f048d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#aec2a59a4bf234606c2eb5231d1f048d5">intoStringBuffer</a> (<a class="el" href="classlout_1_1misc_1_1StringBuffer.html">misc::StringBuffer</a> *sb)</td></tr>
<tr class="memdesc:aec2a59a4bf234606c2eb5231d1f048d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Store a textual representation of the object in a <a class="el" href="classlout_1_1misc_1_1StringBuffer.html" title="A class for fast concatenation of a large number of strings. ">misc::StringBuffer</a>.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#aec2a59a4bf234606c2eb5231d1f048d5">More...</a><br /></td></tr>
<tr class="separator:aec2a59a4bf234606c2eb5231d1f048d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a491c1367ff6783a0647522f0a68ae054"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a491c1367ff6783a0647522f0a68ae054">getClassId</a> ()</td></tr>
<tr class="memdesc:a491c1367ff6783a0647522f0a68ae054"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the class identifier.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#a491c1367ff6783a0647522f0a68ae054">More...</a><br /></td></tr>
<tr class="separator:a491c1367ff6783a0647522f0a68ae054"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e862eb04821e4bbf0cee0d5d58b7752"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a6e862eb04821e4bbf0cee0d5d58b7752">getClassName</a> ()</td></tr>
<tr class="memdesc:a6e862eb04821e4bbf0cee0d5d58b7752"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the name, under which the class of this object was registered.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#a6e862eb04821e4bbf0cee0d5d58b7752">More...</a><br /></td></tr>
<tr class="separator:a6e862eb04821e4bbf0cee0d5d58b7752"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c838c41d8044c9eeffa790592f85ce9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a4c838c41d8044c9eeffa790592f85ce9">instanceOf</a> (int otherClassId)</td></tr>
<tr class="memdesc:a4c838c41d8044c9eeffa790592f85ce9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns, whether this class is an instance of the class, given by <em>otherClassId</em>, or of a sub class of this class.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#a4c838c41d8044c9eeffa790592f85ce9">More...</a><br /></td></tr>
<tr class="separator:a4c838c41d8044c9eeffa790592f85ce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlout_1_1object_1_1Object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlout_1_1object_1_1Object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlout_1_1object_1_1Object.html">lout::object::Object</a></td></tr>
<tr class="memitem:a9fef8a29a41124cb0370f4dc0410fb5b inherit pub_methods_classlout_1_1object_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1object_1_1Object.html#a9fef8a29a41124cb0370f4dc0410fb5b">~Object</a> ()</td></tr>
<tr class="memdesc:a9fef8a29a41124cb0370f4dc0410fb5b inherit pub_methods_classlout_1_1object_1_1Object"><td class="mdescLeft">&#160;</td><td class="mdescRight">The destructor is defined as virtual (but not abstract), so that destruction of <a class="el" href="classlout_1_1object_1_1Object.html" title="This is the base class for many other classes, which defines very common virtual methods. ">Object</a>'s works properly.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#a9fef8a29a41124cb0370f4dc0410fb5b">More...</a><br /></td></tr>
<tr class="separator:a9fef8a29a41124cb0370f4dc0410fb5b inherit pub_methods_classlout_1_1object_1_1Object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4bc95cee49a71d32c7b24505ccc9397 inherit pub_methods_classlout_1_1object_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1object_1_1Object.html#af4bc95cee49a71d32c7b24505ccc9397">equals</a> (<a class="el" href="classlout_1_1object_1_1Object.html">Object</a> *other)</td></tr>
<tr class="memdesc:af4bc95cee49a71d32c7b24505ccc9397 inherit pub_methods_classlout_1_1object_1_1Object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns, whether two objects are equal.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#af4bc95cee49a71d32c7b24505ccc9397">More...</a><br /></td></tr>
<tr class="separator:af4bc95cee49a71d32c7b24505ccc9397 inherit pub_methods_classlout_1_1object_1_1Object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad81c4136418c9b44253568f9ae069006 inherit pub_methods_classlout_1_1object_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1object_1_1Object.html#ad81c4136418c9b44253568f9ae069006">hashValue</a> ()</td></tr>
<tr class="memdesc:ad81c4136418c9b44253568f9ae069006 inherit pub_methods_classlout_1_1object_1_1Object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a hash value for the object.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#ad81c4136418c9b44253568f9ae069006">More...</a><br /></td></tr>
<tr class="separator:ad81c4136418c9b44253568f9ae069006 inherit pub_methods_classlout_1_1object_1_1Object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ab36efad0df9a036b9252a9564a8cd4 inherit pub_methods_classlout_1_1object_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlout_1_1object_1_1Object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1object_1_1Object.html#a7ab36efad0df9a036b9252a9564a8cd4">clone</a> ()</td></tr>
<tr class="memdesc:a7ab36efad0df9a036b9252a9564a8cd4 inherit pub_methods_classlout_1_1object_1_1Object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an exact copy of the object.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#a7ab36efad0df9a036b9252a9564a8cd4">More...</a><br /></td></tr>
<tr class="separator:a7ab36efad0df9a036b9252a9564a8cd4 inherit pub_methods_classlout_1_1object_1_1Object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7aeadc7934293197110d550abda81ff inherit pub_methods_classlout_1_1object_1_1Object"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1object_1_1Object.html#ad7aeadc7934293197110d550abda81ff">toString</a> ()</td></tr>
<tr class="memdesc:ad7aeadc7934293197110d550abda81ff inherit pub_methods_classlout_1_1object_1_1Object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use <a class="el" href="classlout_1_1object_1_1Object.html#ad1ad2f2b36fc7a7bead883caa64b0082" title="Store a textual representation of the object in a misc::StringBuffer. ">object::Object::intoStringBuffer</a> to return a textual representation of the object.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#ad7aeadc7934293197110d550abda81ff">More...</a><br /></td></tr>
<tr class="separator:ad7aeadc7934293197110d550abda81ff inherit pub_methods_classlout_1_1object_1_1Object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b53443ca61b25e794157792f5d3a956 inherit pub_methods_classlout_1_1object_1_1Object"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1object_1_1Object.html#a8b53443ca61b25e794157792f5d3a956">sizeOf</a> ()</td></tr>
<tr class="memdesc:a8b53443ca61b25e794157792f5d3a956 inherit pub_methods_classlout_1_1object_1_1Object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of bytes, this object totally uses.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#a8b53443ca61b25e794157792f5d3a956">More...</a><br /></td></tr>
<tr class="separator:a8b53443ca61b25e794157792f5d3a956 inherit pub_methods_classlout_1_1object_1_1Object"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aeb1a57d39e3e06c92433e81457661185"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#aeb1a57d39e3e06c92433e81457661185">registerName</a> (const char *className, int *<a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#ab501458f58f97a1c14f335270a1d25d1">classId</a>)</td></tr>
<tr class="memdesc:aeb1a57d39e3e06c92433e81457661185"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method must be called in the constructor for the sub class. See class comment for details.  <a href="classlout_1_1identity_1_1IdentifiableObject.html#aeb1a57d39e3e06c92433e81457661185">More...</a><br /></td></tr>
<tr class="separator:aeb1a57d39e3e06c92433e81457661185"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ab501458f58f97a1c14f335270a1d25d1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#ab501458f58f97a1c14f335270a1d25d1">classId</a></td></tr>
<tr class="separator:ab501458f58f97a1c14f335270a1d25d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:a01a41dd85075aced5c96dc440d04f375"><td class="memItemLeft" align="right" valign="top">static <br class="typebreak" />
<a class="el" href="classlout_1_1container_1_1typed_1_1HashTable.html">container::typed::HashTable</a><br class="typebreak" />
&lt; <a class="el" href="classlout_1_1object_1_1ConstString.html">object::ConstString</a>, <a class="el" href="classlout_1_1identity_1_1IdentifiableObject_1_1Class.html">Class</a> &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a01a41dd85075aced5c96dc440d04f375">classesByName</a></td></tr>
<tr class="separator:a01a41dd85075aced5c96dc440d04f375"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97ac9a144380eed8007d3a43cff5b2df"><td class="memItemLeft" align="right" valign="top">static <br class="typebreak" />
<a class="el" href="classlout_1_1container_1_1typed_1_1Vector.html">container::typed::Vector</a><br class="typebreak" />
&lt; <a class="el" href="classlout_1_1identity_1_1IdentifiableObject_1_1Class.html">Class</a> &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a97ac9a144380eed8007d3a43cff5b2df">classesById</a></td></tr>
<tr class="separator:a97ac9a144380eed8007d3a43cff5b2df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48c0cf7f73a602ae14ac5de6b18c0174"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classlout_1_1identity_1_1IdentifiableObject_1_1Class.html">Class</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a48c0cf7f73a602ae14ac5de6b18c0174">currentlyConstructedClass</a></td></tr>
<tr class="separator:a48c0cf7f73a602ae14ac5de6b18c0174"><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>Instances of classes, which are sub classes of this class, may be identified at run-time. </p>
<h3>Testing the class</h3>
<p>Since e.g. <a class="el" href="classdw_1_1Textblock.html" title="A Widget for rendering text blocks, i.e. paragraphs or sequences of paragraphs. ">dw::Textblock</a> is a sub class of <a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html" title="Instances of classes, which are sub classes of this class, may be identified at run-time. ">IdentifiableObject</a>, and implemented in the correct way (as described below), for any given <a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html" title="Instances of classes, which are sub classes of this class, may be identified at run-time. ">IdentifiableObject</a> the following test can be done:</p>
<div class="fragment"><div class="line">identity::IdentifiableObject *o;</div>
<div class="line"><span class="comment">// ...</span></div>
<div class="line"><span class="keywordtype">bool</span> isATextblock = o-&gt;instanceOf(<a class="code" href="classdw_1_1Textblock.html#abd63ce25e16de6387fb0df3704215c59">dw::Textblock::CLASS_ID</a>);</div>
</div><!-- fragment --><p><em>isATextblock</em> is true, when <em>o</em> is an instance of <a class="el" href="classdw_1_1Textblock.html" title="A Widget for rendering text blocks, i.e. paragraphs or sequences of paragraphs. ">dw::Textblock</a>, or of a sub class of <a class="el" href="classdw_1_1Textblock.html" title="A Widget for rendering text blocks, i.e. paragraphs or sequences of paragraphs. ">dw::Textblock</a>. Otherwise, <em>isATextblock</em> is false.</p>
<p>It is also possible to get the class identifier of an <a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html" title="Instances of classes, which are sub classes of this class, may be identified at run-time. ">identity::IdentifiableObject</a>, e.g.</p>
<div class="fragment"><div class="line"><span class="keywordtype">bool</span> isOnlyATextblock = o-&gt;getClassId() == <a class="code" href="classdw_1_1Textblock.html#abd63ce25e16de6387fb0df3704215c59">dw::Textblock::CLASS_ID</a>;</div>
</div><!-- fragment --><p>would result in true, if o is an instance of <a class="el" href="classdw_1_1Textblock.html" title="A Widget for rendering text blocks, i.e. paragraphs or sequences of paragraphs. ">dw::Textblock</a>, but not an instance of a sub class of <a class="el" href="classdw_1_1Textblock.html" title="A Widget for rendering text blocks, i.e. paragraphs or sequences of paragraphs. ">dw::Textblock</a>.</p>
<h3>Defining Sub Classes</h3>
<p>Each direct or indirect sub class of <a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html" title="Instances of classes, which are sub classes of this class, may be identified at run-time. ">IdentifiableObject</a> must</p>
<ul>
<li>
add a static int CLASS_ID with -1 as initial value, and </li>
<li>
call registerName (<em>name</em>, &amp;CLASS_ID) in the constructor, where <em>name</em> should be unique, e.g. the fully qualified class name. </li>
</ul>
<p>After this, <em>class</em>::CLASS_ID refers to a number, which denotes the class. (If this is still -1, since the class has not yet been instantiated, any test will fail, which is correct.)</p>
<h3>Notes on implementation</h3>
<p>If there are some classes like this:</p>
<div align="center">
<img src="dot_inline_dotgraph_21.png" alt="dot_inline_dotgraph_21.png" border="0" usemap="#dot_inline_dotgraph_21.map"/>
<map name="dot_inline_dotgraph_21.map" id="dot_inline_dotgraph_21.map"></map>
</div>
<center>[<a class="el" href="uml-legend.html">legend</a>]</center><p>and first, an instance of A, and then an instance of C is created, there will be the following calls of functions and constructors:</p>
<ol>
<li>
IdentifiableObject (); </li>
<li>
registerName ("A", &amp;A::CLASS_ID); </li>
<li>
IdentifiableObject (); </li>
<li>
registerName ("B", &amp;B::CLASS_ID); </li>
<li>
registerName ("C", &amp;C::CLASS_ID); </li>
</ol>
<p>From this, the class hierarchy above can easily constructed, and stored in <a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a01a41dd85075aced5c96dc440d04f375">identity::IdentifiableObject::classesByName</a> and in <a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a97ac9a144380eed8007d3a43cff5b2df">identity::IdentifiableObject::classesById</a>. See the code for details.</p>
<p>N.b. Multiple inheritance is not supported, the construction of the tree would become confused. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a31c98db27c4bc38ba30ba0e4e1a23066"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">lout::identity::IdentifiableObject::IdentifiableObject </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a491c1367ff6783a0647522f0a68ae054"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int lout::identity::IdentifiableObject::getClassId </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the class identifier. </p>
<p>This is rarely used, rather, tests with <a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a4c838c41d8044c9eeffa790592f85ce9" title="Returns, whether this class is an instance of the class, given by otherClassId, or of a sub class of ...">identity::IdentifiableObject::instanceOf</a> are done. </p>

<p>References <a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#ab501458f58f97a1c14f335270a1d25d1">classId</a>.</p>

</div>
</div>
<a class="anchor" id="a6e862eb04821e4bbf0cee0d5d58b7752"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char* lout::identity::IdentifiableObject::getClassName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return the name, under which the class of this object was registered. </p>

<p>References <a class="el" href="classlout_1_1identity_1_1IdentifiableObject_1_1Class.html#a764dd86ecf19e5f01f7ec34b705efdb8">lout::identity::IdentifiableObject::Class::className</a>, and <a class="el" href="classlout_1_1container_1_1typed_1_1Vector.html#a86c0550b75d944bc88cf031102c21228">lout::container::typed::Vector&lt; T &gt;::get()</a>.</p>

<p>Referenced by <a class="el" href="classdw_1_1core_1_1Iterator.html#a6599cd89a420967f3e87890ea13af163">dw::core::Iterator::intoStringBuffer()</a>, and <a class="el" href="structdw_1_1core_1_1Content.html#ada388e96115df5b7579a071f9502d482">dw::core::Content::intoStringBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="a4c838c41d8044c9eeffa790592f85ce9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool lout::identity::IdentifiableObject::instanceOf </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>otherClassId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns, whether this class is an instance of the class, given by <em>otherClassId</em>, or of a sub class of this class. </p>

<p>References <a class="el" href="classlout_1_1identity_1_1IdentifiableObject_1_1Class.html#a8c21a2c5d3ae03fa99bb4ffe09f387f8">lout::identity::IdentifiableObject::Class::parent</a>.</p>

<p>Referenced by <a class="el" href="classdw_1_1Textblock.html#a1bebe0d704f071b07066bfb671cede7c">dw::Textblock::addWidget()</a>, <a class="el" href="classdw_1_1oof_1_1OOFPosRelMgr.html#a62c4065a83c79b09541732965158c01a">dw::oof::OOFPosRelMgr::calcWidgetRefSize()</a>, <a class="el" href="classdw_1_1Table.html#a00e5b7d58bfc5f1db60c5b03cb8f7b65">dw::Table::getCellRef()</a>, and <a class="el" href="classdw_1_1oof_1_1OOFAwareWidget.html#a846ff9ee00a453ad3cf64a0cf6e105b7">dw::oof::OOFAwareWidget::isOOFContainer()</a>.</p>

</div>
</div>
<a class="anchor" id="aec2a59a4bf234606c2eb5231d1f048d5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void lout::identity::IdentifiableObject::intoStringBuffer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classlout_1_1misc_1_1StringBuffer.html">misc::StringBuffer</a> *&#160;</td>
          <td class="paramname"><em>sb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Store a textual representation of the object in a <a class="el" href="classlout_1_1misc_1_1StringBuffer.html" title="A class for fast concatenation of a large number of strings. ">misc::StringBuffer</a>. </p>
<p>This is used by <a class="el" href="classlout_1_1object_1_1Object.html#ad7aeadc7934293197110d550abda81ff" title="Use object::Object::intoStringBuffer to return a textual representation of the object. ">object::Object::toString</a>. </p>

<p>Reimplemented from <a class="el" href="classlout_1_1object_1_1Object.html#ad1ad2f2b36fc7a7bead883caa64b0082">lout::object::Object</a>.</p>

<p>References <a class="el" href="classlout_1_1misc_1_1StringBuffer.html#ab68b6f3ea53f2ede620b2b8cf36893f3">lout::misc::StringBuffer::append()</a>, and <a class="el" href="classlout_1_1misc_1_1StringBuffer.html#a7fc087e786183354d399106bb67c3c00">lout::misc::StringBuffer::appendPointer()</a>.</p>

<p>Referenced by <a class="el" href="classdw_1_1Textblock_1_1TextblockIterator.html#ab50c65f9108584503a1abccd1a7c9b7f">dw::Textblock::TextblockIterator::highlight()</a>, and <a class="el" href="classdw_1_1Textblock_1_1TextblockIterator.html#a69ac1b71523ea5cfb100b6e5c1f8bf85">dw::Textblock::TextblockIterator::unhighlight()</a>.</p>

</div>
</div>
<a class="anchor" id="aeb1a57d39e3e06c92433e81457661185"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void lout::identity::IdentifiableObject::registerName </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>className</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>classId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This method must be called in the constructor for the sub class. See class comment for details. </p>

<p>References <a class="el" href="classlout_1_1identity_1_1IdentifiableObject_1_1Class.html#a43621b24c2fdb9d6f9de28e1b7a7e106">lout::identity::IdentifiableObject::Class::id</a>.</p>

<p>Referenced by <a class="el" href="classdw_1_1AlignedTableCell.html#ad5b653208a8faa04f0e3e5038d3831d1">dw::AlignedTableCell::AlignedTableCell()</a>, <a class="el" href="classdw_1_1AlignedTextblock.html#aaeb8751964017240feb51d17157a11e2">dw::AlignedTextblock::AlignedTextblock()</a>, <a class="el" href="classdw_1_1ListItem.html#a2953463aee2775e189b4a18da944219c">dw::ListItem::ListItem()</a>, <a class="el" href="classdw_1_1RegardingBorder.html#a2393c4edadda6be693e2418a4393189f">dw::RegardingBorder::RegardingBorder()</a>, <a class="el" href="classdw_1_1Ruler.html#ad995bdd40ed99ed4bff3b199afc89654">dw::Ruler::Ruler()</a>, and <a class="el" href="classdw_1_1SimpleTableCell.html#acb291e2bcf7fcb79280292328846b8b5">dw::SimpleTableCell::SimpleTableCell()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a97ac9a144380eed8007d3a43cff5b2df"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classlout_1_1container_1_1typed_1_1Vector.html">Vector</a>&lt; <a class="el" href="classlout_1_1identity_1_1IdentifiableObject_1_1Class.html">IdentifiableObject::Class</a> &gt; * lout::identity::IdentifiableObject::classesById</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line">   <span class="keyword">new</span> Vector &lt;IdentifiableObject::Class&gt; (16, <span class="keyword">false</span>)</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a01a41dd85075aced5c96dc440d04f375"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classlout_1_1container_1_1typed_1_1HashTable.html">HashTable</a>&lt; <a class="el" href="classlout_1_1object_1_1ConstString.html">ConstString</a>, <a class="el" href="classlout_1_1identity_1_1IdentifiableObject_1_1Class.html">IdentifiableObject::Class</a> &gt; * lout::identity::IdentifiableObject::classesByName</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line">      <span class="keyword">new</span> HashTable&lt;ConstString, IdentifiableObject::Class&gt; (<span class="keyword">true</span>, <span class="keyword">true</span>)</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ab501458f58f97a1c14f335270a1d25d1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int lout::identity::IdentifiableObject::classId</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Referenced by <a class="el" href="classlout_1_1identity_1_1IdentifiableObject.html#a491c1367ff6783a0647522f0a68ae054">getClassId()</a>.</p>

</div>
</div>
<a class="anchor" id="a48c0cf7f73a602ae14ac5de6b18c0174"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classlout_1_1identity_1_1IdentifiableObject_1_1Class.html">IdentifiableObject::Class</a> * lout::identity::IdentifiableObject::currentlyConstructedClass</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>lout/<a class="el" href="identity_8hh_source.html">identity.hh</a></li>
<li>lout/<a class="el" href="lout_2identity_8cc.html">identity.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat May 28 2016 11:47:45 for Dillo by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>