libs/log/doc/html/boost/log/filter.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class filter</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.filter_hpp" title="Header &lt;boost/log/expressions/filter.hpp&gt;">
   9 <link rel="prev" href="expressions/attribute_terminal.html" title="Class template attribute_terminal">
  10 <link rel="next" href="filter/default_filter.html" title="Struct default_filter">
  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="expressions/attribute_terminal.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../expressions.html#header.boost.log.expressions.filter_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="filter/default_filter.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.filter"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class filter</span></h2>
  22 <p>boost::log::filter</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.filter_hpp" title="Header &lt;boost/log/expressions/filter.hpp&gt;">boost/log/expressions/filter.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">class</span> <a class="link" href="filter.html" title="Class filter">filter</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="keyword">bool</span> <a name="boost.log.filter.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>  <span class="comment">// Result type. </span>
  32
  33   <span class="comment">// member classes/structs/unions</span>
  34
  35   <span class="comment">// Default filter, always returns <code class="computeroutput">true</code>. </span>
  36
  37   <span class="keyword">struct</span> <a class="link" href="filter/default_filter.html" title="Struct default_filter">default_filter</a> <span class="special">{</span>
  38     <span class="comment">// types</span>
  39     <span class="keyword">typedef</span> <span class="keyword">bool</span> <a class="link" href="filter/default_filter.html#boost.log.filter.default_filter.result_type"><span class="identifier">result_type</span></a><span class="special">;</span>
  40
  41     <span class="comment">// <a class="link" href="filter/default_filter.html#idm45711349553056-bb">public member functions</a></span>
  42     <span class="identifier">result_type</span> <a class="link" href="filter/default_filter.html#idm45711349552496-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">attribute_value_set</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43   <span class="special">}</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="filter.html#boost.log.filterconstruct-copy-destruct">construct/copy/destruct</a></span>
  46   <a class="link" href="filter.html#idm45711349540096-bb"><span class="identifier">filter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  47   <a class="link" href="filter.html#idm45711349538896-bb"><span class="identifier">filter</span></a><span class="special">(</span><a class="link" href="filter.html" title="Class filter">filter</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  48   <a class="link" href="filter.html#idm45711349537216-bb"><span class="identifier">filter</span></a><span class="special">(</span><a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  49   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">&gt;</span> <a class="link" href="filter.html#idm45711349535200-bb"><span class="identifier">filter</span></a><span class="special">(</span><span class="identifier">FunT</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  50   <a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;</span> <a class="link" href="filter.html#idm45711349532880-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  51   <a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;</span> <a class="link" href="filter.html#idm45711349530288-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="filter.html" title="Class filter">filter</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  52   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">&gt;</span> <a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;</span> <a class="link" href="filter.html#idm45711349528032-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">FunT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  53
  54   <span class="comment">// <a class="link" href="filter.html#idm45711349549376-bb">public member functions</a></span>
  55   <span class="identifier">result_type</span> <a class="link" href="filter.html#idm45711349548816-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">attribute_value_set</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  56   <span class="keyword">void</span> <a class="link" href="filter.html#idm45711349544528-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  57   <span class="keyword">void</span> <a class="link" href="filter.html#idm45711349542768-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  58 <span class="special">}</span><span class="special">;</span></pre></div>
  59 <div class="refsect1">
  60 <a name="idm45554747681008"></a><h2>Description</h2>
  61 <p>Log record filter function wrapper. </p>
  62 <div class="refsect2">
  63 <a name="idm45554747680288"></a><h3>
  64 <a name="boost.log.filterconstruct-copy-destruct"></a><code class="computeroutput">filter</code>
  65         public
  66        construct/copy/destruct</h3>
  67 <div class="orderedlist"><ol class="orderedlist" type="1">
  68 <li class="listitem">
  69 <pre class="literallayout"><a name="idm45711349540096-bb"></a><span class="identifier">filter</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  70 <p>Default constructor. Creates a filter that always returns <code class="computeroutput">true</code>. </p>
  71 </li>
  72 <li class="listitem">
  73 <pre class="literallayout"><a name="idm45711349538896-bb"></a><span class="identifier">filter</span><span class="special">(</span><a class="link" href="filter.html" title="Class filter">filter</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  74 <p>Copy constructor </p>
  75 </li>
  76 <li class="listitem">
  77 <pre class="literallayout"><a name="idm45711349537216-bb"></a><span class="identifier">filter</span><span class="special">(</span><a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  78 <p>Move constructor. The moved-from filter is left in an unspecified state. </p>
  79 </li>
  80 <li class="listitem">
  81 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">&gt;</span> <a name="idm45711349535200-bb"></a><span class="identifier">filter</span><span class="special">(</span><span class="identifier">FunT</span> <span class="special">&amp;&amp;</span> fun<span class="special">)</span><span class="special">;</span></pre>
  82 <p>Initializing constructor. Creates a filter which will invoke the specified function object. </p>
  83 </li>
  84 <li class="listitem">
  85 <pre class="literallayout"><a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;</span> <a name="idm45711349532880-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
  86 <p>Move assignment. The moved-from filter is left in an unspecified state. </p>
  87 </li>
  88 <li class="listitem">
  89 <pre class="literallayout"><a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;</span> <a name="idm45711349530288-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="filter.html" title="Class filter">filter</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  90 <p>Copy assignment. </p>
  91 </li>
  92 <li class="listitem">
  93 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">&gt;</span> <a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;</span> <a name="idm45711349528032-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">FunT</span> <span class="keyword">const</span> <span class="special">&amp;</span> fun<span class="special">)</span><span class="special">;</span></pre>
  94 <p>Initializing assignment. Sets the specified function object to the filter. </p>
  95 </li>
  96 </ol></div>
  97 </div>
  98 <div class="refsect2">
  99 <a name="idm45554747626128"></a><h3>
 100 <a name="idm45711349549376-bb"></a><code class="computeroutput">filter</code> public member functions</h3>
 101 <div class="orderedlist"><ol class="orderedlist" type="1">
 102 <li class="listitem">
 103 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45711349548816-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">attribute_value_set</span> <span class="keyword">const</span> <span class="special">&amp;</span> values<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 104 <p>Filtering operator.</p>
 105 <p>
 106
 107 </p>
 108 <div class="variablelist"><table border="0" class="variablelist compact">
 109 <colgroup>
 110 <col align="left" valign="top">
 111 <col>
 112 </colgroup>
 113 <tbody>
 114 <tr>
 115 <td><p><span class="term">Parameters:</span></p></td>
 116 <td><div class="variablelist"><table border="0" class="variablelist compact">
 117 <colgroup>
 118 <col align="left" valign="top">
 119 <col>
 120 </colgroup>
 121 <tbody><tr>
 122 <td><p><span class="term"><code class="computeroutput">values</code></span></p></td>
 123 <td><p>Attribute values of the log record. </p></td>
 124 </tr></tbody>
 125 </table></div></td>
 126 </tr>
 127 <tr>
 128 <td><p><span class="term">Returns:</span></p></td>
 129 <td><p><code class="computeroutput">true</code> if the log record passes the filter, <code class="computeroutput">false</code> otherwise. </p></td>
 130 </tr>
 131 </tbody>
 132 </table></div>
 133 </li>
 134 <li class="listitem">
 135 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711349544528-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 136 <p>Resets the filter to the default. The default filter always returns <code class="computeroutput">true</code>. </p>
 137 </li>
 138 <li class="listitem">
 139 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45711349542768-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="filter.html" title="Class filter">filter</a> <span class="special">&amp;</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 140 <p>Swaps two filters </p>
 141 </li>
 142 </ol></div>
 143 </div>
 144 </div>
 145 </div>
 146 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 147 <td align="left"></td>
 148 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 149         Distributed under the Boost Software License, Version 1.0. (See accompanying
 150         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>).
 151       </p>
 152 </div></td>
 153 </tr></table>
 154 <hr>
 155 <div class="spirit-nav">
 156 <a accesskey="p" href="expressions/attribute_terminal.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../expressions.html#header.boost.log.expressions.filter_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="filter/default_filter.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 157 </div>
 158 </body>
 159 </html>