libs/log/doc/html/boost/log/expressions/format_named_s_idp63031376.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template format_named_scope_terminal</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="../../../expressions.html#header.boost.log.expressions.formatters.named_scope_hpp" title="Header &lt;boost/log/expressions/formatters/named_scope.hpp&gt;">
   9 <link rel="prev" href="max_size_decor_idp63020160.html" title="Function template max_size_decor">
  10 <link rel="next" href="format_named_scope_actor.html" title="Class template format_named_scope_actor">
  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="max_size_decor_idp63020160.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.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="format_named_scope_actor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.format_named_s_idp63031376"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template format_named_scope_terminal</span></h2>
  22 <p>boost::log::expressions::format_named_scope_terminal</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="../../../expressions.html#header.boost.log.expressions.formatters.named_scope_hpp" title="Header &lt;boost/log/expressions/formatters/named_scope.hpp&gt;">boost/log/expressions/formatters/named_scope.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FallbackPolicyT<span class="special">,</span> <span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="format_named_s_idp63031376.html" title="Class template format_named_scope_terminal">format_named_scope_terminal</a> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// types</span>
  31   <span class="keyword">typedef</span> <span class="identifier">attributes</span><span class="special">::</span><span class="identifier">named_scope</span><span class="special">::</span><span class="identifier">value_type</span>   <a name="boost.log.expressions.format_named_s_idp63031376.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>               <span class="comment">// Attribute value type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">FallbackPolicyT</span>                       <a name="boost.log.expressions.format_named_s_idp63031376.fallback_policy"></a><span class="identifier">fallback_policy</span><span class="special">;</span>          <span class="comment">// Fallback policy. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">CharT</span>                                 <a name="boost.log.expressions.format_named_s_idp63031376.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>                <span class="comment">// Character type. </span>
  34   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span>        <a name="boost.log.expressions.format_named_s_idp63031376.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>              <span class="comment">// String type. </span>
  35   <span class="keyword">typedef</span> <span class="identifier">basic_formatting_ostream</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span> <a name="boost.log.expressions.format_named_s_idp63031376.stream_type"></a><span class="identifier">stream_type</span><span class="special">;</span>              <span class="comment">// Formatting stream type. </span>
  36   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                           <a name="boost.log.expressions.format_named_s_idp63031376.formatter_function_type"></a><span class="identifier">formatter_function_type</span><span class="special">;</span>  <span class="comment">// Formatter function. </span>
  37   <span class="keyword">typedef</span> <span class="identifier">string_type</span>                           <a name="boost.log.expressions.format_named_s_idp63031376.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>              <span class="comment">// Function result type. </span>
  38
  39   <span class="comment">// <a class="link" href="format_named_s_idp63031376.html#boost.log.expressions.format_named_s_idp63031376construct-copy-destruct">construct/copy/destruct</a></span>
  40   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FormatT<span class="special">&gt;</span>
  41     <a class="link" href="format_named_s_idp63031376.html#idp63052400-bb"><span class="identifier">format_named_scope_terminal</span></a><span class="special">(</span><span class="identifier">attribute_name</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
  42                                 <span class="identifier">fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">FormatT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
  43                                 <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
  44                                 <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">,</span>
  45                                 <span class="identifier">scope_iteration_direction</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="format_named_s_idp63031376.html#idp63059360-bb"><span class="identifier">format_named_scope_terminal</span></a><span class="special">(</span><a class="link" href="format_named_s_idp63031376.html" title="Class template format_named_scope_terminal">format_named_scope_terminal</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47   <a class="link" href="format_named_s_idp63031376.html#idp63060928-bb"><span class="identifier">format_named_scope_terminal</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  48
  49   <span class="comment">// <a class="link" href="format_named_s_idp63031376.html#idp63041776-bb">public member functions</a></span>
  50   <span class="identifier">attribute_name</span> <a class="link" href="format_named_s_idp63031376.html#idp63042336-bb"><span class="identifier">get_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  51   <span class="identifier">fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="format_named_s_idp63031376.html#idp63043760-bb"><span class="identifier">get_fallback_policy</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  52   <span class="identifier">formatter_function_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="format_named_s_idp63031376.html#idp63045184-bb"><span class="identifier">get_formatter_function</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="format_named_s_idp63031376.html#idp63046624-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  54   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="format_named_s_idp63031376.html#idp63049296-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55 <span class="special">}</span><span class="special">;</span></pre></div>
  56 <div class="refsect1">
  57 <a name="idp114355184"></a><h2>Description</h2>
  58 <p>Named scope formatter terminal. </p>
  59 <div class="refsect2">
  60 <a name="idp114355904"></a><h3>
  61 <a name="boost.log.expressions.format_named_s_idp63031376construct-copy-destruct"></a><code class="computeroutput">format_named_scope_terminal</code>
  62         public
  63        construct/copy/destruct</h3>
  64 <div class="orderedlist"><ol class="orderedlist" type="1">
  65 <li class="listitem">
  66 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FormatT<span class="special">&gt;</span>
  67   <a name="idp63052400-bb"></a><span class="identifier">format_named_scope_terminal</span><span class="special">(</span><span class="identifier">attribute_name</span> <span class="keyword">const</span> <span class="special">&amp;</span> name<span class="special">,</span>
  68                               <span class="identifier">fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> fallback<span class="special">,</span>
  69                               <span class="identifier">FormatT</span> <span class="keyword">const</span> <span class="special">&amp;</span> element_format<span class="special">,</span>
  70                               <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> delimiter<span class="special">,</span>
  71                               <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> incomplete_marker<span class="special">,</span>
  72                               <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> empty_marker<span class="special">,</span>
  73                               <span class="identifier">value_type</span><span class="special">::</span><span class="identifier">size_type</span> depth<span class="special">,</span>
  74                               <span class="identifier">scope_iteration_direction</span> direction<span class="special">)</span><span class="special">;</span></pre>Initializing constructor. </li>
  75 <li class="listitem">
  76 <pre class="literallayout"><a name="idp63059360-bb"></a><span class="identifier">format_named_scope_terminal</span><span class="special">(</span><a class="link" href="format_named_s_idp63031376.html" title="Class template format_named_scope_terminal">format_named_scope_terminal</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>Copy constructor. </li>
  77 <li class="listitem"><pre class="literallayout"><a name="idp63060928-bb"></a><span class="identifier">format_named_scope_terminal</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  78 </ol></div>
  79 </div>
  80 <div class="refsect2">
  81 <a name="idp114395184"></a><h3>
  82 <a name="idp63041776-bb"></a><code class="computeroutput">format_named_scope_terminal</code> public member functions</h3>
  83 <div class="orderedlist"><ol class="orderedlist" type="1">
  84 <li class="listitem">
  85 <pre class="literallayout"><span class="identifier">attribute_name</span> <a name="idp63042336-bb"></a><span class="identifier">get_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns attribute name. </li>
  86 <li class="listitem">
  87 <pre class="literallayout"><span class="identifier">fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp63043760-bb"></a><span class="identifier">get_fallback_policy</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns fallback policy. </li>
  88 <li class="listitem">
  89 <pre class="literallayout"><span class="identifier">formatter_function_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp63045184-bb"></a><span class="identifier">get_formatter_function</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Retruns formatter function. </li>
  90 <li class="listitem">
  91 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="idp63046624-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span> ctx<span class="special">)</span><span class="special">;</span></pre>Invokation operator. </li>
  92 <li class="listitem">
  93 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="idp63049296-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span> ctx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Invokation operator. </li>
  94 </ol></div>
  95 </div>
  96 </div>
  97 </div>
  98 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  99 <td align="left"></td>
 100 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 101         Distributed under the Boost Software License, Version 1.0. (See accompanying
 102         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>).
 103       </p>
 104 </div></td>
 105 </tr></table>
 106 <hr>
 107 <div class="spirit-nav">
 108 <a accesskey="p" href="max_size_decor_idp63020160.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.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="format_named_scope_actor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 109 </div>
 110 </body>
 111 </html>