Google Git
Sign in
nest-open-source / nest-cam / 4320010 / boost / 62d1066a6d52d5ac4e10c106f0eab14c820be0ce / . / boost / libs / log / doc / html / boost / log / formatter_factory.html
blob: a14da9bf34153db35b990f6a564a46d5879a6596 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Struct template formatter_factory</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
<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;">
<link rel="prev" href="basic_formatter_factory.html" title="Class template basic_formatter_factory">
<link rel="next" href="register_forma_idp46694672.html" title="Function template register_formatter_factory">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<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_forma_idp46694672.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.log.formatter_factory"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template formatter_factory</span></h2>
<p>boost::log::formatter_factory</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<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;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
<span class="keyword">struct</span> <a class="link" href="formatter_factory.html" title="Struct template formatter_factory">formatter_factory</a> <span class="special">{</span>
<span class="comment">// <a class="link" href="formatter_factory.html#boost.log.formatter_factorytypes">types</a></span>
<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>
<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>
<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>
<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>
<span class="comment">// <a class="link" href="formatter_factory.html#boost.log.formatter_factoryconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="formatter_factory.html#idp46689152-bb"><span class="identifier">formatter_factory</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
<a class="link" href="formatter_factory.html#idp46690832-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>
<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#idp46692368-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>
<a class="link" href="formatter_factory.html#idp46690128-bb"><span class="special">~</span><span class="identifier">formatter_factory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="formatter_factory.html#idp46684080-bb">public member functions</a></span>
<span class="keyword">virtual</span> <span class="identifier">formatter_type</span>
<a class="link" href="formatter_factory.html#idp46684640-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>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp134347488"></a><h2>Description</h2>
<p>Formatter factory base interface. </p>
<div class="refsect2">
<a name="idp134348128"></a><h3>
<a name="boost.log.formatter_factorytypes"></a><code class="computeroutput">formatter_factory</code>
public
types</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<p>
<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>
<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>
</li></ol></div>
</div>
<div class="refsect2">
<a name="idp134358800"></a><h3>
<a name="boost.log.formatter_factoryconstruct-copy-destruct"></a><code class="computeroutput">formatter_factory</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idp46689152-bb"></a><span class="identifier">formatter_factory</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>
<p>Default constructor </p>
</li>
<li class="listitem"><pre class="literallayout"><a name="idp46690832-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>
<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="idp46692368-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>
<li class="listitem">
<pre class="literallayout"><a name="idp46690128-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>
<p>Virtual destructor </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp134386848"></a><h3>
<a name="idp46684080-bb"></a><code class="computeroutput">formatter_factory</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">formatter_type</span>
<a name="idp46684640-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>
<p>The function creates a formatter for the specified attribute.</p>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">args</code></span></p></td>
<td><p>Formatter arguments </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">name</code></span></p></td>
<td><p>Attribute name </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li></ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2007-2015 Andrey
Semashev<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>).
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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_forma_idp46694672.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>