libs/log/doc/html/boost/log/attributes/named_scope_list.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class named_scope_list</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
   8 <link rel="up" href="../../../attributes.html#header.boost.log.attributes.named_scope_hpp" title="Header &lt;boost/log/attributes/named_scope.hpp&gt;">
   9 <link rel="prev" href="named_scope_entry/scope_name_type.html" title="Type scope_name_type">
  10 <link rel="next" href="operator_idm45711348515120.html" title="Function template operator&lt;&lt;">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="named_scope_entry/scope_name_type.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../attributes.html#header.boost.log.attributes.named_scope_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="operator_idm45711348515120.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.attributes.named_scope_list"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class named_scope_list</span></h2>
  22 <p>boost::log::attributes::named_scope_list &#8212; The class implements the list of scopes. </p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <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="../../../attributes.html#header.boost.log.attributes.named_scope_hpp" title="Header &lt;boost/log/attributes/named_scope.hpp&gt;">boost/log/attributes/named_scope.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">class</span> <a class="link" href="named_scope_list.html" title="Class named_scope_list">named_scope_list</a> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// <a class="link" href="named_scope_list.html#boost.log.attributes.named_scope_listtypes">types</a></span>
  31   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">allocator</span><span class="special">&lt;</span> <a class="link" href="named_scope_entry.html" title="Struct named_scope_entry">named_scope_entry</a> <span class="special">&gt;</span> <a name="boost.log.attributes.named_scope_list.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span>          <span class="comment">// Allocator type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">value_type</span>          <a name="boost.log.attributes.named_scope_list.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  33   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">reference</span>           <a name="boost.log.attributes.named_scope_list.reference"></a><span class="identifier">reference</span><span class="special">;</span>
  34   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">const_reference</span>     <a name="boost.log.attributes.named_scope_list.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span>
  35   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">pointer</span>             <a name="boost.log.attributes.named_scope_list.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>
  36   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">const_pointer</span>       <a name="boost.log.attributes.named_scope_list.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span>
  37   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">size_type</span>           <a name="boost.log.attributes.named_scope_list.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
  38   <span class="keyword">typedef</span> <span class="identifier">allocator_type</span><span class="special">::</span><span class="identifier">difference_type</span>     <a name="boost.log.attributes.named_scope_list.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span>              <a class="link" href="named_scope_list.html#boost.log.attributes.named_scope_list.const_iterator"><span class="identifier">const_iterator</span></a><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span>              <a class="link" href="named_scope_list.html#boost.log.attributes.named_scope_list.iterator"><span class="identifier">iterator</span></a><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span>              <a class="link" href="named_scope_list.html#boost.log.attributes.named_scope_list.const_reverse_iterator"><span class="identifier">const_reverse_iterator</span></a><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span>              <a class="link" href="named_scope_list.html#boost.log.attributes.named_scope_list.reverse_iterator"><span class="identifier">reverse_iterator</span></a><span class="special">;</span>
  43
  44   <span class="comment">// <a class="link" href="named_scope_list.html#boost.log.attributes.named_scope_listconstruct-copy-destruct">construct/copy/destruct</a></span>
  45   <a class="link" href="named_scope_list.html#idm45711348524016-bb"><span class="identifier">named_scope_list</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="named_scope_list.html#idm45711348522160-bb"><span class="identifier">named_scope_list</span></a><span class="special">(</span><a class="link" href="named_scope_list.html" title="Class named_scope_list">named_scope_list</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47   <a class="link" href="named_scope_list.html" title="Class named_scope_list">named_scope_list</a> <span class="special">&amp;</span> <a class="link" href="named_scope_list.html#idm45711348518560-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="named_scope_list.html" title="Class named_scope_list">named_scope_list</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  48   <a class="link" href="named_scope_list.html#idm45711348519296-bb"><span class="special">~</span><span class="identifier">named_scope_list</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  49
  50   <span class="comment">// <a class="link" href="named_scope_list.html#idm45711348544176-bb">public member functions</a></span>
  51   <span class="identifier">const_iterator</span> <a class="link" href="named_scope_list.html#idm45711348543616-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  52   <span class="identifier">const_iterator</span> <a class="link" href="named_scope_list.html#idm45711348541456-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="identifier">const_reverse_iterator</span> <a class="link" href="named_scope_list.html#idm45711348539296-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54   <span class="identifier">const_reverse_iterator</span> <a class="link" href="named_scope_list.html#idm45711348537136-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55   <span class="identifier">size_type</span> <a class="link" href="named_scope_list.html#idm45711348534976-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  56   <span class="keyword">bool</span> <a class="link" href="named_scope_list.html#idm45711348532832-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  57   <span class="keyword">void</span> <a class="link" href="named_scope_list.html#idm45711348530688-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="named_scope_list.html" title="Class named_scope_list">named_scope_list</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  58   <span class="identifier">const_reference</span> <a class="link" href="named_scope_list.html#idm45711348528432-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59   <span class="identifier">const_reference</span> <a class="link" href="named_scope_list.html#idm45711348526304-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  60 <span class="special">}</span><span class="special">;</span></pre></div>
  61 <div class="refsect1">
  62 <a name="idm45554750681968"></a><h2>Description</h2>
  63 <p>The scope list provides a read-only access to a doubly-linked list of scopes. </p>
  64 <div class="refsect2">
  65 <a name="idm45554750681200"></a><h3>
  66 <a name="boost.log.attributes.named_scope_listtypes"></a><code class="computeroutput">named_scope_list</code>
  67         public
  68        types</h3>
  69 <div class="orderedlist"><ol class="orderedlist" type="1">
  70 <li class="listitem">
  71 <p>
  72 <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <a name="boost.log.attributes.named_scope_list.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span></p>
  73 <p>A constant iterator to the sequence of scopes. Complies to bidirectional iterator requirements. </p>
  74 </li>
  75 <li class="listitem">
  76 <p>
  77 <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <a name="boost.log.attributes.named_scope_list.iterator"></a><span class="identifier">iterator</span><span class="special">;</span></p>
  78 <p>An iterator to the sequence of scopes. Complies to bidirectional iterator requirements. </p>
  79 </li>
  80 <li class="listitem">
  81 <p>
  82 <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <a name="boost.log.attributes.named_scope_list.const_reverse_iterator"></a><span class="identifier">const_reverse_iterator</span><span class="special">;</span></p>
  83 <p>A constant reverse iterator to the sequence of scopes. Complies to bidirectional iterator requirements. </p>
  84 </li>
  85 <li class="listitem">
  86 <p>
  87 <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <a name="boost.log.attributes.named_scope_list.reverse_iterator"></a><span class="identifier">reverse_iterator</span><span class="special">;</span></p>
  88 <p>A reverse iterator to the sequence of scopes. Complies to bidirectional iterator requirements. </p>
  89 </li>
  90 </ol></div>
  91 </div>
  92 <div class="refsect2">
  93 <a name="idm45554750663440"></a><h3>
  94 <a name="boost.log.attributes.named_scope_listconstruct-copy-destruct"></a><code class="computeroutput">named_scope_list</code>
  95         public
  96        construct/copy/destruct</h3>
  97 <div class="orderedlist"><ol class="orderedlist" type="1">
  98 <li class="listitem">
  99 <pre class="literallayout"><a name="idm45711348524016-bb"></a><span class="identifier">named_scope_list</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 100 <p>Default constructor</p>
 101 <p>
 102 </p>
 103 <div class="variablelist"><table border="0" class="variablelist compact">
 104 <colgroup>
 105 <col align="left" valign="top">
 106 <col>
 107 </colgroup>
 108 <tbody><tr>
 109 <td><p><span class="term">Postconditions:</span></p></td>
 110 <td><p><code class="computeroutput">empty() == true</code> </p></td>
 111 </tr></tbody>
 112 </table></div>
 113 </li>
 114 <li class="listitem">
 115 <pre class="literallayout"><a name="idm45711348522160-bb"></a><span class="identifier">named_scope_list</span><span class="special">(</span><a class="link" href="named_scope_list.html" title="Class named_scope_list">named_scope_list</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
 116 <p>Copy constructor</p>
 117 <p>
 118 </p>
 119 <div class="variablelist"><table border="0" class="variablelist compact">
 120 <colgroup>
 121 <col align="left" valign="top">
 122 <col>
 123 </colgroup>
 124 <tbody><tr>
 125 <td><p><span class="term">Postconditions:</span></p></td>
 126 <td><p><code class="computeroutput">std::equal(begin(), end(), that.begin()) == true</code> </p></td>
 127 </tr></tbody>
 128 </table></div>
 129 </li>
 130 <li class="listitem">
 131 <pre class="literallayout"><a class="link" href="named_scope_list.html" title="Class named_scope_list">named_scope_list</a> <span class="special">&amp;</span> <a name="idm45711348518560-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="named_scope_list.html" title="Class named_scope_list">named_scope_list</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
 132 <p>Assignment operator</p>
 133 <p>
 134 </p>
 135 <div class="variablelist"><table border="0" class="variablelist compact">
 136 <colgroup>
 137 <col align="left" valign="top">
 138 <col>
 139 </colgroup>
 140 <tbody><tr>
 141 <td><p><span class="term">Postconditions:</span></p></td>
 142 <td><p><code class="computeroutput">std::equal(begin(), end(), that.begin()) == true</code> </p></td>
 143 </tr></tbody>
 144 </table></div>
 145 </li>
 146 <li class="listitem">
 147 <pre class="literallayout"><a name="idm45711348519296-bb"></a><span class="special">~</span><span class="identifier">named_scope_list</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 148 <p>Destructor. Destroys the stored entries. </p>
 149 </li>
 150 </ol></div>
 151 </div>
 152 <div class="refsect2">
 153 <a name="idm45554750631824"></a><h3>
 154 <a name="idm45711348544176-bb"></a><code class="computeroutput">named_scope_list</code> public member functions</h3>
 155 <div class="orderedlist"><ol class="orderedlist" type="1">
 156 <li class="listitem">
 157 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45711348543616-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 158 <p>
 159 </p>
 160 <div class="variablelist"><table border="0" class="variablelist compact">
 161 <colgroup>
 162 <col align="left" valign="top">
 163 <col>
 164 </colgroup>
 165 <tbody><tr>
 166 <td><p><span class="term">Returns:</span></p></td>
 167 <td><p>Constant iterator to the first element of the container. </p></td>
 168 </tr></tbody>
 169 </table></div>
 170 </li>
 171 <li class="listitem">
 172 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45711348541456-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 173 <p>
 174 </p>
 175 <div class="variablelist"><table border="0" class="variablelist compact">
 176 <colgroup>
 177 <col align="left" valign="top">
 178 <col>
 179 </colgroup>
 180 <tbody><tr>
 181 <td><p><span class="term">Returns:</span></p></td>
 182 <td><p>Constant iterator to the after-the-last element of the container. </p></td>
 183 </tr></tbody>
 184 </table></div>
 185 </li>
 186 <li class="listitem">
 187 <pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="idm45711348539296-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 188 <p>
 189 </p>
 190 <div class="variablelist"><table border="0" class="variablelist compact">
 191 <colgroup>
 192 <col align="left" valign="top">
 193 <col>
 194 </colgroup>
 195 <tbody><tr>
 196 <td><p><span class="term">Returns:</span></p></td>
 197 <td><p>Constant iterator to the last element of the container. </p></td>
 198 </tr></tbody>
 199 </table></div>
 200 </li>
 201 <li class="listitem">
 202 <pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="idm45711348537136-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 203 <p>
 204 </p>
 205 <div class="variablelist"><table border="0" class="variablelist compact">
 206 <colgroup>
 207 <col align="left" valign="top">
 208 <col>
 209 </colgroup>
 210 <tbody><tr>
 211 <td><p><span class="term">Returns:</span></p></td>
 212 <td><p>Constant iterator to the before-the-first element of the container. </p></td>
 213 </tr></tbody>
 214 </table></div>
 215 </li>
 216 <li class="listitem">
 217 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45711348534976-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 218 <p>
 219 </p>
 220 <div class="variablelist"><table border="0" class="variablelist compact">
 221 <colgroup>
 222 <col align="left" valign="top">
 223 <col>
 224 </colgroup>
 225 <tbody><tr>
 226 <td><p><span class="term">Returns:</span></p></td>
 227 <td><p>The number of elements in the container </p></td>
 228 </tr></tbody>
 229 </table></div>
 230 </li>
 231 <li class="listitem">
 232 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45711348532832-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>
 233 <p>
 234 </p>
 235 <div class="variablelist"><table border="0" class="variablelist compact">
 236 <colgroup>
 237 <col align="left" valign="top">
 238 <col>
 239 </colgroup>
 240 <tbody><tr>
 241 <td><p><span class="term">Returns:</span></p></td>
 242 <td><p>true if the container is empty and false otherwise </p></td>
 243 </tr></tbody>
 244 </table></div>
 245 </li>
 246 <li class="listitem">
 247 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711348530688-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="named_scope_list.html" title="Class named_scope_list">named_scope_list</a> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
 248 <p>Swaps two instances of the container </p>
 249 </li>
 250 <li class="listitem">
 251 <pre class="literallayout"><span class="identifier">const_reference</span> <a name="idm45711348528432-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 252 <p>
 253 </p>
 254 <div class="variablelist"><table border="0" class="variablelist compact">
 255 <colgroup>
 256 <col align="left" valign="top">
 257 <col>
 258 </colgroup>
 259 <tbody><tr>
 260 <td><p><span class="term">Returns:</span></p></td>
 261 <td><p>Last pushed scope entry </p></td>
 262 </tr></tbody>
 263 </table></div>
 264 </li>
 265 <li class="listitem">
 266 <pre class="literallayout"><span class="identifier">const_reference</span> <a name="idm45711348526304-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 267 <p>
 268 </p>
 269 <div class="variablelist"><table border="0" class="variablelist compact">
 270 <colgroup>
 271 <col align="left" valign="top">
 272 <col>
 273 </colgroup>
 274 <tbody><tr>
 275 <td><p><span class="term">Returns:</span></p></td>
 276 <td><p>First pushed scope entry </p></td>
 277 </tr></tbody>
 278 </table></div>
 279 </li>
 280 </ol></div>
 281 </div>
 282 </div>
 283 </div>
 284 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 285 <td align="left"></td>
 286 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 287         Distributed under the Boost Software License, Version 1.0. (See accompanying
 288         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>).
 289       </p>
 290 </div></td>
 291 </tr></table>
 292 <hr>
 293 <div class="spirit-nav">
 294 <a accesskey="p" href="named_scope_entry/scope_name_type.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../attributes.html#header.boost.log.attributes.named_scope_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="operator_idm45711348515120.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 295 </div>
 296 </body>
 297 </html>