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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template channel_severity_filter_terminal</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.predicates.channel_severity_filter_hpp" title="Header &lt;boost/log/expressions/predicates/channel_severity_filter.hpp&gt;">
   9 <link rel="prev" href="begins_with_idp36544752.html" title="Function template begins_with">
  10 <link rel="next" href="channel_severi_idp36553120/channel_visitor.html" title="Struct template channel_visitor">
  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="begins_with_idp36544752.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.predicates.channel_severity_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="channel_severi_idp36553120/channel_visitor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.channel_severi_idp36553120"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template channel_severity_filter_terminal</span></h2>
  22 <p>boost::log::expressions::channel_severity_filter_terminal</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.predicates.channel_severity_filter_hpp" title="Header &lt;boost/log/expressions/predicates/channel_severity_filter.hpp&gt;">boost/log/expressions/predicates/channel_severity_filter.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ChannelT<span class="special">,</span> <span class="keyword">typename</span> SeverityT<span class="special">,</span>
  28          <span class="keyword">typename</span> ChannelFallbackT <span class="special">=</span> <span class="identifier">fallback_to_none</span><span class="special">,</span>
  29          <span class="keyword">typename</span> SeverityFallbackT <span class="special">=</span> <span class="identifier">fallback_to_none</span><span class="special">,</span>
  30          <span class="keyword">typename</span> ChannelOrderT <span class="special">=</span> <span class="identifier">less</span><span class="special">,</span>
  31          <span class="keyword">typename</span> SeverityCompareT <span class="special">=</span> <span class="identifier">greater_equal</span><span class="special">,</span>
  32          <span class="keyword">typename</span> AllocatorT <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">allocator</span><span class="special">&lt;</span> <span class="keyword">void</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
  33 <span class="keyword">class</span> <a class="link" href="channel_severi_idp36553120.html" title="Class template channel_severity_filter_terminal">channel_severity_filter_terminal</a> <span class="special">{</span>
  34 <span class="keyword">public</span><span class="special">:</span>
  35   <span class="comment">// types</span>
  36   <span class="keyword">typedef</span> <span class="keyword">void</span>              <a name="boost.log.expressions.channel_severi_idp36553120._is_boost_log_terminal"></a><span class="identifier">_is_boost_log_terminal</span><span class="special">;</span>    <span class="comment">// Internal typedef for type categorization. </span>
  37   <span class="keyword">typedef</span> <span class="keyword">bool</span>              <a name="boost.log.expressions.channel_severi_idp36553120.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>               <span class="comment">// Function result type. </span>
  38   <span class="keyword">typedef</span> <span class="identifier">ChannelT</span>          <a name="boost.log.expressions.channel_severi_idp36553120.channel_value_type"></a><span class="identifier">channel_value_type</span><span class="special">;</span>        <span class="comment">// Channel attribute value type. </span>
  39   <span class="keyword">typedef</span> <span class="identifier">ChannelFallbackT</span>  <a name="boost.log.expressions.channel_severi_idp36553120.channel_fallback_policy"></a><span class="identifier">channel_fallback_policy</span><span class="special">;</span>   <span class="comment">// Channel fallback policy. </span>
  40   <span class="keyword">typedef</span> <span class="identifier">SeverityT</span>         <a name="boost.log.expressions.channel_severi_idp36553120.severity_value_type"></a><span class="identifier">severity_value_type</span><span class="special">;</span>       <span class="comment">// Severity level attribute value type. </span>
  41   <span class="keyword">typedef</span> <span class="identifier">SeverityFallbackT</span> <a name="boost.log.expressions.channel_severi_idp36553120.severity_fallback_policy"></a><span class="identifier">severity_fallback_policy</span><span class="special">;</span>  <span class="comment">// Severity level fallback policy. </span>
  42
  43   <span class="comment">// member classes/structs/unions</span>
  44
  45   <span class="comment">// Channel visitor.</span>
  46   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgT<span class="special">&gt;</span>
  47   <span class="keyword">struct</span> <a class="link" href="channel_severi_idp36553120/channel_visitor.html" title="Struct template channel_visitor">channel_visitor</a> <span class="special">{</span>
  48     <span class="comment">// types</span>
  49     <span class="keyword">typedef</span> <span class="keyword">void</span> <a class="link" href="channel_severi_idp36553120/channel_visitor.html#boost.log.expressions.channel_severi_idp36553120.channel_visitor.result_type"><span class="identifier">result_type</span></a><span class="special">;</span>
  50
  51     <span class="comment">// <a class="link" href="channel_severi_idp36553120/channel_visitor.html#boost.log.expressions.channel_severi_idp36553120.channel_visitorconstruct-copy-destruct">construct/copy/destruct</a></span>
  52     <a class="link" href="channel_severi_idp36553120/channel_visitor.html#idp36564112-bb"><span class="identifier">channel_visitor</span></a><span class="special">(</span><span class="identifier">channel_severity_filter_terminal</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">ArgT</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  53
  54     <span class="comment">// <a class="link" href="channel_severi_idp36553120/channel_visitor.html#idp36561568-bb">public member functions</a></span>
  55     <span class="identifier">result_type</span> <a class="link" href="channel_severi_idp36553120/channel_visitor.html#idp36562128-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">channel_value_type</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="special">}</span><span class="special">;</span>
  57
  58   <span class="comment">// Severity level visitor.</span>
  59
  60   <span class="keyword">struct</span> <a class="link" href="channel_severi_idp36553120/severity_visitor.html" title="Struct severity_visitor">severity_visitor</a> <span class="special">{</span>
  61     <span class="comment">// types</span>
  62     <span class="keyword">typedef</span> <span class="keyword">void</span> <a class="link" href="channel_severi_idp36553120/severity_visitor.html#boost.log.expressions.channel_severi_idp36553120.severity_visitor.result_type"><span class="identifier">result_type</span></a><span class="special">;</span>
  63
  64     <span class="comment">// <a class="link" href="channel_severi_idp36553120/severity_visitor.html#boost.log.expressions.channel_severi_idp36553120.severity_visitorconstruct-copy-destruct">construct/copy/destruct</a></span>
  65     <a class="link" href="channel_severi_idp36553120/severity_visitor.html#idp36570592-bb"><span class="identifier">severity_visitor</span></a><span class="special">(</span><span class="identifier">channel_severity_filter_terminal</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
  66                      <span class="identifier">severity_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  67
  68     <span class="comment">// <a class="link" href="channel_severi_idp36553120/severity_visitor.html#idp36568048-bb">public member functions</a></span>
  69     <span class="identifier">result_type</span> <a class="link" href="channel_severi_idp36553120/severity_visitor.html#idp36568608-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">severity_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  70   <span class="special">}</span><span class="special">;</span>
  71
  72   <span class="comment">// <a class="link" href="channel_severi_idp36553120.html#boost.log.expressions.channel_severi_idp36553120construct-copy-destruct">construct/copy/destruct</a></span>
  73   <a class="link" href="channel_severi_idp36553120.html#idp36588000-bb"><span class="identifier">channel_severity_filter_terminal</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>
  74                                    <span class="identifier">attribute_name</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
  75                                    <span class="identifier">channel_fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">channel_fallback_policy</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
  76                                    <span class="identifier">severity_fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">severity_fallback_policy</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
  77                                    <span class="identifier">ChannelOrderT</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">ChannelOrderT</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
  78                                    <span class="identifier">SeverityCompareT</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">SeverityCompareT</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  79
  80   <span class="comment">// <a class="link" href="channel_severi_idp36553120.html#idp36579920-bb">public member functions</a></span>
  81   <span class="keyword">void</span> <a class="link" href="channel_severi_idp36553120.html#idp36580480-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="identifier">channel_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">severity_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  82   <span class="keyword">void</span> <a class="link" href="channel_severi_idp36553120.html#idp36583040-bb"><span class="identifier">set_default</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">)</span><span class="special">;</span>
  83   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="channel_severi_idp36553120.html#idp36584896-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  84
  85   <span class="comment">// <a class="link" href="channel_severi_idp36553120.html#idp36593952-bb">private member functions</a></span>
  86   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgT<span class="special">&gt;</span>
  87     <span class="keyword">void</span> <a class="link" href="channel_severi_idp36553120.html#idp36594528-bb"><span class="identifier">visit_channel</span></a><span class="special">(</span><span class="identifier">channel_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">ArgT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  88   <span class="keyword">void</span> <a class="link" href="channel_severi_idp36553120.html#idp36598864-bb"><span class="identifier">visit_severity</span></a><span class="special">(</span><span class="identifier">severity_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
  89                       <span class="identifier">severity_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  90 <span class="special">}</span><span class="special">;</span></pre></div>
  91 <div class="refsect1">
  92 <a name="idp99815184"></a><h2>Description</h2>
  93 <div class="refsect2">
  94 <a name="idp99815600"></a><h3>
  95 <a name="boost.log.expressions.channel_severi_idp36553120construct-copy-destruct"></a><code class="computeroutput">channel_severity_filter_terminal</code>
  96         public
  97        construct/copy/destruct</h3>
  98 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  99 <pre class="literallayout"><a name="idp36588000-bb"></a><span class="identifier">channel_severity_filter_terminal</span><span class="special">(</span><span class="identifier">attribute_name</span> <span class="keyword">const</span> <span class="special">&amp;</span> channel_name<span class="special">,</span>
 100                                  <span class="identifier">attribute_name</span> <span class="keyword">const</span> <span class="special">&amp;</span> severity_name<span class="special">,</span>
 101                                  <span class="identifier">channel_fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> channel_fallback <span class="special">=</span> <span class="identifier">channel_fallback_policy</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
 102                                  <span class="identifier">severity_fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> severity_fallback <span class="special">=</span> <span class="identifier">severity_fallback_policy</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
 103                                  <span class="identifier">ChannelOrderT</span> <span class="keyword">const</span> <span class="special">&amp;</span> channel_order <span class="special">=</span> <span class="identifier">ChannelOrderT</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
 104                                  <span class="identifier">SeverityCompareT</span> <span class="keyword">const</span> <span class="special">&amp;</span> severity_compare <span class="special">=</span> <span class="identifier">SeverityCompareT</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Initializing constructor. </li></ol></div>
 105 </div>
 106 <div class="refsect2">
 107 <a name="idp99846704"></a><h3>
 108 <a name="idp36579920-bb"></a><code class="computeroutput">channel_severity_filter_terminal</code> public member functions</h3>
 109 <div class="orderedlist"><ol class="orderedlist" type="1">
 110 <li class="listitem">
 111 <pre class="literallayout"><span class="keyword">void</span> <a name="idp36580480-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="identifier">channel_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> channel<span class="special">,</span>
 112          <span class="identifier">severity_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> severity<span class="special">)</span><span class="special">;</span></pre>Adds a new element to the mapping. </li>
 113 <li class="listitem">
 114 <pre class="literallayout"><span class="keyword">void</span> <a name="idp36583040-bb"></a><span class="identifier">set_default</span><span class="special">(</span><span class="keyword">bool</span> def<span class="special">)</span><span class="special">;</span></pre>Sets the default result of the predicate. </li>
 115 <li class="listitem">
 116 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="idp36584896-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span> ctx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Invokation operator. </li>
 117 </ol></div>
 118 </div>
 119 <div class="refsect2">
 120 <a name="idp99874080"></a><h3>
 121 <a name="idp36593952-bb"></a><code class="computeroutput">channel_severity_filter_terminal</code> private member functions</h3>
 122 <div class="orderedlist"><ol class="orderedlist" type="1">
 123 <li class="listitem">
 124 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ArgT<span class="special">&gt;</span>
 125   <span class="keyword">void</span> <a name="idp36594528-bb"></a><span class="identifier">visit_channel</span><span class="special">(</span><span class="identifier">channel_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> channel<span class="special">,</span> <span class="identifier">ArgT</span> <span class="keyword">const</span> <span class="special">&amp;</span> arg<span class="special">,</span>
 126                      <span class="keyword">bool</span> <span class="special">&amp;</span> res<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Visits channel name. </li>
 127 <li class="listitem">
 128 <pre class="literallayout"><span class="keyword">void</span> <a name="idp36598864-bb"></a><span class="identifier">visit_severity</span><span class="special">(</span><span class="identifier">severity_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> left<span class="special">,</span>
 129                     <span class="identifier">severity_value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> right<span class="special">,</span> <span class="keyword">bool</span> <span class="special">&amp;</span> res<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Visits severity level. </li>
 130 </ol></div>
 131 </div>
 132 </div>
 133 </div>
 134 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 135 <td align="left"></td>
 136 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2014 Andrey Semashev<p>
 137         Distributed under the Boost Software License, Version 1.0. (See accompanying
 138         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>).
 139       </p>
 140 </div></td>
 141 </tr></table>
 142 <hr>
 143 <div class="spirit-nav">
 144 <a accesskey="p" href="begins_with_idp36544752.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.predicates.channel_severity_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="channel_severi_idp36553120/channel_visitor.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 145 </div>
 146 </body>
 147 </html>