lsst::pex::logging::BriefFormatter Class Reference

a formatter that renders records in a brief format for screen display. More...

#include <LogFormatter.h>

Inheritance diagram for lsst::pex::logging::BriefFormatter:

Public Member Functions
	BriefFormatter (bool verbose=false)
	BriefFormatter (const BriefFormatter &that)
virtual	~BriefFormatter ()
BriefFormatter &	operator= (const BriefFormatter &that)
bool	isVerbose ()
void	setVerbose (bool printAll)
virtual void	write (std::ostream *strm, const LogRecord &rec)
Public Member Functions inherited from lsst::pex::logging::LogFormatter
	LogFormatter ()
	LogFormatter (const LogFormatter &that)
virtual	~LogFormatter ()
LogFormatter &	operator= (const LogFormatter &that)

Private Attributes
bool	_doAll

Detailed Description

a formatter that renders records in a brief format for screen display.

This formatter has a normal mode and a verbose mode. In normal mode, only the log name (LOG) and text messages (COMMENT) are printed. In verbose mode, all other properties are printed as well.

Definition at line 114 of file LogFormatter.h.

Constructor & Destructor Documentation

lsst::pex::logging::BriefFormatter::BriefFormatter ( bool  verbose = false )

inlineexplicit

create the formatter.

Parameters

verbose

all data property values will be printed.

Definition at line 121 of file LogFormatter.h.

        : LogFormatter(), _doAll(verbose) 
    { }

lsst::pex::logging::BriefFormatter::BriefFormatter ( const BriefFormatter &  that )

inline

create a copy of a LogFormatter

Definition at line 128 of file LogFormatter.h.

        : LogFormatter(that), _doAll(that._doAll) 
    { }

virtual lsst::pex::logging::BriefFormatter::~BriefFormatter ( )

virtual

delete the formatter

Member Function Documentation

bool lsst::pex::logging::BriefFormatter::isVerbose ( )

inline

return true if all data properties will be printed or false if just the Log name ("LOG") and the text comment ("COMMENT") will be printed by default. All properties will always be printed when the LogRecord's willShowAll() returns true.

Definition at line 154 of file LogFormatter.h.

{ return _doAll; }

BriefFormatter& lsst::pex::logging::BriefFormatter::operator= ( const BriefFormatter &  that )

inline

copy another formatter into this one

Definition at line 140 of file LogFormatter.h.

                                                          { 
        if (this == &that) return *this;

        dynamic_cast<LogFormatter*>(this)->operator=(that);
        _doAll = that._doAll;
        return *this; 
    }

void lsst::pex::logging::BriefFormatter::setVerbose ( bool  printAll )

inline

set whether all data properties will be printed by default or just the Log name ("LOG") and the text comment ("COMMENT"). This will be over-ridden for any LogRecord whose willShowAll() returns true.

Parameters

printAll

true if all properties should be printed.

Definition at line 163 of file LogFormatter.h.

{ _doAll = printAll; }

virtual void lsst::pex::logging::BriefFormatter::write ( std::ostream *  strm, const LogRecord &  rec  )

virtual

write out a log record to a stream

Parameters

strm	the output stream to write the record to
rec	the record to write

Implements lsst::pex::logging::LogFormatter.

Reimplemented in lsst::pex::logging::IndentedFormatter.

Member Data Documentation

bool lsst::pex::logging::BriefFormatter::_doAll

private

Definition at line 174 of file LogFormatter.h.

---

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

• /home/lsstsw/stack/Linux64/pex_logging/11.0+1/include/lsst/pex/logging/LogFormatter.h