<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Apache log4cxx: RelativeTimePatternConverter Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> </div> <div class="headertitle"> <h1>RelativeTimePatternConverter Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="log4cxx::pattern::RelativeTimePatternConverter" --><!-- doxytag: inherits="log4cxx::pattern::LoggingEventPatternConverter" --> <p>Format the relative time in milliseconds. <a href="#_details">More...</a></p> <p>Inherits <a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html">log4cxx::pattern::LoggingEventPatternConverter</a>.</p> <p><a href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html#acc66586eabd2544fbdb2912395706069">RelativeTimePatternConverter</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Private constructor. <a href="#acc66586eabd2544fbdb2912395706069"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html#ae365eeefff6366cf929d51d7ef87255b">format</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::spi::LoggingEventPtr</a> &event, <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &toAppendTo, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Formats an event into a string buffer. <a href="#ae365eeefff6366cf929d51d7ef87255b"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static PatternConverterPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html#a8ab21ae90307902122f92aca54fed1f4">newInstance</a> (const std::vector< <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> > &options)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Obtains an instance of <a class="el" href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html" title="Format the relative time in milliseconds.">RelativeTimePatternConverter</a>. <a href="#a8ab21ae90307902122f92aca54fed1f4"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Format the relative time in milliseconds. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="acc66586eabd2544fbdb2912395706069"></a><!-- doxytag: member="log4cxx::pattern::RelativeTimePatternConverter::RelativeTimePatternConverter" ref="acc66586eabd2544fbdb2912395706069" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html">RelativeTimePatternConverter</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Private constructor. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ae365eeefff6366cf929d51d7ef87255b"></a><!-- doxytag: member="log4cxx::pattern::RelativeTimePatternConverter::format" ref="ae365eeefff6366cf929d51d7ef87255b" args="(const log4cxx::spi::LoggingEventPtr &event, LogString &toAppendTo, log4cxx::helpers::Pool &p) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void format </td> <td>(</td> <td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::spi::LoggingEventPtr</a> & </td> <td class="paramname"><em>event</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td> <td class="paramname"><em>toAppendTo</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td> <td class="paramname"><em>p</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Formats an event into a string buffer. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">event</td><td>event to format, may not be null. </td></tr> <tr><td class="paramname">toAppendTo</td><td>string buffer to which the formatted event will be appended. May not be null. </td></tr> <tr><td class="paramname">p</td><td>pool for memory allocations needing during format. </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="classlog4cxx_1_1pattern_1_1_logging_event_pattern_converter.html#add24a40209b961a2e87645b000171bd5">LoggingEventPatternConverter</a>.</p> </div> </div> <a class="anchor" id="a8ab21ae90307902122f92aca54fed1f4"></a><!-- doxytag: member="log4cxx::pattern::RelativeTimePatternConverter::newInstance" ref="a8ab21ae90307902122f92aca54fed1f4" args="(const std::vector< LogString > &options)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static PatternConverterPtr newInstance </td> <td>(</td> <td class="paramtype">const std::vector< <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> > & </td> <td class="paramname"><em>options</em></td><td>)</td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Obtains an instance of <a class="el" href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html" title="Format the relative time in milliseconds.">RelativeTimePatternConverter</a>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">options</td><td>options, currently ignored, may be null. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>instance of <a class="el" href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html" title="Format the relative time in milliseconds.">RelativeTimePatternConverter</a>. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="relativetimepatternconverter_8h.html">relativetimepatternconverter.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li> <li class="navelem"><a class="el" href="namespacelog4cxx_1_1pattern.html">pattern</a> </li> <li class="navelem"><a class="el" href="classlog4cxx_1_1pattern_1_1_relative_time_pattern_converter.html">RelativeTimePatternConverter</a> </li> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> </BODY> </HTML>