log4cxx::spi::LocationInfo Class Reference

This class represents the location of a logging statement. More...

#include <locationinfo.h>

Public Member Functions
	LocationInfo (const char *const fileName, const char *const shortFileName, const char *const functionName, int lineNumber)
	Constructor.
	LocationInfo ()
	Default constructor.
	LocationInfo (const LocationInfo &src)
	Copy constructor.
LocationInfo &	operator= (const LocationInfo &src)
	Assignment operator.
void	clear ()
	Resets location info to default state.
const std::string	getClassName () const
	Return the class name of the call site.
const char *	getFileName () const
	Return the file name of the caller.
const char *	getShortFileName () const
	Return the short file name of the caller.
int	getLineNumber () const
	Returns the line number of the caller.
const std::string	getMethodName () const
	Returns the method name of the caller.

Static Public Member Functions
static const LocationInfo &	getLocationUnavailable ()
static const char *	calcShortFileName (const char *fileName)
	The part of fileName after the path.

Static Public Attributes
static const char *const	NA
	When location information is not available the constant NA is returned.
static const char *const	NA_METHOD

Detailed Description

This class represents the location of a logging statement.

Constructor & Destructor Documentation

LocationInfo() [1/3]

log4cxx::spi::LocationInfo::LocationInfo	(	const char *const	fileName,
		const char *const	shortFileName,
		const char *const	functionName,
		int	lineNumber
	)

Constructor.

Remarks

Used by LOG4CXX_LOCATION to generate location info for current code site

LocationInfo() [2/3]

log4cxx::spi::LocationInfo::LocationInfo

(

)

Default constructor.

LocationInfo() [3/3]

log4cxx::spi::LocationInfo::LocationInfo

(

const LocationInfo &

src

)

Copy constructor.

Parameters

src	source location

Member Function Documentation

calcShortFileName()

static const char * log4cxx::spi::LocationInfo::calcShortFileName ( const char *  fileName )

inlinestatic

The part of fileName after the path.

Implemented to allow compile-time evaluation when called with a literal string

clear()

void log4cxx::spi::LocationInfo::clear

(

)

Resets location info to default state.

getClassName()

const std::string log4cxx::spi::LocationInfo::getClassName

(

)

const

Return the class name of the call site.

getFileName()

const char * log4cxx::spi::LocationInfo::getFileName

(

)

const

Return the file name of the caller.

Returns

file name, may be null.

getLineNumber()

int log4cxx::spi::LocationInfo::getLineNumber

(

)

const

Returns the line number of the caller.

Returns

line number, -1 if not available.

getLocationUnavailable()

static const LocationInfo & log4cxx::spi::LocationInfo::getLocationUnavailable ( )

static

getMethodName()

const std::string log4cxx::spi::LocationInfo::getMethodName

(

)

const

Returns the method name of the caller.

getShortFileName()

const char * log4cxx::spi::LocationInfo::getShortFileName

(

)

const

Return the short file name of the caller.

Returns

file name. Note that this will fallback to the full filename when using calcShortFileName to calculate the filename at compile-time.

operator=()

LocationInfo & log4cxx::spi::LocationInfo::operator=

(

const LocationInfo &

src

)

Assignment operator.

Parameters

src	source location

Member Data Documentation

NA

const char* const log4cxx::spi::LocationInfo::NA

static

When location information is not available the constant NA is returned.

Current value of this string constant is ?.

NA_METHOD

const char* const log4cxx::spi::LocationInfo::NA_METHOD

static

---

The documentation for this class was generated from the following file:

• locationinfo.h