libelemental-doc 1.2.0-11 / usr / share / doc / libelemental-doc / api / classElemental_1_1Event.html

This file is indexed.

/usr/share/doc/libelemental-doc/api/classElemental_1_1Event.html is in libelemental-doc 1.2.0-11.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libelemental: Elemental::Event Class 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="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">libelemental
   &#160;<span id="projectnumber">1.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceElemental.html">Elemental</a></li><li class="navelem"><a class="el" href="classElemental_1_1Event.html">Event</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classElemental_1_1Event-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Elemental::Event Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A qualified value representing the time and location of an event.  
 <a href="classElemental_1_1Event.html#details">More...</a></p>

<p><code>#include &lt;value-types.hh&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Elemental::Event:</div>
<div class="dyncontent">
<div class="center"><img src="classElemental_1_1Event__inherit__graph.png" border="0" usemap="#Elemental_1_1Event_inherit__map" alt="Inheritance graph"/></div>
<map name="Elemental_1_1Event_inherit__map" id="Elemental_1_1Event_inherit__map">
<area shape="rect" id="node2" href="classElemental_1_1value__base.html" title="A base class for qualified values. " alt="" coords="5,5,176,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:ae4cd906aa17ccf4e545326ab4c7536fc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Event.html#ae4cd906aa17ccf4e545326ab4c7536fc">Event</a> (int <a class="el" href="classElemental_1_1Event.html#aa8de4ac5cae1fc63ac3b02bce8d10292">when</a>, const ustring &amp;<a class="el" href="classElemental_1_1Event.html#afe477067e9a50f6715f89a7f8dad1e3f">where</a>, <a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2">Qualifier</a> <a class="el" href="classElemental_1_1value__base.html#aa6a9585eaec7dfc245e7c7b98bb5698a">qualifier</a>=<a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2aa48994469a417f706e46b13e57279093">Q_NEUTRAL</a>)  throw ()</td></tr>
<tr class="memdesc:ae4cd906aa17ccf4e545326ab4c7536fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new defined event.  <a href="#ae4cd906aa17ccf4e545326ab4c7536fc">More...</a><br /></td></tr>
<tr class="separator:ae4cd906aa17ccf4e545326ab4c7536fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15840d6659e9bc554542a530490034c3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Event.html#a15840d6659e9bc554542a530490034c3">Event</a> (<a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2">Qualifier</a> <a class="el" href="classElemental_1_1value__base.html#aa6a9585eaec7dfc245e7c7b98bb5698a">qualifier</a>=<a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2a2b51d6376cf076727fd21455c177dcd5">Q_UNK</a>)  throw ()</td></tr>
<tr class="memdesc:a15840d6659e9bc554542a530490034c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new undefined or empty event.  <a href="#a15840d6659e9bc554542a530490034c3">More...</a><br /></td></tr>
<tr class="separator:a15840d6659e9bc554542a530490034c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3635b6cd37c88d3982513e3f7cf76b0b"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Event.html#a3635b6cd37c88d3982513e3f7cf76b0b">compare</a> (const <a class="el" href="classElemental_1_1value__base.html">value_base</a> &amp;other) const  throw ()</td></tr>
<tr class="memdesc:a3635b6cd37c88d3982513e3f7cf76b0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two qualified values.  <a href="#a3635b6cd37c88d3982513e3f7cf76b0b">More...</a><br /></td></tr>
<tr class="separator:a3635b6cd37c88d3982513e3f7cf76b0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a475d8c25461716f2ef7ddc209be2b1"><td class="memItemLeft" align="right" valign="top">virtual ustring&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Event.html#a8a475d8c25461716f2ef7ddc209be2b1">get_string</a> (const ustring &amp;format=ustring()) const  throw ()</td></tr>
<tr class="memdesc:a8a475d8c25461716f2ef7ddc209be2b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a localized text representation of the event.  <a href="#a8a475d8c25461716f2ef7ddc209be2b1">More...</a><br /></td></tr>
<tr class="separator:a8a475d8c25461716f2ef7ddc209be2b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classElemental_1_1value__base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classElemental_1_1value__base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classElemental_1_1value__base.html">Elemental::value_base</a></td></tr>
<tr class="memitem:ae2784ccdf0816b58927b973c59d8e840 inherit pub_methods_classElemental_1_1value__base"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#ae2784ccdf0816b58927b973c59d8e840">has_value</a> () const  throw ()</td></tr>
<tr class="memdesc:ae2784ccdf0816b58927b973c59d8e840 inherit pub_methods_classElemental_1_1value__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the value is defined.  <a href="classElemental_1_1value__base.html#ae2784ccdf0816b58927b973c59d8e840">More...</a><br /></td></tr>
<tr class="separator:ae2784ccdf0816b58927b973c59d8e840 inherit pub_methods_classElemental_1_1value__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa853d96d869bee6d5513f8ac8df5f61 inherit pub_methods_classElemental_1_1value__base"><td class="memItemLeft" align="right" valign="top">ustring&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#afa853d96d869bee6d5513f8ac8df5f61">get_tip</a> () const  throw ()</td></tr>
<tr class="memdesc:afa853d96d869bee6d5513f8ac8df5f61 inherit pub_methods_classElemental_1_1value__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a localized message to be displayed as a tooltip.  <a href="classElemental_1_1value__base.html#afa853d96d869bee6d5513f8ac8df5f61">More...</a><br /></td></tr>
<tr class="separator:afa853d96d869bee6d5513f8ac8df5f61 inherit pub_methods_classElemental_1_1value__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a942662b72ee323651805961f5ec4cbb7 inherit pub_methods_classElemental_1_1value__base"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#a942662b72ee323651805961f5ec4cbb7">make_entry</a> (<a class="el" href="classElemental_1_1EntriesView.html">EntriesView</a> &amp;view, const ustring &amp;name, const ustring &amp;format=ustring()) const  throw ()</td></tr>
<tr class="memdesc:a942662b72ee323651805961f5ec4cbb7 inherit pub_methods_classElemental_1_1value__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Possibly adds the result of <a class="el" href="classElemental_1_1value__base.html#a8b39e09ee6f9df1ac121d5d61e0bad50" title="Returns a localized text representation of the value. ">get_string()</a> to an <a class="el" href="classElemental_1_1EntriesView.html" title="An interface for the display of value entries. ">EntriesView</a>.  <a href="classElemental_1_1value__base.html#a942662b72ee323651805961f5ec4cbb7">More...</a><br /></td></tr>
<tr class="separator:a942662b72ee323651805961f5ec4cbb7 inherit pub_methods_classElemental_1_1value__base"><td class="memSeparator" colspan="2">&#160;</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:aa8de4ac5cae1fc63ac3b02bce8d10292"><td class="memItemLeft" align="right" valign="top"><a id="aa8de4ac5cae1fc63ac3b02bce8d10292"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Event.html#aa8de4ac5cae1fc63ac3b02bce8d10292">when</a></td></tr>
<tr class="memdesc:aa8de4ac5cae1fc63ac3b02bce8d10292"><td class="mdescLeft">&#160;</td><td class="mdescRight">The year in which the event occurred, if defined. <br /></td></tr>
<tr class="separator:aa8de4ac5cae1fc63ac3b02bce8d10292"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe477067e9a50f6715f89a7f8dad1e3f"><td class="memItemLeft" align="right" valign="top"><a id="afe477067e9a50f6715f89a7f8dad1e3f"></a>
ustring&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Event.html#afe477067e9a50f6715f89a7f8dad1e3f">where</a></td></tr>
<tr class="memdesc:afe477067e9a50f6715f89a7f8dad1e3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The place in which the event occurred, if defined. <br /></td></tr>
<tr class="separator:afe477067e9a50f6715f89a7f8dad1e3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_classElemental_1_1value__base"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classElemental_1_1value__base')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classElemental_1_1value__base.html">Elemental::value_base</a></td></tr>
<tr class="memitem:aa6a9585eaec7dfc245e7c7b98bb5698a inherit pub_attribs_classElemental_1_1value__base"><td class="memItemLeft" align="right" valign="top"><a id="aa6a9585eaec7dfc245e7c7b98bb5698a"></a>
<a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2">Qualifier</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#aa6a9585eaec7dfc245e7c7b98bb5698a">qualifier</a></td></tr>
<tr class="memdesc:aa6a9585eaec7dfc245e7c7b98bb5698a inherit pub_attribs_classElemental_1_1value__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">The qualification of the value's meaning. <br /></td></tr>
<tr class="separator:aa6a9585eaec7dfc245e7c7b98bb5698a inherit pub_attribs_classElemental_1_1value__base"><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:abd7447af9fc2b5f935cf0e67313003be"><td class="memItemLeft" align="right" valign="top">virtual ustring&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Event.html#abd7447af9fc2b5f935cf0e67313003be">do_get_string</a> (const ustring &amp;format) const  throw ()</td></tr>
<tr class="memdesc:abd7447af9fc2b5f935cf0e67313003be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a localized text representation of a defined value.  <a href="#abd7447af9fc2b5f935cf0e67313003be">More...</a><br /></td></tr>
<tr class="separator:abd7447af9fc2b5f935cf0e67313003be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a172c909d3afdbe8c7fd2e76f36d006"><td class="memItemLeft" align="right" valign="top"><a id="a1a172c909d3afdbe8c7fd2e76f36d006"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1Event.html#a1a172c909d3afdbe8c7fd2e76f36d006">compare_base</a> (const <a class="el" href="classElemental_1_1value__base.html">value_base</a> &amp;other) const  throw ()</td></tr>
<tr class="memdesc:a1a172c909d3afdbe8c7fd2e76f36d006"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares the qualifications of two events. <br /></td></tr>
<tr class="separator:a1a172c909d3afdbe8c7fd2e76f36d006"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classElemental_1_1value__base"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classElemental_1_1value__base')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classElemental_1_1value__base.html">Elemental::value_base</a></td></tr>
<tr class="memitem:ad6971ae9ef170930c43eb6bc8336d1b9 inherit pro_methods_classElemental_1_1value__base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#ad6971ae9ef170930c43eb6bc8336d1b9">value_base</a> (<a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2">Qualifier</a> <a class="el" href="classElemental_1_1value__base.html#aa6a9585eaec7dfc245e7c7b98bb5698a">qualifier</a>)  throw ()</td></tr>
<tr class="separator:ad6971ae9ef170930c43eb6bc8336d1b9 inherit pro_methods_classElemental_1_1value__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classElemental_1_1value__base"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classElemental_1_1value__base')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classElemental_1_1value__base.html">Elemental::value_base</a></td></tr>
<tr class="memitem:a9384ecc1c5343d77b78de138d0608856 inherit pro_attribs_classElemental_1_1value__base"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#a9384ecc1c5343d77b78de138d0608856">always</a></td></tr>
<tr class="memdesc:a9384ecc1c5343d77b78de138d0608856 inherit pro_attribs_classElemental_1_1value__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether an undefined value should make an entry.  <a href="classElemental_1_1value__base.html#a9384ecc1c5343d77b78de138d0608856">More...</a><br /></td></tr>
<tr class="separator:a9384ecc1c5343d77b78de138d0608856 inherit pro_attribs_classElemental_1_1value__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_static_attribs_classElemental_1_1value__base"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_classElemental_1_1value__base')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="classElemental_1_1value__base.html">Elemental::value_base</a></td></tr>
<tr class="memitem:ad9bea11e6cb5dc088d028a025e03dd32 inherit pro_static_attribs_classElemental_1_1value__base"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classElemental_1_1value__base.html#ad9bea11e6cb5dc088d028a025e03dd32">YIELD_COMPARE</a></td></tr>
<tr class="memdesc:ad9bea11e6cb5dc088d028a025e03dd32 inherit pro_static_attribs_classElemental_1_1value__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates that comparison should be based on values, not definedness.  <a href="classElemental_1_1value__base.html#ad9bea11e6cb5dc088d028a025e03dd32">More...</a><br /></td></tr>
<tr class="separator:ad9bea11e6cb5dc088d028a025e03dd32 inherit pro_static_attribs_classElemental_1_1value__base"><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>A qualified value representing the time and location of an event. </p>
<p>Events are compared by year of occurrence. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae4cd906aa17ccf4e545326ab4c7536fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4cd906aa17ccf4e545326ab4c7536fc">&#9670;&nbsp;</a></span>Event() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Elemental::Event::Event </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>when</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const ustring &amp;&#160;</td>
          <td class="paramname"><em>where</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2">Qualifier</a>&#160;</td>
          <td class="paramname"><em>qualifier</em> = <code><a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2aa48994469a417f706e46b13e57279093">Q_NEUTRAL</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2"></td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructs a new defined event. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">when</td><td>The year in which the event occurred. </td></tr>
    <tr><td class="paramname">where</td><td>The place in which the event occurred. </td></tr>
    <tr><td class="paramname">qualifier</td><td>The qualification of the event. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a15840d6659e9bc554542a530490034c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15840d6659e9bc554542a530490034c3">&#9670;&nbsp;</a></span>Event() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Elemental::Event::Event </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2">Qualifier</a>&#160;</td>
          <td class="paramname"><em>qualifier</em> = <code><a class="el" href="namespaceElemental.html#a16ed2f16de2f9dcc2eda8b5eb9c9bea2a2b51d6376cf076727fd21455c177dcd5">Q_UNK</a></code></td><td>)</td>
          <td></td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2"></td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructs a new undefined or empty event. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">qualifier</td><td>The qualification of the event. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3635b6cd37c88d3982513e3f7cf76b0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3635b6cd37c88d3982513e3f7cf76b0b">&#9670;&nbsp;</a></span>compare()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual int Elemental::Event::compare </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classElemental_1_1value__base.html">value_base</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2"></td>
        </tr>
        <tr>
          <td align="right"></td><td>)</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>Compares two qualified values. </p>
<p>Derived classes may override this function, first calling compare_base, and use a dynamic_cast to check other. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">other</td><td>The qualified value for comparison. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>-1</code> if this value is undefined or is less than <code>other</code>; <code>0</code> if the values are equal; or <code>1</code> if <code>other</code> is undefined or this value is greater than <code>other</code>. </dd></dl>

<p>Reimplemented from <a class="el" href="classElemental_1_1value__base.html#abdf0561e845f80ad6a6def9075b966da">Elemental::value_base</a>.</p>

</div>
</div>
<a id="abd7447af9fc2b5f935cf0e67313003be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd7447af9fc2b5f935cf0e67313003be">&#9670;&nbsp;</a></span>do_get_string()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ustring Elemental::Event::do_get_string </td>
          <td>(</td>
          <td class="paramtype">const ustring &amp;&#160;</td>
          <td class="paramname"><em>format</em></td><td>)</td>
          <td> const</td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2"></td>
        </tr>
        <tr>
          <td align="right"></td><td>)</td><td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a localized text representation of a defined value. </p>
<p>Derived classes must implement this function to produce a text representation based on the format. It will be called by <a class="el" href="classElemental_1_1Event.html#a8a475d8c25461716f2ef7ddc209be2b1" title="Returns a localized text representation of the event. ">get_string()</a>, which will then decorate its output as appropriate for the current qualifier. If <a class="el" href="classElemental_1_1value__base.html#ae2784ccdf0816b58927b973c59d8e840" title="Returns whether the value is defined. ">has_value()</a> is <code>false</code>, the behavior is undefined. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>A compose-style format string. Derived classes may define the number of argument references expected in the string; the default is one. If <code>format</code> is empty, a minimal default should be used. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A UTF-8 string containing the localized representation. </dd></dl>

<p>Implements <a class="el" href="classElemental_1_1value__base.html#a9f0e1f72aee2897d2116037b00cf6cca">Elemental::value_base</a>.</p>

</div>
</div>
<a id="a8a475d8c25461716f2ef7ddc209be2b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a475d8c25461716f2ef7ddc209be2b1">&#9670;&nbsp;</a></span>get_string()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ustring Elemental::Event::get_string </td>
          <td>(</td>
          <td class="paramtype">const ustring &amp;&#160;</td>
          <td class="paramname"><em>format</em> = <code>ustring()</code></td><td>)</td>
          <td> const</td>
        </tr>
        <tr>
          <td align="right">throw </td><td>(</td><td colspan="2"></td>
        </tr>
        <tr>
          <td align="right"></td><td>)</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>Returns a localized text representation of the event. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">format</td><td>An optional compose-style format string with which to output the value. The year is "%1" and the place is "%2". By default, the format is the localized version of <code>"%1 (%2)"</code>. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A UTF-8 string containing the localized representation. </dd></dl>

<p>Reimplemented from <a class="el" href="classElemental_1_1value__base.html#a8b39e09ee6f9df1ac121d5d61e0bad50">Elemental::value_base</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>libelemental/<a class="el" href="value-types_8hh.html">value-types.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.