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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct named_scope_entry</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="mutable_consta_idp62118016/impl.html" title="Class impl">
  10 <link rel="next" href="named_scope_entry/scope_name_type.html" title="Type scope_name_type">
  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="mutable_consta_idp62118016/impl.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="named_scope_entry/scope_name_type.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_entry"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Struct named_scope_entry</span></h2>
  22 <p>boost::log::attributes::named_scope_entry &#8212; The structure contains all information about a named scope. </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">struct</span> <a class="link" href="named_scope_entry.html" title="Struct named_scope_entry">named_scope_entry</a> <span class="special">{</span>
  29   <span class="keyword">enum</span> <a class="link" href="named_scope_entry/scope_name_type.html" title="Type scope_name_type">scope_name_type</a><span class="special">;</span>
  30   <span class="comment">// <a class="link" href="named_scope_entry.html#boost.log.attributes.named_scope_entryconstruct-copy-destruct">construct/copy/destruct</a></span>
  31   <a class="link" href="named_scope_entry.html#idp62164352-bb"><span class="identifier">named_scope_entry</span></a><span class="special">(</span><span class="identifier">string_literal</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">string_literal</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
  32                     <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">scope_name_type</span> <span class="special">=</span> <span class="identifier">general</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  33
  34   <span class="comment">// <a class="link" href="named_scope_entry.html#boost.log.attributes.named_scope_entrypublic-data-members">public data members</a></span>
  35   <span class="identifier">string_literal</span> <a class="link" href="named_scope_entry.html#boost.log.attributes.named_scope_entry.scope_name"><span class="identifier">scope_name</span></a><span class="special">;</span>
  36   <span class="identifier">string_literal</span> <a class="link" href="named_scope_entry.html#boost.log.attributes.named_scope_entry.file_name"><span class="identifier">file_name</span></a><span class="special">;</span>
  37   <span class="keyword">unsigned</span> <span class="keyword">int</span> <a class="link" href="named_scope_entry.html#boost.log.attributes.named_scope_entry.line"><span class="identifier">line</span></a><span class="special">;</span>
  38   <span class="identifier">scope_name_type</span> <a class="link" href="named_scope_entry.html#boost.log.attributes.named_scope_entry.type"><span class="identifier">type</span></a><span class="special">;</span>
  39 <span class="special">}</span><span class="special">;</span></pre></div>
  40 <div class="refsect1">
  41 <a name="idp107819152"></a><h2>Description</h2>
  42 <p>The named scope entries are stored as elements of <code class="computeroutput">basic_named_scope_list</code> container, which in turn can be acquired either from the <code class="computeroutput">basic_named_scope</code> attribute value or from a thread-local instance. </p>
  43 <div class="refsect2">
  44 <a name="idp107821264"></a><h3>
  45 <a name="boost.log.attributes.named_scope_entryconstruct-copy-destruct"></a><code class="computeroutput">named_scope_entry</code>
  46         public
  47        construct/copy/destruct</h3>
  48 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  49 <pre class="literallayout"><a name="idp62164352-bb"></a><span class="identifier">named_scope_entry</span><span class="special">(</span><span class="identifier">string_literal</span> <span class="keyword">const</span> <span class="special">&amp;</span> sn<span class="special">,</span> <span class="identifier">string_literal</span> <span class="keyword">const</span> <span class="special">&amp;</span> fn<span class="special">,</span>
  50                   <span class="keyword">unsigned</span> <span class="keyword">int</span> ln<span class="special">,</span> <span class="identifier">scope_name_type</span> t <span class="special">=</span> <span class="identifier">general</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  51 <p>Initializing constructor</p>
  52 <p>
  53 <span class="bold"><strong>Throws:</strong></span> Nothing. </p>
  54 <div class="variablelist"><table border="0" class="variablelist compact">
  55 <colgroup>
  56 <col align="left" valign="top">
  57 <col>
  58 </colgroup>
  59 <tbody><tr>
  60 <td><p><span class="term">Postconditions:</span></p></td>
  61 <td><p><code class="computeroutput">scope_name == sn &amp;&amp; file_name == fn &amp;&amp; line == ln</code></p></td>
  62 </tr></tbody>
  63 </table></div>
  64 </li></ol></div>
  65 </div>
  66 <div class="refsect2">
  67 <a name="idp107840576"></a><h3>
  68 <a name="boost.log.attributes.named_scope_entrypublic-data-members"></a><code class="computeroutput">named_scope_entry</code>
  69         public
  70        public data members</h3>
  71 <div class="orderedlist"><ol class="orderedlist" type="1">
  72 <li class="listitem">
  73 <pre class="literallayout"><span class="identifier">string_literal</span> <a name="boost.log.attributes.named_scope_entry.scope_name"></a><span class="identifier">scope_name</span><span class="special">;</span></pre>
  74 <p>The scope name (e.g. a function signature) </p>
  75 </li>
  76 <li class="listitem">
  77 <pre class="literallayout"><span class="identifier">string_literal</span> <a name="boost.log.attributes.named_scope_entry.file_name"></a><span class="identifier">file_name</span><span class="special">;</span></pre>
  78 <p>The source file name </p>
  79 </li>
  80 <li class="listitem">
  81 <pre class="literallayout"><span class="keyword">unsigned</span> <span class="keyword">int</span> <a name="boost.log.attributes.named_scope_entry.line"></a><span class="identifier">line</span><span class="special">;</span></pre>
  82 <p>The line number in the source file </p>
  83 </li>
  84 <li class="listitem">
  85 <pre class="literallayout"><span class="identifier">scope_name_type</span> <a name="boost.log.attributes.named_scope_entry.type"></a><span class="identifier">type</span><span class="special">;</span></pre>
  86 <p>The scope name type </p>
  87 </li>
  88 </ol></div>
  89 </div>
  90 </div>
  91 </div>
  92 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  93 <td align="left"></td>
  94 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  95         Distributed under the Boost Software License, Version 1.0. (See accompanying
  96         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>).
  97       </p>
  98 </div></td>
  99 </tr></table>
 100 <hr>
 101 <div class="spirit-nav">
 102 <a accesskey="p" href="mutable_consta_idp62118016/impl.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="named_scope_entry/scope_name_type.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 103 </div>
 104 </body>
 105 </html>