Imported Upstream version 1.57.0
[platform/upstream/boost.git] / doc / html / boost / any.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class any</title>
5 <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8 <link rel="up" href="../any/reference.html#header.boost.any_hpp" title="Header &lt;boost/any.hpp&gt;">
9 <link rel="prev" href="bad_any_cast.html" title="Class bad_any_cast">
10 <link rel="next" href="swap_idp41185616.html" title="Function swap">
11 </head>
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
15 <td align="center"><a href="../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../more/index.htm">More</a></td>
20 </tr></table>
21 <hr>
22 <div class="spirit-nav">
23 <a accesskey="p" href="bad_any_cast.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../any/reference.html#header.boost.any_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="swap_idp41185616.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="refentry">
26 <a name="boost.any"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Class any</span></h2>
29 <p>boost::any &#8212; A class whose instances can hold instances of any
30           type that satisfies <a class="link" href="../any/reference.html#any.ValueType" title="ValueType requirements">ValueType</a>
31           requirements.</p>
32 </div>
33 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
34 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../any/reference.html#header.boost.any_hpp" title="Header &lt;boost/any.hpp&gt;">boost/any.hpp</a>&gt;
35
36 </span>
37 <span class="keyword">class</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">{</span>
38 <span class="keyword">public</span><span class="special">:</span>
39   <span class="comment">// <a class="link" href="any.html#boost.anyconstruct-copy-destruct">construct/copy/destruct</a></span>
40   <a class="link" href="any.html#idp36966320-bb"><span class="identifier">any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
41   <a class="link" href="any.html#idp36967920-bb"><span class="identifier">any</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
42   <a class="link" href="any.html#idp36973232-bb"><span class="identifier">any</span></a><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
43   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ValueType<span class="special">&gt;</span> <a class="link" href="any.html#idp36978784-bb"><span class="identifier">any</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ValueType</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
44   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ValueType<span class="special">&gt;</span> <a class="link" href="any.html#idp41337440-bb"><span class="identifier">any</span></a><span class="special">(</span><span class="identifier">ValueType</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
45   <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> <a class="link" href="any.html#idp41344752-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
46   <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> <a class="link" href="any.html#idp41351248-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
47   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ValueType<span class="special">&gt;</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> <a class="link" href="any.html#idp41358624-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ValueType</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
48   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ValueType<span class="special">&gt;</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> <a class="link" href="any.html#idp41364720-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">ValueType</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
49   <a class="link" href="any.html#idp41343184-bb"><span class="special">~</span><span class="identifier">any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
50
51   <span class="comment">// <a class="link" href="any.html#idp41170944-bb">modifiers</a></span>
52   <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> <a class="link" href="any.html#idp41171504-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
53
54   <span class="comment">// <a class="link" href="any.html#idp41177296-bb">queries</a></span>
55   <span class="keyword">bool</span> <a class="link" href="any.html#idp41177856-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
56   <span class="keyword">const</span> std::type_info <span class="special">&amp;</span> <a class="link" href="any.html#idp41181168-bb"><span class="identifier">type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
57 <span class="special">}</span><span class="special">;</span></pre></div>
58 <div class="refsect1">
59 <a name="idp121082544"></a><h2>Description</h2>
60 <div class="refsect2">
61 <a name="idp121082960"></a><h3>
62 <a name="boost.anyconstruct-copy-destruct"></a><code class="computeroutput">any</code> 
63         public
64        construct/copy/destruct</h3>
65 <div class="orderedlist"><ol class="orderedlist" type="1">
66 <li class="listitem">
67 <pre class="literallayout"><a name="idp36966320-bb"></a><span class="identifier">any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
68 <div class="variablelist"><table border="0" class="variablelist compact">
69 <colgroup>
70 <col align="left" valign="top">
71 <col>
72 </colgroup>
73 <tbody><tr>
74 <td><p><span class="term">Postconditions:</span></p></td>
75 <td><code class="computeroutput">this-&gt;<a class="link" href="any.html#idp41177856-bb">empty</a>()</code></td>
76 </tr></tbody>
77 </table></div>
78 </li>
79 <li class="listitem">
80 <pre class="literallayout"><a name="idp36967920-bb"></a><span class="identifier">any</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
81 <div class="variablelist"><table border="0" class="variablelist compact">
82 <colgroup>
83 <col align="left" valign="top">
84 <col>
85 </colgroup>
86 <tbody>
87 <tr>
88 <td><p><span class="term">Effects:</span></p></td>
89 <td> Copy constructor that copies content of
90             <code class="computeroutput">other</code> into new instance, so that any content
91             is equivalent in both type and value to the content of
92             <code class="computeroutput">other</code>, or empty if <code class="computeroutput">other</code> is
93             empty. </td>
94 </tr>
95 <tr>
96 <td><p><span class="term">Throws:</span></p></td>
97 <td>May fail with a
98             <code class="computeroutput">std::bad_alloc</code>
99             exception or any exceptions arising from the copy
100             constructor of the contained type.</td>
101 </tr>
102 </tbody>
103 </table></div>
104 </li>
105 <li class="listitem">
106 <pre class="literallayout"><a name="idp36973232-bb"></a><span class="identifier">any</span><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
107 <div class="variablelist"><table border="0" class="variablelist compact">
108 <colgroup>
109 <col align="left" valign="top">
110 <col>
111 </colgroup>
112 <tbody>
113 <tr>
114 <td><p><span class="term">Effects:</span></p></td>
115 <td> Move constructor that moves content of
116             <code class="computeroutput">other</code> into new instance and leaves <code class="computeroutput">other</code>
117             empty. </td>
118 </tr>
119 <tr>
120 <td><p><span class="term">Postconditions:</span></p></td>
121 <td><code class="computeroutput">other-&gt;<a class="link" href="any.html#idp41177856-bb">empty</a>()</code></td>
122 </tr>
123 <tr>
124 <td><p><span class="term">Throws:</span></p></td>
125 <td>Nothing.</td>
126 </tr>
127 </tbody>
128 </table></div>
129 </li>
130 <li class="listitem">
131 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ValueType<span class="special">&gt;</span> <a name="idp36978784-bb"></a><span class="identifier">any</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ValueType</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
132 <div class="variablelist"><table border="0" class="variablelist compact">
133 <colgroup>
134 <col align="left" valign="top">
135 <col>
136 </colgroup>
137 <tbody>
138 <tr>
139 <td><p><span class="term">Effects:</span></p></td>
140 <td>Makes a copy of <code class="computeroutput">value</code>, so
141             that the initial content of the new instance is equivalent
142             in both type and value to
143             <code class="computeroutput">value</code>.</td>
144 </tr>
145 <tr>
146 <td><p><span class="term">Throws:</span></p></td>
147 <td>
148 <code class="computeroutput">std::bad_alloc</code>
149             or any exceptions arising from the copy constructor of the
150             contained type.</td>
151 </tr>
152 </tbody>
153 </table></div>
154 </li>
155 <li class="listitem">
156 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ValueType<span class="special">&gt;</span> <a name="idp41337440-bb"></a><span class="identifier">any</span><span class="special">(</span><span class="identifier">ValueType</span> <span class="special">&amp;&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>
157 <div class="variablelist"><table border="0" class="variablelist compact">
158 <colgroup>
159 <col align="left" valign="top">
160 <col>
161 </colgroup>
162 <tbody>
163 <tr>
164 <td><p><span class="term">Effects:</span></p></td>
165 <td>Forwards <code class="computeroutput">value</code>, so
166             that the initial content of the new instance is equivalent
167             in both type and value to
168             <code class="computeroutput">value</code> before the forward.</td>
169 </tr>
170 <tr>
171 <td><p><span class="term">Throws:</span></p></td>
172 <td>
173 <code class="computeroutput">std::bad_alloc</code>
174             or any exceptions arising from the copy constructor of the
175             contained type.</td>
176 </tr>
177 </tbody>
178 </table></div>
179 </li>
180 <li class="listitem">
181 <pre class="literallayout"><a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> <a name="idp41344752-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
182 <div class="variablelist"><table border="0" class="variablelist compact">
183 <colgroup>
184 <col align="left" valign="top">
185 <col>
186 </colgroup>
187 <tbody>
188 <tr>
189 <td><p><span class="term">Effects:</span></p></td>
190 <td>Copies content of <code class="computeroutput">rhs</code> into
191             current instance, discarding previous content, so that the
192             new content is equivalent in both type and value to the
193             content of <code class="computeroutput">rhs</code>, or empty if
194             <code class="computeroutput">rhs.<a class="link" href="any.html#idp41177856-bb">empty</a>()</code>.</td>
195 </tr>
196 <tr>
197 <td><p><span class="term">Throws:</span></p></td>
198 <td>
199 <code class="computeroutput">std::bad_alloc</code>
200             or any exceptions arising from the copy constructor of the
201             contained type. Assignment satisfies the strong guarantee
202             of exception safety.</td>
203 </tr>
204 </tbody>
205 </table></div>
206 </li>
207 <li class="listitem">
208 <pre class="literallayout"><a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> <a name="idp41351248-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
209 <div class="variablelist"><table border="0" class="variablelist compact">
210 <colgroup>
211 <col align="left" valign="top">
212 <col>
213 </colgroup>
214 <tbody>
215 <tr>
216 <td><p><span class="term">Effects:</span></p></td>
217 <td>Moves content of <code class="computeroutput">rhs</code> into
218             current instance, discarding previous content, so that the
219             new content is equivalent in both type and value to the
220             content of <code class="computeroutput">rhs</code> before move, or empty if
221             <code class="computeroutput">rhs.<a class="link" href="any.html#idp41177856-bb">empty</a>()</code>.</td>
222 </tr>
223 <tr>
224 <td><p><span class="term">Postconditions:</span></p></td>
225 <td><code class="computeroutput">rhs-&gt;<a class="link" href="any.html#idp41177856-bb">empty</a>()</code></td>
226 </tr>
227 <tr>
228 <td><p><span class="term">Throws:</span></p></td>
229 <td>Nothing.</td>
230 </tr>
231 </tbody>
232 </table></div>
233 </li>
234 <li class="listitem">
235 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ValueType<span class="special">&gt;</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> <a name="idp41358624-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ValueType</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
236 <div class="variablelist"><table border="0" class="variablelist compact">
237 <colgroup>
238 <col align="left" valign="top">
239 <col>
240 </colgroup>
241 <tbody>
242 <tr>
243 <td><p><span class="term">Effects:</span></p></td>
244 <td>Makes a copy of <code class="computeroutput">rhs</code>,
245             discarding previous content, so that the new content of is
246             equivalent in both type and value to
247             <code class="computeroutput">rhs</code>.</td>
248 </tr>
249 <tr>
250 <td><p><span class="term">Throws:</span></p></td>
251 <td>
252 <code class="computeroutput">std::bad_alloc</code>
253             or any exceptions arising from the copy constructor of the
254             contained type. Assignment satisfies the strong guarantee
255             of exception safety.</td>
256 </tr>
257 </tbody>
258 </table></div>
259 </li>
260 <li class="listitem">
261 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ValueType<span class="special">&gt;</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> <a name="idp41364720-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">ValueType</span> <span class="special">&amp;&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
262 <div class="variablelist"><table border="0" class="variablelist compact">
263 <colgroup>
264 <col align="left" valign="top">
265 <col>
266 </colgroup>
267 <tbody>
268 <tr>
269 <td><p><span class="term">Effects:</span></p></td>
270 <td>Forwards <code class="computeroutput">rhs</code>,
271             discarding previous content, so that the new content of is
272             equivalent in both type and value to
273             <code class="computeroutput">rhs</code> before forward.</td>
274 </tr>
275 <tr>
276 <td><p><span class="term">Throws:</span></p></td>
277 <td>
278 <code class="computeroutput">std::bad_alloc</code>
279             or any exceptions arising from the move or copy constructor of the
280             contained type. Assignment satisfies the strong guarantee
281             of exception safety.</td>
282 </tr>
283 </tbody>
284 </table></div>
285 </li>
286 <li class="listitem">
287 <pre class="literallayout"><a name="idp41343184-bb"></a><span class="special">~</span><span class="identifier">any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
288 <div class="variablelist"><table border="0" class="variablelist compact">
289 <colgroup>
290 <col align="left" valign="top">
291 <col>
292 </colgroup>
293 <tbody>
294 <tr>
295 <td><p><span class="term">Effects:</span></p></td>
296 <td>Releases any and all resources used in
297             management of instance.</td>
298 </tr>
299 <tr>
300 <td><p><span class="term">Throws:</span></p></td>
301 <td>Nothing.</td>
302 </tr>
303 </tbody>
304 </table></div>
305 </li>
306 </ol></div>
307 </div>
308 <div class="refsect2">
309 <a name="idp121201120"></a><h3>
310 <a name="idp41170944-bb"></a><code class="computeroutput">any</code> modifiers</h3>
311 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
312 <pre class="literallayout"><a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> <a name="idp41171504-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
313 <div class="variablelist"><table border="0" class="variablelist compact">
314 <colgroup>
315 <col align="left" valign="top">
316 <col>
317 </colgroup>
318 <tbody>
319 <tr>
320 <td><p><span class="term">Effects:</span></p></td>
321 <td>Exchange of the contents of
322               <code class="computeroutput">*this</code> and
323               <code class="computeroutput">rhs</code>.</td>
324 </tr>
325 <tr>
326 <td><p><span class="term">Returns:</span></p></td>
327 <td><code class="computeroutput">*this</code></td>
328 </tr>
329 <tr>
330 <td><p><span class="term">Throws:</span></p></td>
331 <td>Nothing.</td>
332 </tr>
333 </tbody>
334 </table></div>
335 </li></ol></div>
336 </div>
337 <div class="refsect2">
338 <a name="idp121214576"></a><h3>
339 <a name="idp41177296-bb"></a><code class="computeroutput">any</code> queries</h3>
340 <div class="orderedlist"><ol class="orderedlist" type="1">
341 <li class="listitem">
342 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp41177856-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
343 <div class="variablelist"><table border="0" class="variablelist compact">
344 <colgroup>
345 <col align="left" valign="top">
346 <col>
347 </colgroup>
348 <tbody>
349 <tr>
350 <td><p><span class="term">Returns:</span></p></td>
351 <td>
352 <code class="computeroutput">true</code> if instance is
353               empty, otherwise <code class="computeroutput">false</code>.</td>
354 </tr>
355 <tr>
356 <td><p><span class="term">Throws:</span></p></td>
357 <td>Nothing.</td>
358 </tr>
359 </tbody>
360 </table></div>
361 </li>
362 <li class="listitem">
363 <pre class="literallayout"><span class="keyword">const</span> std::type_info <span class="special">&amp;</span> <a name="idp41181168-bb"></a><span class="identifier">type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
364 <div class="variablelist"><table border="0" class="variablelist compact">
365 <colgroup>
366 <col align="left" valign="top">
367 <col>
368 </colgroup>
369 <tbody>
370 <tr>
371 <td><p><span class="term">Returns:</span></p></td>
372 <td>the <code class="computeroutput">typeid</code> of the
373               contained value if instance is non-empty, otherwise
374               <code class="computeroutput">typeid(void)</code>.</td>
375 </tr>
376 <tr>
377 <td><p><span class="term">Notes:</span></p></td>
378 <td>Useful for querying against types known
379               either at compile time or only at
380               runtime.</td>
381 </tr>
382 </tbody>
383 </table></div>
384 </li>
385 </ol></div>
386 </div>
387 </div>
388 </div>
389 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
390 <td align="left"></td>
391 <td align="right"><div class="copyright-footer">Copyright &#169; 2001 Kevlin Henney<p>Distributed under the Boost Software License, Version 1.0.
392       (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at 
393       <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
394       </p>
395 </div></td>
396 </tr></table>
397 <hr>
398 <div class="spirit-nav">
399 <a accesskey="p" href="bad_any_cast.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../any/reference.html#header.boost.any_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="swap_idp41185616.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
400 </div>
401 </body>
402 </html>