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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template format_named_scope_actor</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="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="format_named_s_idp36263472.html" title="Class template format_named_scope_terminal">
  10 <link rel="next" href="format_named_s_idp36316432.html" title="Function template format_named_scope">
  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="format_named_s_idp36263472.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_s_idp36316432.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_scope_actor"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template format_named_scope_actor</span></h2>
  22 <p>boost::log::expressions::format_named_scope_actor</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">,</span>
  28          <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="special">&gt;</span> <span class="keyword">class</span> ActorT <span class="special">=</span> <span class="identifier">phoenix</span><span class="special">::</span><span class="identifier">actor</span><span class="special">&gt;</span>
  29 <span class="keyword">class</span> <a class="link" href="format_named_scope_actor.html" title="Class template format_named_scope_actor">format_named_scope_actor</a> <span class="special">:</span>
  30   <span class="keyword">public</span> <span class="identifier">ActorT</span><span class="special">&lt;</span> <span class="identifier">format_named_scope_terminal</span><span class="special">&lt;</span> <span class="identifier">FallbackPolicyT</span><span class="special">,</span> <span class="identifier">CharT</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
  31 <span class="special">{</span>
  32 <span class="keyword">public</span><span class="special">:</span>
  33   <span class="comment">// types</span>
  34   <span class="keyword">typedef</span> <span class="identifier">CharT</span>                                                     <a name="boost.log.expressions.format_named_scope_actor.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>                <span class="comment">// Character type. </span>
  35   <span class="keyword">typedef</span> <span class="identifier">FallbackPolicyT</span>                                           <a name="boost.log.expressions.format_named_scope_actor.fallback_policy"></a><span class="identifier">fallback_policy</span><span class="special">;</span>          <span class="comment">// Fallback policy. </span>
  36   <span class="keyword">typedef</span> <a class="link" href="format_named_s_idp36263472.html" title="Class template format_named_scope_terminal">format_named_scope_terminal</a><span class="special">&lt;</span> <span class="identifier">fallback_policy</span><span class="special">,</span> <span class="identifier">char_type</span> <span class="special">&gt;</span> <a name="boost.log.expressions.format_named_scope_actor.terminal_type"></a><span class="identifier">terminal_type</span><span class="special">;</span>            <span class="comment">// Base terminal type. </span>
  37   <span class="keyword">typedef</span> <span class="identifier">terminal_type</span><span class="special">::</span><span class="identifier">value_type</span>                                 <a name="boost.log.expressions.format_named_scope_actor.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>               <span class="comment">// Attribute value type. </span>
  38   <span class="keyword">typedef</span> <span class="identifier">terminal_type</span><span class="special">::</span><span class="identifier">formatter_function_type</span>                    <a name="boost.log.expressions.format_named_scope_actor.formatter_function_type"></a><span class="identifier">formatter_function_type</span><span class="special">;</span>  <span class="comment">// Formatter function. </span>
  39   <span class="keyword">typedef</span> <span class="identifier">ActorT</span><span class="special">&lt;</span> <span class="identifier">terminal_type</span> <span class="special">&gt;</span>                                   <a name="boost.log.expressions.format_named_scope_actor.base_type"></a><span class="identifier">base_type</span><span class="special">;</span>                <span class="comment">// Base actor type. </span>
  40
  41   <span class="comment">// <a class="link" href="format_named_scope_actor.html#boost.log.expressions.format_named_scope_actorconstruct-copy-destruct">construct/copy/destruct</a></span>
  42   <span class="keyword">explicit</span> <a class="link" href="format_named_scope_actor.html#idp36312528-bb"><span class="identifier">format_named_scope_actor</span></a><span class="special">(</span><span class="identifier">base_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  43
  44   <span class="comment">// <a class="link" href="format_named_scope_actor.html#idp36305936-bb">public member functions</a></span>
  45   <span class="identifier">attribute_name</span> <a class="link" href="format_named_scope_actor.html#idp36306496-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>
  46   <span class="identifier">fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="format_named_scope_actor.html#idp36308448-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>
  47   <span class="identifier">formatter_function_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="format_named_scope_actor.html#idp36310400-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>
  48 <span class="special">}</span><span class="special">;</span></pre></div>
  49 <div class="refsect1">
  50 <a name="idp97466848"></a><h2>Description</h2>
  51 <p>Named scope formatter actor. </p>
  52 <div class="refsect2">
  53 <a name="idp97467568"></a><h3>
  54 <a name="boost.log.expressions.format_named_scope_actorconstruct-copy-destruct"></a><code class="computeroutput">format_named_scope_actor</code>
  55         public
  56        construct/copy/destruct</h3>
  57 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  58 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp36312528-bb"></a><span class="identifier">format_named_scope_actor</span><span class="special">(</span><span class="identifier">base_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> act<span class="special">)</span><span class="special">;</span></pre>Initializing constructor. </li></ol></div>
  59 </div>
  60 <div class="refsect2">
  61 <a name="idp97476464"></a><h3>
  62 <a name="idp36305936-bb"></a><code class="computeroutput">format_named_scope_actor</code> public member functions</h3>
  63 <div class="orderedlist"><ol class="orderedlist" type="1">
  64 <li class="listitem">
  65 <pre class="literallayout"><span class="identifier">attribute_name</span> <a name="idp36306496-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>
  66 <p>
  67 </p>
  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">Returns:</span></p></td>
  75 <td><p>The attribute name </p></td>
  76 </tr></tbody>
  77 </table></div>
  78 </li>
  79 <li class="listitem">
  80 <pre class="literallayout"><span class="identifier">fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp36308448-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>
  81 <p>
  82 </p>
  83 <div class="variablelist"><table border="0" class="variablelist compact">
  84 <colgroup>
  85 <col align="left" valign="top">
  86 <col>
  87 </colgroup>
  88 <tbody><tr>
  89 <td><p><span class="term">Returns:</span></p></td>
  90 <td><p>Fallback policy </p></td>
  91 </tr></tbody>
  92 </table></div>
  93 </li>
  94 <li class="listitem">
  95 <pre class="literallayout"><span class="identifier">formatter_function_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp36310400-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>
  96 <p>
  97 </p>
  98 <div class="variablelist"><table border="0" class="variablelist compact">
  99 <colgroup>
 100 <col align="left" valign="top">
 101 <col>
 102 </colgroup>
 103 <tbody><tr>
 104 <td><p><span class="term">Returns:</span></p></td>
 105 <td><p>Formatter function </p></td>
 106 </tr></tbody>
 107 </table></div>
 108 </li>
 109 </ol></div>
 110 </div>
 111 </div>
 112 </div>
 113 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 114 <td align="left"></td>
 115 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2014 Andrey Semashev<p>
 116         Distributed under the Boost Software License, Version 1.0. (See accompanying
 117         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>).
 118       </p>
 119 </div></td>
 120 </tr></table>
 121 <hr>
 122 <div class="spirit-nav">
 123 <a accesskey="p" href="format_named_s_idp36263472.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_s_idp36316432.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 124 </div>
 125 </body>
 126 </html>