libs/log/doc/html/boost/log/formatter_factory.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template formatter_factory</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="../../utilities.html#header.boost.log.utility.setup.formatter_parser_hpp" title="Header &lt;boost/log/utility/setup/formatter_parser.hpp&gt;">
   9 <link rel="prev" href="basic_formatter_factory.html" title="Class template basic_formatter_factory">
  10 <link rel="next" href="register_idm45711342909824.html" title="Function template register_formatter_factory">
  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="basic_formatter_factory.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.setup.formatter_parser_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="register_idm45711342909824.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.formatter_factory"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Struct template formatter_factory</span></h2>
  22 <p>boost::log::formatter_factory</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="../../utilities.html#header.boost.log.utility.setup.formatter_parser_hpp" title="Header &lt;boost/log/utility/setup/formatter_parser.hpp&gt;">boost/log/utility/setup/formatter_parser.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  28 <span class="keyword">struct</span> <a class="link" href="formatter_factory.html" title="Struct template formatter_factory">formatter_factory</a> <span class="special">{</span>
  29   <span class="comment">// <a class="link" href="formatter_factory.html#boost.log.formatter_factorytypes">types</a></span>
  30   <span class="keyword">typedef</span> <span class="identifier">CharT</span>                                <a name="boost.log.formatter_factory.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>       <span class="comment">// Character type. </span>
  31   <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.formatter_factory.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>     <span class="comment">// String type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">basic_formatter</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span>         <a name="boost.log.formatter_factory.formatter_type"></a><span class="identifier">formatter_type</span><span class="special">;</span>  <span class="comment">// The formatter function object. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span><span class="special">&lt;</span> <span class="identifier">string_type</span><span class="special">,</span> <span class="identifier">string_type</span> <span class="special">&gt;</span> <a class="link" href="formatter_factory.html#boost.log.formatter_factory.args_map"><span class="identifier">args_map</span></a><span class="special">;</span>
  34
  35   <span class="comment">// <a class="link" href="formatter_factory.html#boost.log.formatter_factoryconstruct-copy-destruct">construct/copy/destruct</a></span>
  36   <a class="link" href="formatter_factory.html#idm45711342913664-bb"><span class="identifier">formatter_factory</span></a><span class="special">(</span><a class="link" href="formatter_factory.html" title="Struct template formatter_factory">formatter_factory</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  37   <a class="link" href="formatter_factory.html" title="Struct template formatter_factory">formatter_factory</a> <span class="special">&amp;</span> <a class="link" href="formatter_factory.html#idm45711342912128-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="formatter_factory.html" title="Struct template formatter_factory">formatter_factory</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  38   <a class="link" href="formatter_factory.html#idm45711342914656-bb"><span class="special">~</span><span class="identifier">formatter_factory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="formatter_factory.html#idm45711342919728-bb">public member functions</a></span>
  41   <span class="keyword">virtual</span> <span class="identifier">formatter_type</span>
  42   <a class="link" href="formatter_factory.html#idm45711342919168-bb"><span class="identifier">create_formatter</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> <span class="identifier">args_map</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
  43 <span class="special">}</span><span class="special">;</span></pre></div>
  44 <div class="refsect1">
  45 <a name="idm45554721783680"></a><h2>Description</h2>
  46 <p>Formatter factory base interface. </p>
  47 <div class="refsect2">
  48 <a name="idm45554721782960"></a><h3>
  49 <a name="boost.log.formatter_factorytypes"></a><code class="computeroutput">formatter_factory</code>
  50         public
  51        types</h3>
  52 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  53 <p>
  54 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span><span class="special">&lt;</span> <span class="identifier">string_type</span><span class="special">,</span> <span class="identifier">string_type</span> <span class="special">&gt;</span> <a name="boost.log.formatter_factory.args_map"></a><span class="identifier">args_map</span><span class="special">;</span></p>
  55 <p>Type of the map of formatter factory arguments [argument name -&gt; argument value]. This type of maps will be passed to formatter factories on attempt to create a formatter. </p>
  56 </li></ol></div>
  57 </div>
  58 <div class="refsect2">
  59 <a name="idm45554721772352"></a><h3>
  60 <a name="boost.log.formatter_factoryconstruct-copy-destruct"></a><code class="computeroutput">formatter_factory</code>
  61         public
  62        construct/copy/destruct</h3>
  63 <div class="orderedlist"><ol class="orderedlist" type="1">
  64 <li class="listitem"><pre class="literallayout"><a name="idm45711342913664-bb"></a><span class="identifier">formatter_factory</span><span class="special">(</span><a class="link" href="formatter_factory.html" title="Struct template formatter_factory">formatter_factory</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  65 <li class="listitem"><pre class="literallayout"><a class="link" href="formatter_factory.html" title="Struct template formatter_factory">formatter_factory</a> <span class="special">&amp;</span> <a name="idm45711342912128-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="formatter_factory.html" title="Struct template formatter_factory">formatter_factory</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  66 <li class="listitem">
  67 <pre class="literallayout"><a name="idm45711342914656-bb"></a><span class="special">~</span><span class="identifier">formatter_factory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  68 <p>Default constructor</p>
  69 <p>Virtual destructor </p>
  70 </li>
  71 </ol></div>
  72 </div>
  73 <div class="refsect2">
  74 <a name="idm45554721749152"></a><h3>
  75 <a name="idm45711342919728-bb"></a><code class="computeroutput">formatter_factory</code> public member functions</h3>
  76 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  77 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">formatter_type</span>
  78 <a name="idm45711342919168-bb"></a><span class="identifier">create_formatter</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> <span class="identifier">args_map</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre>
  79 <p>The function creates a formatter for the specified attribute.</p>
  80 <p>
  81 </p>
  82 <div class="variablelist"><table border="0" class="variablelist compact">
  83 <colgroup>
  84 <col align="left" valign="top">
  85 <col>
  86 </colgroup>
  87 <tbody><tr>
  88 <td><p><span class="term">Parameters:</span></p></td>
  89 <td><div class="variablelist"><table border="0" class="variablelist compact">
  90 <colgroup>
  91 <col align="left" valign="top">
  92 <col>
  93 </colgroup>
  94 <tbody>
  95 <tr>
  96 <td><p><span class="term"><code class="computeroutput">args</code></span></p></td>
  97 <td><p>Formatter arguments </p></td>
  98 </tr>
  99 <tr>
 100 <td><p><span class="term"><code class="computeroutput">name</code></span></p></td>
 101 <td><p>Attribute name </p></td>
 102 </tr>
 103 </tbody>
 104 </table></div></td>
 105 </tr></tbody>
 106 </table></div>
 107 </li></ol></div>
 108 </div>
 109 </div>
 110 </div>
 111 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 112 <td align="left"></td>
 113 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 114         Distributed under the Boost Software License, Version 1.0. (See accompanying
 115         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>).
 116       </p>
 117 </div></td>
 118 </tr></table>
 119 <hr>
 120 <div class="spirit-nav">
 121 <a accesskey="p" href="basic_formatter_factory.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.setup.formatter_parser_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="register_idm45711342909824.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 122 </div>
 123 </body>
 124 </html>