<!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: LocationInfo 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_1spi_1_1_location_info.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> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<h1>LocationInfo Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::spi::LocationInfo" -->
<p>This class represents the location of a logging statement.
<a href="#_details">More...</a></p>
<p><a href="classlog4cxx_1_1spi_1_1_location_info-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_1spi_1_1_location_info.html#a8bc4d9e60ee9a3440b769a30280731db">LocationInfo</a> (const char *const fileName, const char *const functionName, int lineNumber)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a8bc4d9e60ee9a3440b769a30280731db"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#ad0658f719e32dcf0b98b329799b5bb9d">LocationInfo</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ad0658f719e32dcf0b98b329799b5bb9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#a4c66f29df8b294b0d8cc432ca9238130">LocationInfo</a> (const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a> &src)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a4c66f29df8b294b0d8cc432ca9238130"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#af1cd8347aa2cea39e2555df26a2da438">operator=</a> (const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a> &src)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#af1cd8347aa2cea39e2555df26a2da438"></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_1spi_1_1_location_info.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets location info to default state. <a href="#ac8bb3912a3ce86b15842e79d0b421204"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#ab3d0dbc103a6e0a790b4950cca23cdd7">getClassName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the class name of the call site. <a href="#ab3d0dbc103a6e0a790b4950cca23cdd7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#a09ee81e40060d94bf70d03532fb7adb3">getFileName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the file name of the caller. <a href="#a09ee81e40060d94bf70d03532fb7adb3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#ae48a165945bebe01fd777069441e614e">getLineNumber</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the line number of the caller. <a href="#ae48a165945bebe01fd777069441e614e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#a73895866ce26c7a41b995a17c94aa54c">getMethodName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the method name of the caller. <a href="#a73895866ce26c7a41b995a17c94aa54c"></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_1spi_1_1_location_info.html#a55c2de2e6f1f6297ab7e8244404bc1d5">write</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_object_output_stream.html">log4cxx::helpers::ObjectOutputStream</a> &os, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const </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 const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#a9f7f7bf077e6098f76feb162945d0e11">getLocationUnavailable</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#a9f0cc24df533ad326fa4821f469821d7">NA</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">When location information is not available the constant <code>NA</code> is returned. <a href="#a9f0cc24df533ad326fa4821f469821d7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#a84df6e0ea4e31ddae6164c3e72ebc2a1">NA_METHOD</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class represents the location of a logging statement. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8bc4d9e60ee9a3440b769a30280731db"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::LocationInfo" ref="a8bc4d9e60ee9a3440b769a30280731db" args="(const char *const fileName, const char *const functionName, int lineNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a> </td>
<td>(</td>
<td class="paramtype">const char *const </td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *const </td>
<td class="paramname"><em>functionName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>lineNumber</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Used by LOG4CXX_LOCATION to generate location info for current code site </dd></dl>
</div>
</div>
<a class="anchor" id="ad0658f719e32dcf0b98b329799b5bb9d"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::LocationInfo" ref="ad0658f719e32dcf0b98b329799b5bb9d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<a class="anchor" id="a4c66f29df8b294b0d8cc432ca9238130"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::LocationInfo" ref="a4c66f29df8b294b0d8cc432ca9238130" args="(const LocationInfo &src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a> & </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>source location </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac8bb3912a3ce86b15842e79d0b421204"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::clear" ref="ac8bb3912a3ce86b15842e79d0b421204" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets location info to default state. </p>
</div>
</div>
<a class="anchor" id="ab3d0dbc103a6e0a790b4950cca23cdd7"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::getClassName" ref="ab3d0dbc103a6e0a790b4950cca23cdd7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string getClassName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the class name of the call site. </p>
</div>
</div>
<a class="anchor" id="a09ee81e40060d94bf70d03532fb7adb3"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::getFileName" ref="a09ee81e40060d94bf70d03532fb7adb3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* getFileName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the file name of the caller. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>file name, may be null. </dd></dl>
</div>
</div>
<a class="anchor" id="ae48a165945bebe01fd777069441e614e"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::getLineNumber" ref="ae48a165945bebe01fd777069441e614e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int getLineNumber </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the line number of the caller. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>line number, -1 if not available. </dd></dl>
</div>
</div>
<a class="anchor" id="a9f7f7bf077e6098f76feb162945d0e11"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::getLocationUnavailable" ref="a9f7f7bf077e6098f76feb162945d0e11" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a>& getLocationUnavailable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a73895866ce26c7a41b995a17c94aa54c"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::getMethodName" ref="a73895866ce26c7a41b995a17c94aa54c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string getMethodName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the method name of the caller. </p>
</div>
</div>
<a class="anchor" id="af1cd8347aa2cea39e2555df26a2da438"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::operator=" ref="af1cd8347aa2cea39e2555df26a2da438" args="(const LocationInfo &src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</a> & </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>source location </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a55c2de2e6f1f6297ab7e8244404bc1d5"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::write" ref="a55c2de2e6f1f6297ab7e8244404bc1d5" args="(log4cxx::helpers::ObjectOutputStream &os, log4cxx::helpers::Pool &p) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_output_stream.html">log4cxx::helpers::ObjectOutputStream</a> & </td>
<td class="paramname"><em>os</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</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9f0cc24df533ad326fa4821f469821d7"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::NA" ref="a9f0cc24df533ad326fa4821f469821d7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#a9f0cc24df533ad326fa4821f469821d7">NA</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>When location information is not available the constant <code>NA</code> is returned. </p>
<p>Current value of this string constant is <b>?</b>. </p>
</div>
</div>
<a class="anchor" id="a84df6e0ea4e31ddae6164c3e72ebc2a1"></a><!-- doxytag: member="log4cxx::spi::LocationInfo::NA_METHOD" ref="a84df6e0ea4e31ddae6164c3e72ebc2a1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const <a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html#a84df6e0ea4e31ddae6164c3e72ebc2a1">NA_METHOD</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="locationinfo_8h.html">locationinfo.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_1spi.html">spi</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1spi_1_1_location_info.html">LocationInfo</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>
