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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template attribute_terminal</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.attr_hpp" title="Header &lt;boost/log/expressions/attr.hpp&gt;">
   9 <link rel="prev" href="../../../expressions.html" title="Expressions">
  10 <link rel="next" href="attribute_terminal/result.html" title="Struct template result">
  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.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.attr_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="attribute_terminal/result.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.attribute_terminal"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template attribute_terminal</span></h2>
  22 <p>boost::log::expressions::attribute_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.attr_hpp" title="Header &lt;boost/log/expressions/attr.hpp&gt;">boost/log/expressions/attr.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> FallbackPolicyT<span class="special">,</span> <span class="keyword">typename</span> TagT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="attribute_terminal.html" title="Class template attribute_terminal">attribute_terminal</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="identifier">TagT</span>                                  <a name="boost.log.expressions.attribute_terminal.tag_type"></a><span class="identifier">tag_type</span><span class="special">;</span>         <span class="comment">// Attribute tag type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">value_extractor_type</span><span class="special">::</span><span class="identifier">value_type</span>      <a name="boost.log.expressions.attribute_terminal.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>       <span class="comment">// Attribute value type. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">value_extractor_type</span><span class="special">::</span><span class="identifier">fallback_policy</span> <a name="boost.log.expressions.attribute_terminal.fallback_policy"></a><span class="identifier">fallback_policy</span><span class="special">;</span>  <span class="comment">// Fallback policy type. </span>
  34
  35   <span class="comment">// member classes/structs/unions</span>
  36
  37   <span class="comment">// Function result type.</span>
  38   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="special">&gt;</span>
  39   <span class="keyword">struct</span> <a class="link" href="attribute_terminal/result.html" title="Struct template result">result</a> <span class="special">{</span>
  40   <span class="special">}</span><span class="special">;</span>
  41   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ThisT<span class="special">,</span> <span class="keyword">typename</span> ContextT<span class="special">&gt;</span>
  42   <span class="keyword">struct</span> <a class="link" href="attribute_terminal/result_ThisT_C_idp61071152.html" title="Struct template result&lt;ThisT(ContextT)&gt;">result</a><span class="special">&lt;</span><span class="identifier">ThisT</span><span class="special">(</span><span class="identifier">ContextT</span><span class="special">)</span><span class="special">&gt;</span> <span class="special">{</span>
  43     <span class="comment">// types</span>
  44     <span class="keyword">typedef</span> <span class="identifier">remove_cv</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">remove_reference</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">phoenix</span><span class="special">::</span><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">env</span><span class="special">&lt;</span> <span class="identifier">ContextT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>                          <a class="link" href="attribute_terminal/result_ThisT_C_idp61071152.html#boost.log.expressions.attribute_terminal.result_ThisT(C_idp61071152.env_type"><span class="identifier">env_type</span></a><span class="special">;</span>
  45     <span class="keyword">typedef</span> <span class="identifier">env_type</span><span class="special">::</span><span class="identifier">args_type</span>                                                                                                               <a class="link" href="attribute_terminal/result_ThisT_C_idp61071152.html#boost.log.expressions.attribute_terminal.result_ThisT(C_idp61071152.args_type"><span class="identifier">args_type</span></a><span class="special">;</span>
  46     <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                                                                                       <a class="link" href="attribute_terminal/result_ThisT_C_idp61071152.html#boost.log.expressions.attribute_terminal.result_ThisT(C_idp61071152.cv_value_extractor_type"><span class="identifier">cv_value_extractor_type</span></a><span class="special">;</span>
  47     <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">result_of</span><span class="special">&lt;</span> <span class="identifier">cv_value_extractor_type</span><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="keyword">typename</span> <span class="identifier">fusion</span><span class="special">::</span><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">at_c</span><span class="special">&lt;</span> <span class="identifier">args_type</span><span class="special">,</span> <span class="number">0</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span><span class="special">)</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="attribute_terminal/result_ThisT_C_idp61071152.html#boost.log.expressions.attribute_terminal.result_ThisT(C_idp61071152.type"><span class="identifier">type</span></a><span class="special">;</span>
  48   <span class="special">}</span><span class="special">;</span>
  49
  50   <span class="comment">// <a class="link" href="attribute_terminal.html#boost.log.expressions.attribute_terminalconstruct-copy-destruct">construct/copy/destruct</a></span>
  51   <span class="keyword">explicit</span> <a class="link" href="attribute_terminal.html#idp60014384-bb"><span class="identifier">attribute_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><span class="special">;</span>
  52   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <a class="link" href="attribute_terminal.html#idp60016064-bb"><span class="identifier">attribute_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> <span class="identifier">U</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  53   <a class="link" href="attribute_terminal.html#idp60019008-bb"><span class="identifier">attribute_terminal</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  54
  55   <span class="comment">// <a class="link" href="attribute_terminal.html#idp60843200-bb">public member functions</a></span>
  56   <span class="identifier">attribute_name</span> <a class="link" href="attribute_terminal.html#idp60843760-bb"><span class="identifier">get_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  57   <span class="identifier">fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="attribute_terminal.html#idp60845712-bb"><span class="identifier">get_fallback_policy</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  58   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span>
  59     <a class="link" href="attribute_terminal/result.html" title="Struct template result">result</a><span class="special">&lt;</span> this_type<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="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="attribute_terminal.html#idp60847664-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="special">;</span>
  60   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span>
  61     <a class="link" href="attribute_terminal/result.html" title="Struct template result">result</a><span class="special">&lt;</span> <span class="keyword">const</span> this_type<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="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
  62     <a class="link" href="attribute_terminal.html#idp60010384-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>
  63 <span class="special">}</span><span class="special">;</span></pre></div>
  64 <div class="refsect1">
  65 <a name="idp111006464"></a><h2>Description</h2>
  66 <p>An attribute value extraction terminal </p>
  67 <div class="refsect2">
  68 <a name="idp111007184"></a><h3>
  69 <a name="boost.log.expressions.attribute_terminalconstruct-copy-destruct"></a><code class="computeroutput">attribute_terminal</code>
  70         public
  71        construct/copy/destruct</h3>
  72 <div class="orderedlist"><ol class="orderedlist" type="1">
  73 <li class="listitem">
  74 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp60014384-bb"></a><span class="identifier">attribute_terminal</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>
  75 <p>Initializing constructor </p>
  76 </li>
  77 <li class="listitem">
  78 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span>
  79   <a name="idp60016064-bb"></a><span class="identifier">attribute_terminal</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">U</span> <span class="keyword">const</span> <span class="special">&amp;</span> arg<span class="special">)</span><span class="special">;</span></pre>
  80 <p>Initializing constructor </p>
  81 </li>
  82 <li class="listitem"><pre class="literallayout"><a name="idp60019008-bb"></a><span class="identifier">attribute_terminal</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  83 </ol></div>
  84 </div>
  85 <div class="refsect2">
  86 <a name="idp111032544"></a><h3>
  87 <a name="idp60843200-bb"></a><code class="computeroutput">attribute_terminal</code> public member functions</h3>
  88 <div class="orderedlist"><ol class="orderedlist" type="1">
  89 <li class="listitem">
  90 <pre class="literallayout"><span class="identifier">attribute_name</span> <a name="idp60843760-bb"></a><span class="identifier">get_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  91 <p>
  92 </p>
  93 <div class="variablelist"><table border="0" class="variablelist compact">
  94 <colgroup>
  95 <col align="left" valign="top">
  96 <col>
  97 </colgroup>
  98 <tbody><tr>
  99 <td><p><span class="term">Returns:</span></p></td>
 100 <td><p>Attribute value name </p></td>
 101 </tr></tbody>
 102 </table></div>
 103 </li>
 104 <li class="listitem">
 105 <pre class="literallayout"><span class="identifier">fallback_policy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp60845712-bb"></a><span class="identifier">get_fallback_policy</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 106 <p>
 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><tr>
 114 <td><p><span class="term">Returns:</span></p></td>
 115 <td><p>Fallback policy </p></td>
 116 </tr></tbody>
 117 </table></div>
 118 </li>
 119 <li class="listitem">
 120 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span>
 121   <a class="link" href="attribute_terminal/result.html" title="Struct template result">result</a><span class="special">&lt;</span> this_type<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="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="idp60847664-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="special">;</span></pre>
 122 <p>The operator extracts attribute value </p>
 123 </li>
 124 <li class="listitem">
 125 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span>
 126   <a class="link" href="attribute_terminal/result.html" title="Struct template result">result</a><span class="special">&lt;</span> <span class="keyword">const</span> this_type<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="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
 127   <a name="idp60010384-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>
 128 <p>The operator extracts attribute value </p>
 129 </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-2016 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="../../../expressions.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.attr_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="attribute_terminal/result.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 145 </div>
 146 </body>
 147 </html>