libs/log/doc/html/boost/log/value_extractor.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template value_extractor</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="../../attributes.html#header.boost.log.attributes.value_extraction_fwd_hpp" title="Header &lt;boost/log/attributes/value_extraction_fwd.hpp&gt;">
   9 <link rel="prev" href="result_of/extract_or_throw.html" title="Struct template extract_or_throw">
  10 <link rel="next" href="visitation_result.html" title="Class visitation_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="result_of/extract_or_throw.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../attributes.html#header.boost.log.attributes.value_extraction_fwd_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="visitation_result.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.value_extractor"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template value_extractor</span></h2>
  22 <p>boost::log::value_extractor &#8212; Generic attribute value extractor. </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="../../attributes.html#header.boost.log.attributes.value_extraction_fwd_hpp" title="Header &lt;boost/log/attributes/value_extraction_fwd.hpp&gt;">boost/log/attributes/value_extraction_fwd.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="value_extractor.html" title="Class template value_extractor">value_extractor</a> <span class="special">:</span> <span class="keyword">private</span> <span class="identifier">FallbackPolicyT</span> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// <a class="link" href="value_extractor.html#boost.log.value_extractorconstruct-copy-destruct">construct/copy/destruct</a></span>
  31   <a class="link" href="value_extractor.html#idm45711348242784-bb"><span class="identifier">value_extractor</span></a><span class="special">(</span><a class="link" href="value_extractor.html" title="Class template value_extractor">value_extractor</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  32   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">explicit</span> <a class="link" href="value_extractor.html#idm45711348240816-bb"><span class="identifier">value_extractor</span></a><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>
  33
  34   <span class="comment">// <a class="link" href="value_extractor.html#idm45711348265552-bb">public member functions</a></span>
  35   <span class="identifier">result_type</span> <a class="link" href="value_extractor.html#idm45711348264992-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><a class="link" href="attribute_value.html" title="Class attribute_value">attribute_value</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  36   <span class="identifier">result_type</span> <a class="link" href="value_extractor.html#idm45711348260992-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><a class="link" href="attribute_name.html" title="Class attribute_name">attribute_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="attribute_value_set.html" title="Class attribute_value_set">attribute_value_set</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  37   <span class="identifier">result_type</span> <a class="link" href="value_extractor.html#idm45711348255504-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><a class="link" href="attribute_name.html" title="Class attribute_name">attribute_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">record</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  38   <span class="identifier">result_type</span> <a class="link" href="value_extractor.html#idm45711348250288-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><a class="link" href="attribute_name.html" title="Class attribute_name">attribute_name</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  39   <span class="identifier">fallback_policy</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="value_extractor.html#idm45711348245072-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>
  40 <span class="special">}</span><span class="special">;</span></pre></div>
  41 <div class="refsect1">
  42 <a name="idm45554748936256"></a><h2>Description</h2>
  43 <p>Attribute value extractor is a functional object that attempts to find and extract the stored attribute value from the attribute values view or a log record. The extracted value is returned from the extractor. </p>
  44 <div class="refsect2">
  45 <a name="idm45554748935360"></a><h3>
  46 <a name="boost.log.value_extractorconstruct-copy-destruct"></a><code class="computeroutput">value_extractor</code>
  47         public
  48        construct/copy/destruct</h3>
  49 <div class="orderedlist"><ol class="orderedlist" type="1">
  50 <li class="listitem">
  51 <pre class="literallayout"><a name="idm45711348242784-bb"></a><span class="identifier">value_extractor</span><span class="special">(</span><a class="link" href="value_extractor.html" title="Class template value_extractor">value_extractor</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  52 <p>Default constructor</p>
  53 <p>Copy constructor </p>
  54 </li>
  55 <li class="listitem">
  56 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">explicit</span> <a name="idm45711348240816-bb"></a><span class="identifier">value_extractor</span><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>
  57 <p>Constructor</p>
  58 <p>
  59 </p>
  60 <div class="variablelist"><table border="0" class="variablelist compact">
  61 <colgroup>
  62 <col align="left" valign="top">
  63 <col>
  64 </colgroup>
  65 <tbody><tr>
  66 <td><p><span class="term">Parameters:</span></p></td>
  67 <td><div class="variablelist"><table border="0" class="variablelist compact">
  68 <colgroup>
  69 <col align="left" valign="top">
  70 <col>
  71 </colgroup>
  72 <tbody><tr>
  73 <td><p><span class="term"><code class="computeroutput">arg</code></span></p></td>
  74 <td><p>Fallback policy constructor argument </p></td>
  75 </tr></tbody>
  76 </table></div></td>
  77 </tr></tbody>
  78 </table></div>
  79 </li>
  80 </ol></div>
  81 </div>
  82 <div class="refsect2">
  83 <a name="idm45554748914256"></a><h3>
  84 <a name="idm45711348265552-bb"></a><code class="computeroutput">value_extractor</code> public member functions</h3>
  85 <div class="orderedlist"><ol class="orderedlist" type="1">
  86 <li class="listitem">
  87 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45711348264992-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><a class="link" href="attribute_value.html" title="Class attribute_value">attribute_value</a> <span class="keyword">const</span> <span class="special">&amp;</span> attr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  88 <p>Extraction operator. Attempts to acquire the stored value of one of the supported types. If extraction succeeds, the extracted value is returned.</p>
  89 <p>
  90
  91 </p>
  92 <div class="variablelist"><table border="0" class="variablelist compact">
  93 <colgroup>
  94 <col align="left" valign="top">
  95 <col>
  96 </colgroup>
  97 <tbody>
  98 <tr>
  99 <td><p><span class="term">Parameters:</span></p></td>
 100 <td><div class="variablelist"><table border="0" class="variablelist compact">
 101 <colgroup>
 102 <col align="left" valign="top">
 103 <col>
 104 </colgroup>
 105 <tbody><tr>
 106 <td><p><span class="term"><code class="computeroutput">attr</code></span></p></td>
 107 <td><p>The attribute value to extract from. </p></td>
 108 </tr></tbody>
 109 </table></div></td>
 110 </tr>
 111 <tr>
 112 <td><p><span class="term">Returns:</span></p></td>
 113 <td><p>The extracted value, if extraction succeeded, an empty value otherwise. </p></td>
 114 </tr>
 115 </tbody>
 116 </table></div>
 117 </li>
 118 <li class="listitem">
 119 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45711348260992-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><a class="link" href="attribute_name.html" title="Class attribute_name">attribute_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> name<span class="special">,</span>
 120                        <a class="link" href="attribute_value_set.html" title="Class attribute_value_set">attribute_value_set</a> <span class="keyword">const</span> <span class="special">&amp;</span> attrs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 121 <p>Extraction operator. Looks for an attribute value with the specified name and tries to acquire the stored value of one of the supported types. If extraction succeeds, the extracted value is returned.</p>
 122 <p>
 123
 124 </p>
 125 <div class="variablelist"><table border="0" class="variablelist compact">
 126 <colgroup>
 127 <col align="left" valign="top">
 128 <col>
 129 </colgroup>
 130 <tbody>
 131 <tr>
 132 <td><p><span class="term">Parameters:</span></p></td>
 133 <td><div class="variablelist"><table border="0" class="variablelist compact">
 134 <colgroup>
 135 <col align="left" valign="top">
 136 <col>
 137 </colgroup>
 138 <tbody>
 139 <tr>
 140 <td><p><span class="term"><code class="computeroutput">attrs</code></span></p></td>
 141 <td><p>A set of attribute values in which to look for the specified attribute value. </p></td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term"><code class="computeroutput">name</code></span></p></td>
 145 <td><p>Attribute value name. </p></td>
 146 </tr>
 147 </tbody>
 148 </table></div></td>
 149 </tr>
 150 <tr>
 151 <td><p><span class="term">Returns:</span></p></td>
 152 <td><p>The extracted value, if extraction succeeded, an empty value otherwise. </p></td>
 153 </tr>
 154 </tbody>
 155 </table></div>
 156 </li>
 157 <li class="listitem">
 158 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45711348255504-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><a class="link" href="attribute_name.html" title="Class attribute_name">attribute_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> name<span class="special">,</span> <span class="identifier">record</span> <span class="keyword">const</span> <span class="special">&amp;</span> rec<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 159 <p>Extraction operator. Looks for an attribute value with the specified name and tries to acquire the stored value of one of the supported types. If extraction succeeds, the extracted value is returned.</p>
 160 <p>
 161
 162 </p>
 163 <div class="variablelist"><table border="0" class="variablelist compact">
 164 <colgroup>
 165 <col align="left" valign="top">
 166 <col>
 167 </colgroup>
 168 <tbody>
 169 <tr>
 170 <td><p><span class="term">Parameters:</span></p></td>
 171 <td><div class="variablelist"><table border="0" class="variablelist compact">
 172 <colgroup>
 173 <col align="left" valign="top">
 174 <col>
 175 </colgroup>
 176 <tbody>
 177 <tr>
 178 <td><p><span class="term"><code class="computeroutput">name</code></span></p></td>
 179 <td><p>Attribute value name. </p></td>
 180 </tr>
 181 <tr>
 182 <td><p><span class="term"><code class="computeroutput">rec</code></span></p></td>
 183 <td><p>A log record. The attribute value will be sought among those associated with the record. </p></td>
 184 </tr>
 185 </tbody>
 186 </table></div></td>
 187 </tr>
 188 <tr>
 189 <td><p><span class="term">Returns:</span></p></td>
 190 <td><p>The extracted value, if extraction succeeded, an empty value otherwise. </p></td>
 191 </tr>
 192 </tbody>
 193 </table></div>
 194 </li>
 195 <li class="listitem">
 196 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45711348250288-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><a class="link" href="attribute_name.html" title="Class attribute_name">attribute_name</a> <span class="keyword">const</span> <span class="special">&amp;</span> name<span class="special">,</span> <span class="identifier">record_view</span> <span class="keyword">const</span> <span class="special">&amp;</span> rec<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 197 <p>Extraction operator. Looks for an attribute value with the specified name and tries to acquire the stored value of one of the supported types. If extraction succeeds, the extracted value is returned.</p>
 198 <p>
 199
 200 </p>
 201 <div class="variablelist"><table border="0" class="variablelist compact">
 202 <colgroup>
 203 <col align="left" valign="top">
 204 <col>
 205 </colgroup>
 206 <tbody>
 207 <tr>
 208 <td><p><span class="term">Parameters:</span></p></td>
 209 <td><div class="variablelist"><table border="0" class="variablelist compact">
 210 <colgroup>
 211 <col align="left" valign="top">
 212 <col>
 213 </colgroup>
 214 <tbody>
 215 <tr>
 216 <td><p><span class="term"><code class="computeroutput">name</code></span></p></td>
 217 <td><p>Attribute value name. </p></td>
 218 </tr>
 219 <tr>
 220 <td><p><span class="term"><code class="computeroutput">rec</code></span></p></td>
 221 <td><p>A log record view. The attribute value will be sought among those associated with the record. </p></td>
 222 </tr>
 223 </tbody>
 224 </table></div></td>
 225 </tr>
 226 <tr>
 227 <td><p><span class="term">Returns:</span></p></td>
 228 <td><p>The extracted value, if extraction succeeded, an empty value otherwise. </p></td>
 229 </tr>
 230 </tbody>
 231 </table></div>
 232 </li>
 233 <li class="listitem">
 234 <pre class="literallayout"><span class="identifier">fallback_policy</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm45711348245072-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>
 235 <p>
 236 </p>
 237 <div class="variablelist"><table border="0" class="variablelist compact">
 238 <colgroup>
 239 <col align="left" valign="top">
 240 <col>
 241 </colgroup>
 242 <tbody><tr>
 243 <td><p><span class="term">Returns:</span></p></td>
 244 <td><p>Fallback policy </p></td>
 245 </tr></tbody>
 246 </table></div>
 247 </li>
 248 </ol></div>
 249 </div>
 250 </div>
 251 </div>
 252 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 253 <td align="left"></td>
 254 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 255         Distributed under the Boost Software License, Version 1.0. (See accompanying
 256         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>).
 257       </p>
 258 </div></td>
 259 </tr></table>
 260 <hr>
 261 <div class="spirit-nav">
 262 <a accesskey="p" href="result_of/extract_or_throw.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../attributes.html#header.boost.log.attributes.value_extraction_fwd_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="visitation_result.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 263 </div>
 264 </body>
 265 </html>