BuildContext Class Reference

Recast build context. More...

#include <SampleInterfaces.h>

Inheritance diagram for BuildContext:

Public Member Functions
	BuildContext ()
void	dumpLog (const char *format,...)
	Dumps the log to stdout.
int	getLogCount () const
	Returns number of log messages.
const char *	getLogText (int i) const
	Returns log message text.
Public Member Functions inherited from rcContext
	rcContext (bool state=true)
	Constructor.
virtual	~rcContext ()
void	enableLog (bool state)
	Enables or disables logging.
void	resetLog ()
	Clears all log entries.
void	log (const rcLogCategory category, const char *format,...)
	Logs a message.
void	enableTimer (bool state)
	Enables or disables the performance timers.
void	resetTimers ()
	Clears all performance timers. (Resets all to unused.)
void	startTimer (const rcTimerLabel label)
	Starts the specified performance timer.
void	stopTimer (const rcTimerLabel label)
	Stops the specified performance timer.
int	getAccumulatedTime (const rcTimerLabel label) const
	Returns the total accumulated time of the specified performance timer.

Protected Member Functions
void	doResetLog () override
	Clears all log entries.
void	doLog (rcLogCategory category, const char *msg, const int len) override
	Logs a message.
void	doResetTimers () override
	Clears all timers. (Resets all to unused.)
void	doStartTimer (rcTimerLabel label) override
	Starts the specified performance timer.
void	doStopTimer (rcTimerLabel label) override
	Stops the specified performance timer.
int	doGetAccumulatedTime (rcTimerLabel label) const override
	Returns the total accumulated time of the specified performance timer.

Additional Inherited Members
Protected Attributes inherited from rcContext
bool	m_logEnabled
	True if logging is enabled.
bool	m_timerEnabled
	True if the performance timers are enabled.

Description

Recast build context.

Constructor & Destructor Documentation

BuildContext()

BuildContext::BuildContext

(

)

Member Function Documentation

doGetAccumulatedTime()

int BuildContext::doGetAccumulatedTime ( rcTimerLabel  label ) const

overrideprotectedvirtual

Returns the total accumulated time of the specified performance timer.

Parameters

[in]

label

The category of the timer.

Returns

The accumulated time of the timer, or -1 if timers are disabled or the timer has never been started.

Reimplemented from rcContext.

doLog()

void BuildContext::doLog ( rcLogCategory  category, const char *  msg, const int  len  )

overrideprotectedvirtual

Logs a message.

Parameters

[in]	category	The category of the message.
[in]	msg	The formatted message.
[in]	len	The length of the formatted message.

Reimplemented from rcContext.

doResetLog()

void BuildContext::doResetLog ( )

overrideprotectedvirtual

Clears all log entries.

Reimplemented from rcContext.

doResetTimers()

void BuildContext::doResetTimers ( )

overrideprotectedvirtual

Clears all timers. (Resets all to unused.)

Reimplemented from rcContext.

doStartTimer()

void BuildContext::doStartTimer ( rcTimerLabel  label )

overrideprotectedvirtual

Starts the specified performance timer.

Parameters

[in]

label

The category of timer.

Reimplemented from rcContext.

doStopTimer()

void BuildContext::doStopTimer ( rcTimerLabel  label )

overrideprotectedvirtual

Stops the specified performance timer.

Parameters

[in]

label

The category of the timer.

Reimplemented from rcContext.

dumpLog()

void BuildContext::dumpLog	(	const char *	format,
			...
	)

Dumps the log to stdout.

getLogCount()

int BuildContext::getLogCount

(

)

const

Returns number of log messages.

getLogText()

const char * BuildContext::getLogText

(

int

i

)

const

Returns log message text.

---

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

• SampleInterfaces.h
• SampleInterfaces.cpp