libs/log/doc/html/boost/log/filter_factory.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template filter_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.filter_parser_hpp" title="Header &lt;boost/log/utility/setup/filter_parser.hpp&gt;">
   9 <link rel="prev" href="basic_filter_factory.html" title="Class template basic_filter_factory">
  10 <link rel="next" href="register_idm45711342993072.html" title="Function template register_filter_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_filter_factory.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.setup.filter_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_idm45711342993072.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.filter_factory"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Struct template filter_factory</span></h2>
  22 <p>boost::log::filter_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.filter_parser_hpp" title="Header &lt;boost/log/utility/setup/filter_parser.hpp&gt;">boost/log/utility/setup/filter_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="filter_factory.html" title="Struct template filter_factory">filter_factory</a> <span class="special">{</span>
  29   <span class="comment">// types</span>
  30   <span class="keyword">typedef</span> <span class="identifier">CharT</span>                          <a name="boost.log.filter_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.filter_factory.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>  <span class="comment">// String type. </span>
  32
  33   <span class="comment">// <a class="link" href="filter_factory.html#boost.log.filter_factoryconstruct-copy-destruct">construct/copy/destruct</a></span>
  34   <a class="link" href="filter_factory.html#idm45711342996912-bb"><span class="identifier">filter_factory</span></a><span class="special">(</span><a class="link" href="filter_factory.html" title="Struct template filter_factory">filter_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>
  35   <a class="link" href="filter_factory.html" title="Struct template filter_factory">filter_factory</a> <span class="special">&amp;</span> <a class="link" href="filter_factory.html#idm45711342995376-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="filter_factory.html" title="Struct template filter_factory">filter_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>
  36   <a class="link" href="filter_factory.html#idm45711342997904-bb"><span class="special">~</span><span class="identifier">filter_factory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  37
  38   <span class="comment">// <a class="link" href="filter_factory.html#idm45711343022208-bb">public member functions</a></span>
  39   <span class="keyword">virtual</span> <span class="identifier">filter</span> <a class="link" href="filter_factory.html#idm45711343021648-bb"><span class="identifier">on_exists_test</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="special">;</span>
  40   <span class="keyword">virtual</span> <span class="identifier">filter</span>
  41   <a class="link" href="filter_factory.html#idm45711343019376-bb"><span class="identifier">on_equality_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  42   <span class="keyword">virtual</span> <span class="identifier">filter</span>
  43   <a class="link" href="filter_factory.html#idm45711343016432-bb"><span class="identifier">on_inequality_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44   <span class="keyword">virtual</span> <span class="identifier">filter</span> <a class="link" href="filter_factory.html#idm45711343013488-bb"><span class="identifier">on_less_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">virtual</span> <span class="identifier">filter</span>
  46   <a class="link" href="filter_factory.html#idm45711343010560-bb"><span class="identifier">on_greater_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">virtual</span> <span class="identifier">filter</span>
  48   <a class="link" href="filter_factory.html#idm45711343007616-bb"><span class="identifier">on_less_or_equal_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  49   <span class="keyword">virtual</span> <span class="identifier">filter</span>
  50   <a class="link" href="filter_factory.html#idm45711343004656-bb"><span class="identifier">on_greater_or_equal_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  51   <span class="keyword">virtual</span> <span class="identifier">filter</span>
  52   <a class="link" href="filter_factory.html#idm45711343001696-bb"><span class="identifier">on_custom_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
  53                      <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  54 <span class="special">}</span><span class="special">;</span></pre></div>
  55 <div class="refsect1">
  56 <a name="idm45554722324704"></a><h2>Description</h2>
  57 <p>The interface class for all filter factories. </p>
  58 <div class="refsect2">
  59 <a name="idm45554722323968"></a><h3>
  60 <a name="boost.log.filter_factoryconstruct-copy-destruct"></a><code class="computeroutput">filter_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="idm45711342996912-bb"></a><span class="identifier">filter_factory</span><span class="special">(</span><a class="link" href="filter_factory.html" title="Struct template filter_factory">filter_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="filter_factory.html" title="Struct template filter_factory">filter_factory</a> <span class="special">&amp;</span> <a name="idm45711342995376-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="filter_factory.html" title="Struct template filter_factory">filter_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="idm45711342997904-bb"></a><span class="special">~</span><span class="identifier">filter_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="idm45554722300848"></a><h3>
  75 <a name="idm45711343022208-bb"></a><code class="computeroutput">filter_factory</code> public member functions</h3>
  76 <div class="orderedlist"><ol class="orderedlist" type="1">
  77 <li class="listitem">
  78 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">filter</span> <a name="idm45711343021648-bb"></a><span class="identifier">on_exists_test</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="special">;</span></pre>
  79 <p>The callback for filter for the attribute existence test </p>
  80 </li>
  81 <li class="listitem">
  82 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">filter</span>
  83 <a name="idm45711343019376-bb"></a><span class="identifier">on_equality_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> arg<span class="special">)</span><span class="special">;</span></pre>
  84 <p>The callback for equality relation filter </p>
  85 </li>
  86 <li class="listitem">
  87 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">filter</span>
  88 <a name="idm45711343016432-bb"></a><span class="identifier">on_inequality_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> arg<span class="special">)</span><span class="special">;</span></pre>
  89 <p>The callback for inequality relation filter </p>
  90 </li>
  91 <li class="listitem">
  92 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">filter</span>
  93 <a name="idm45711343013488-bb"></a><span class="identifier">on_less_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> arg<span class="special">)</span><span class="special">;</span></pre>
  94 <p>The callback for less relation filter </p>
  95 </li>
  96 <li class="listitem">
  97 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">filter</span>
  98 <a name="idm45711343010560-bb"></a><span class="identifier">on_greater_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> arg<span class="special">)</span><span class="special">;</span></pre>
  99 <p>The callback for greater relation filter </p>
 100 </li>
 101 <li class="listitem">
 102 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">filter</span>
 103 <a name="idm45711343007616-bb"></a><span class="identifier">on_less_or_equal_relation</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>
 104                           <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> arg<span class="special">)</span><span class="special">;</span></pre>
 105 <p>The callback for less or equal relation filter </p>
 106 </li>
 107 <li class="listitem">
 108 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">filter</span>
 109 <a name="idm45711343004656-bb"></a><span class="identifier">on_greater_or_equal_relation</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>
 110                              <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> arg<span class="special">)</span><span class="special">;</span></pre>
 111 <p>The callback for greater or equal relation filter </p>
 112 </li>
 113 <li class="listitem">
 114 <pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">filter</span>
 115 <a name="idm45711343001696-bb"></a><span class="identifier">on_custom_relation</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">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> rel<span class="special">,</span>
 116                    <span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> arg<span class="special">)</span><span class="special">;</span></pre>
 117 <p>The callback for custom relation filter </p>
 118 </li>
 119 </ol></div>
 120 </div>
 121 </div>
 122 </div>
 123 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 124 <td align="left"></td>
 125 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 126         Distributed under the Boost Software License, Version 1.0. (See accompanying
 127         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>).
 128       </p>
 129 </div></td>
 130 </tr></table>
 131 <hr>
 132 <div class="spirit-nav">
 133 <a accesskey="p" href="basic_filter_factory.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.setup.filter_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_idm45711342993072.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 134 </div>
 135 </body>
 136 </html>