TraceSource Class Reference

TraceSource is a common base for all classes which write messages to a TraceTarget. More...

#include <TraceSource.h>

Inheritance diagram for TraceSource:

List of all members.

Public Member Functions
virtual	~TraceSource ()
virtual void	initTraceSource (SharedTraceTarget pTraceTarget, std::string name)
	For use when initialization has to be deferred until after construction.
void	trace (TraceLevel level, std::string message) const
	Records a trace message.
bool	isTracing () const
	Returns: true iff tracing is enabled for this source
bool	isTracingLevel (TraceLevel level) const
	Determines whether a particular level is being traced.
TraceTarget &	getTraceTarget () const
	Returns: the TraceTarget for this source
SharedTraceTarget	getSharedTraceTarget () const
	Returns: the SharedTraceTarget for this source
std::string	getTraceSourceName () const
	Gets the name of this source.
void	setTraceSourceName (std::string const &n)
	Sets the name of this source.
TraceLevel	getMinimumTraceLevel () const
void	disableTracing ()
Protected Member Functions
	TraceSource ()
	Constructs a new uninitialized TraceSource.
	TraceSource (SharedTraceTarget pTraceTarget, std::string name)
	Constructs a new TraceSource.
Private Attributes
SharedTraceTarget	pTraceTarget
std::string	name
TraceLevel	minimumLevel

---

Detailed Description

TraceSource is a common base for all classes which write messages to a TraceTarget.

Definition at line 36 of file TraceSource.h.

---

Constructor & Destructor Documentation

TraceSource::TraceSource

(

)

[explicit, protected]

Constructs a new uninitialized TraceSource.

Definition at line 30 of file TraceSource.cpp.

References minimumLevel, and TRACE_OFF.

{
    minimumLevel = TRACE_OFF;
}

TraceSource::TraceSource	(	SharedTraceTarget	pTraceTarget,
		std::string	name
	)			[explicit, protected]

Constructs a new TraceSource.

Parameters:

	pTraceTarget	the TraceTarget to which messages will be sent, or NULL to disable tracing entirely
	name	the name of this source (can be empty string for deferred init)

Definition at line 35 of file TraceSource.cpp.

References initTraceSource().

{
    initTraceSource(pTraceTargetInit,nameInit);
}

TraceSource::~TraceSource

(

)

[virtual]

Definition at line 42 of file TraceSource.cpp.

{
}

---

Member Function Documentation

void TraceSource::initTraceSource	(	SharedTraceTarget	pTraceTarget,
		std::string	name
	)			[virtual]

For use when initialization has to be deferred until after construction.

Parameters:

	pTraceTarget	the TraceTarget to which messages will be sent
	name	the name of this source

Definition at line 46 of file TraceSource.cpp.

References isTracing(), minimumLevel, name, pTraceTarget, and TRACE_OFF.

Referenced by TestBase::beforeTestCase(), TestBase::TestBase(), and TraceSource().

{
    assert(!pTraceTarget.get());

    pTraceTarget = pTraceTargetInit;
    name = nameInit;
    if (isTracing()) {
        minimumLevel = pTraceTarget->getSourceTraceLevel(name);
    } else {
        minimumLevel = TRACE_OFF;
    }
}

void TraceSource::trace	(	TraceLevel	level,
		std::string	message
	)			const

Records a trace message.

Normally only called via FENNEL_TRACE.

Parameters:

	level	severity level of event being trace
	message	the text of the message

Definition at line 61 of file TraceSource.cpp.

References getTraceTarget(), isTracing(), name, and TraceTarget::notifyTrace().

Referenced by Calculator::exec(), and ExecStreamScheduler::traceStreamBufferContents().

{
    if (isTracing()) {
        getTraceTarget().notifyTrace(name,level,message);
    }
}

bool TraceSource::isTracing

(

)

const [inline]

Returns:

true iff tracing is enabled for this source

Definition at line 88 of file TraceSource.h.

Referenced by initTraceSource(), CalcExecStream::prepare(), and trace().

    {
        return pTraceTarget.get() ? true : false;
    }

bool TraceSource::isTracingLevel

(

TraceLevel

level

)

const [inline]

Determines whether a particular level is being traced.

Parameters:

level

trace level to test

Returns:

true iff tracing is enabled for the given level

Definition at line 100 of file TraceSource.h.

Referenced by ExecStreamScheduler::addGraph(), SimpleExecStreamGovernor::assignCachePages(), SimpleExecStreamGovernor::distributeCachePages(), Calculator::exec(), ExecStreamScheduler::ExecStreamScheduler(), LcsClusterNodeWriter::getLastClusterPageForWrite(), LcsClusterNodeWriter::moveFromTempToIndex(), JavaSinkExecStream::stuffByteBuffer(), and ExecStreamScheduler::traceStreamBuffers().

    {
        return level >= minimumLevel;
    }

TraceTarget& TraceSource::getTraceTarget

(

)

const [inline]

Returns:

the TraceTarget for this source

Definition at line 108 of file TraceSource.h.

Referenced by trace().

    {
        assert(isTracing());
        return *(pTraceTarget.get());
    }

SharedTraceTarget TraceSource::getSharedTraceTarget

(

)

const [inline]

Returns:

the SharedTraceTarget for this source

Definition at line 117 of file TraceSource.h.

Referenced by Database::init(), LcsClusterAppendExecStream::initLoad(), and CalcExecStream::prepare().

    {
        return pTraceTarget;
    }

std::string TraceSource::getTraceSourceName

(

)

const [inline]

Gets the name of this source.

Useful to construct nested names for subcomponents that are also TraceSources.

Returns:

the name

Definition at line 127 of file TraceSource.h.

Referenced by LcsClusterAppendExecStream::initLoad().

    {
        return name;
    }

void TraceSource::setTraceSourceName

(

std::string const &

n

)

[inline]

Sets the name of this source.

Useful to construct dynamic names for fine-grained filtering.

Definition at line 136 of file TraceSource.h.

    {
        name = n;
    }

TraceLevel TraceSource::getMinimumTraceLevel

(

)

const [inline]

Definition at line 141 of file TraceSource.h.

    {
        return minimumLevel;
    }

void TraceSource::disableTracing

(

)

Definition at line 68 of file TraceSource.cpp.

References minimumLevel, pTraceTarget, and TRACE_OFF.

Referenced by TestBase::afterTestCase().

{
    pTraceTarget.reset();
    minimumLevel = TRACE_OFF;
}

---

Member Data Documentation

SharedTraceTarget TraceSource::pTraceTarget [private]

Definition at line 38 of file TraceSource.h.

Referenced by disableTracing(), and initTraceSource().

std::string TraceSource::name [private]

Reimplemented in ExecStream.

Definition at line 40 of file TraceSource.h.

Referenced by initTraceSource(), ExecStreamGraphEmbryo::prepareGraph(), ConfigMap::readParams(), and trace().

TraceLevel TraceSource::minimumLevel [private]

Definition at line 42 of file TraceSource.h.

Referenced by disableTracing(), initTraceSource(), and TraceSource().

---

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

• /home/pub/open/dev/fennel/common/TraceSource.h
• /home/pub/open/dev/fennel/common/TraceSource.cpp

---