lsst::pex::logging Namespace Reference

Namespaces
	threshold
	version

Classes
class	BlockTimingLog
class	Component
	Create a component in the verbosity tree (deprecated). More...
class	Debug
class	DualLog
	a Log that sends message to both the screen and a file. More...
class	FileDestination
	a LogDestination represented by a file. More...
class	Log
	a place to record messages and descriptions of the state of processing. More...
class	LogRec
	A LogRecord attached to a particular Log that suppports stream stream semantics. More...
class	LogClient
	an abstract interface identifying a class that writes messages to a Log. Other classes inherit from this interface to add standard methods for setting and retrieving the log that the classs will send its log messages to. More...
class	LogClientHelper
class	LogDestination
	an encapsulation of a logging stream that will filter messages based on their volume (importance) level. More...
class	LogFormatter
	an abstract class for formatting log records into a text stream. More...
class	BriefFormatter
	a formatter that renders records in a brief format for screen display. More...
class	IndentedFormatter
class	NetLoggerFormatter
	a formatter that renders records in a netlogger-like format. More...
class	RecordProperty
	a container for a named data property for a LogRecord More...
class	Prop
class	LogRecord
	a container for constructing a single Log record More...
class	PrinterIter
	an abstract iterator class used to print out property values More...
class	BaseTmplPrinterIter
class	TmplPrinterIter
class	WrappedPrinterIter
	a wrapper PrinterIter class that hides the polymorphic (and possibly templatized) nature of an underlying PrinterIter subclass. More...
class	PrinterList
	an abstract class that encapsulates a list of property values to be printed out. More...
class	BaseTmplPrinterList
class	TmplPrinterList
class	DateTimePrinterIter
class	DateTimePrinterList
class	BoolPrinterIter
class	BoolPrinterList
class	PrinterFactory
	a factory used to create PrinterList instances to be used by a PropertyPrinter instance. More...
class	PropertyPrinter
	an class for printing the values associated with a name in a PropertySet. More...
class	ScreenLog
	a Log configured to send messages to the screen. The BriefFormatter is used to format the messages. More...
class	Trace
	limited backward compatibility to the DC2 run-time trace facilities More...

Typedefs
typedef LogRec	Rec

Functions
template<int VERBOSITY>
void	debug (const std::string &name, const std::string &message)
template<int VERBOSITY>
void	debug (const std::string &name, const char *fmt,...)
template<class T >
PrinterList *	makePrinter (const lsst::daf::base::PropertySet &prop, const std::string &name)
	the template factory function for supporting printing of printable types More...
PrinterList *	makeDateTimePrinter (const lsst::daf::base::PropertySet &prop, const std::string &name)
PrinterList *	makeBoolPrinter (const lsst::daf::base::PropertySet &prop, const std::string &name)
template<int VERBOSITY>
void	TTrace (const char *name, const char *fmt,...)
template<int VERBOSITY>
void	TTrace (const std::string name, const std::string fmt,...)

Typedef Documentation

typedef LogRec lsst::pex::logging::Rec

a shorthand version of the LogRec class

Definition at line 838 of file Log.h.

Function Documentation

template<int VERBOSITY>

void lsst::pex::logging::debug	(	const std::string &	name,
		const std::string &	message
	)

send a debug message to a named log. This message will not be printed if VERBOSITY > LSST_MAX_DEBUG. This method saves creating a log if the VERBOSITY level is too high to be printed, at the expense of re-creating everytime VERBOSITY is low.

Definition at line 186 of file Debug.h.

                                                            {
    if (LSST_MAX_DEBUG <= 0 || VERBOSITY <= LSST_MAX_DEBUG) {
        Debug(name).debug<VERBOSITY>(message);
    }
}

template<int VERBOSITY>

void lsst::pex::logging::debug	(	const std::string &	name,
		const char *	fmt,
			...
	)

send a formatted debug message to a named log. This message will not be printed if VERBOSITY > LSST_MAX_DEBUG. This method saves creating a log if the VERBOSITY level is too high to be printed, at the expense of re-creating everytime VERBOSITY is low.

Definition at line 199 of file Debug.h.

                                                        {
    if (LSST_MAX_DEBUG <= 0 || VERBOSITY <= LSST_MAX_DEBUG) {
        va_list ap;
        va_start(ap, fmt);
        Debug(name).debug(VERBOSITY, fmt, ap);
        va_end(ap);
    }
}

PrinterList* lsst::pex::logging::makeBoolPrinter	(	const lsst::daf::base::PropertySet &	prop,
		const std::string &	name
	)

PrinterList* lsst::pex::logging::makeDateTimePrinter	(	const lsst::daf::base::PropertySet &	prop,
		const std::string &	name
	)

template<class T >

PrinterList* lsst::pex::logging::makePrinter	(	const lsst::daf::base::PropertySet &	prop,
		const std::string &	name
	)

the template factory function for supporting printing of printable types

By instantiating this template, one automatically generates not only this function by also the PrinterList and PrinterIter classes it creates. This will work for types that can be printed to a stream via the output (<<) operator.

Definition at line 306 of file PropertyPrinter.h.

                                                {
    return new TmplPrinterList<T>(prop, name);
}

template<int VERBOSITY>

void lsst::pex::logging::TTrace	(	const char *	name,
		const char *	fmt,
			...
	)

Parameters

name	Name of component
fmt	Message to write as a printf format

Definition at line 193 of file Trace.h.

             {
    if (LSST_MAX_TRACE < 0 || VERBOSITY <= LSST_MAX_TRACE) {
        va_list ap;

        // first determine the length of the message
        va_start(ap, fmt);
        const int len = vsnprintf(NULL, 0, fmt, ap) + 1; // "+ 1" for the '\0'
        va_end(ap);

        char msg[len];
        va_start(ap, fmt);
        (void)vsnprintf(msg, len, fmt, ap);
        va_end(ap);

        Trace(name, VERBOSITY, msg);
    }
}

template<int VERBOSITY>

void lsst::pex::logging::TTrace	(	const std::string	name,
		const std::string	fmt,
			...
	)

Parameters

name	Name of component
fmt	Message to write as a printf form at

Definition at line 215 of file Trace.h.

             {
    if (LSST_MAX_TRACE < 0 || VERBOSITY <= LSST_MAX_TRACE) {
        va_list ap;
        va_start(ap, fmt);
        Trace(name, VERBOSITY, fmt, ap);
        va_end(ap);
    }
}